Compare commits

..

14 Commits

Author SHA1 Message Date
TorchedSammy 9fefd7b53c
fix(website): fix footer to bottom of page 2022-06-22 17:06:44 -04:00
TorchedSammy 9a88b0c1ec
docs(website): add faq page 2022-06-22 17:04:26 -04:00
TorchedSammy 0138a30151
fix(website): use permalink for docs page instead of url 2022-06-22 16:08:37 -04:00
TorchedSammy 5a2fd055d1
fix(website): only hide x overflow 2022-06-22 15:56:55 -04:00
TorchedSammy ce13e50579
feat(website): improve doc side of website 2022-06-22 15:50:40 -04:00
TorchedSammy 2032795815
fix(website): don't center text content for main pages 2022-06-22 15:49:30 -04:00
TorchedSammy 09f5a3102e
fix(website): dont remove url on active page in navbar 2022-06-22 15:34:22 -04:00
TorchedSammy 50fbe72aa2
fix(website): page refs on navbar 2022-06-22 15:33:38 -04:00
TorchedSammy a6aa58f8fb
fix(website): block out link and highlight current page in nav bar 2022-06-22 15:18:57 -04:00
TorchedSammy 2e0eabbac7
fix(website): hide overflow 2022-06-22 13:24:41 -04:00
TorchedSammy 00c8cab8bb
fix(website): add doc layout for doc pages 2022-06-22 13:22:36 -04:00
TorchedSammy 1d7a34e0c5
fix(website): use dash to separate title and site title instead of vertical bar 2022-06-22 12:21:53 -04:00
TorchedSammy 54fc4f72ae
fix(website): clean up footer/header and make footer bg color match header 2022-06-22 11:57:32 -04:00
TorchedSammy c886a585e7
docs(website): fix typo in install steps and add docs landing 2022-06-22 10:55:08 -04:00
13 changed files with 126 additions and 64 deletions

View File

@ -7,17 +7,17 @@ theme = 'hsh'
[[menu.nav]] [[menu.nav]]
identifier = 'home' identifier = 'home'
name = 'Home' name = 'Home'
url = '/' pageref = '/'
weight = 1 weight = 1
[[menu.nav]] [[menu.nav]]
identifier = 'install' identifier = 'install'
name = 'Install' name = 'Install'
url = '/install' pageref = '/install'
weight = 2 weight = 2
[[menu.nav]] [[menu.nav]]
identifier = 'docs' identifier = 'docs'
name = 'Docs' name = 'Docs'
url = '/docs' pageref = '/docs'
weight = 3 weight = 3
[markup.goldmark.renderer] [markup.goldmark.renderer]

View File

@ -0,0 +1,7 @@
---
title: Introduction
layout: doc
weight: -1
---
Hello!

View File

@ -0,0 +1,24 @@
---
title: Frequently Asked Questions
layout: doc
weight: -20
---
# Is Hilbish POSIX compliant?
No, it is not. POSIX compliance is a non-goal. Perhaps in the future,
someone would be able to write a native plugin to support shell scripting
(which would be against it's main goal, but ....)
# Windows Support?
It compiles for Windows (CI ensures it does), but otherwise it is not
directly supported. If you'd like to improve this situation,
checkout [the discussion](https://github.com/Rosettea/Hilbish/discussions/165).
# Where is the API documentation?
The builtin `doc` command supplies all documentation of Hilbish provided
APIs. This will be on the website in the near future.
# Why?
Hilbish emerged from the desire of a Lua configured shell.
It was the initial reason that it was created, but now it's more:
to be hyper extensible, simpler and more user friendly.

View File

@ -0,0 +1,5 @@
---
title: Getting Started
layout: doc
weight: -10
---

View File

@ -11,7 +11,7 @@ For official stable releases, check out the latest [Github release.](https://git
Hilbish is packaged in a *few* repositories for some distros. Hilbish is packaged in a *few* repositories for some distros.
## Arch Linux (AUR) ## Arch Linux (AUR)
Hilbihs is on the AUR. Setup an AUR helper, and install. Hilbish is on the AUR. Setup an AUR helper, and install.
Example with yay: Example with yay:
``` ```

View File

@ -1,6 +1,6 @@
<h{{ .Level }} id="{{ .Anchor | safeURL }}"> <h{{ (add .Level 1) }} id="{{ .Anchor | safeURL }}">
{{ .Text | safeHTML }} {{ .Text | safeHTML }}
</h{{ .Level }}> </h{{ (add .Level 1) }}>
{{ if eq .Text ""}} {{ if eq .Text ""}}
<hr> <hr>
{{ end }} {{ end }}

View File

@ -1,7 +1,7 @@
<!DOCTYPE html> <!DOCTYPE html>
<html> <html>
{{- partial "head.html" . -}} {{- partial "head.html" . -}}
<body class="d-flex flex-column h-100"> <body style="overflow-x: hidden;">
{{- partial "header.html" . -}} {{- partial "header.html" . -}}
{{- block "main" . }}{{- end }} {{- block "main" . }}{{- end }}
{{- partial "footer.html" . -}} {{- partial "footer.html" . -}}

View File

@ -0,0 +1,25 @@
{{ define "main" }}
<div class="container mt-auto mt-auto py-3 row">
<div class="container" style="width: 240px;">
<div class="p-3 col">
<ul class="nav nav-pills mb-auto">
{{ $currentPage := . }}
{{ range where site.Pages.ByWeight.Reverse "Type" "docs" }}
<li class="nav-item">
<a href="{{ .Permalink }}" class="nav-link">
{{ .Title }}
</a>
</li>
{{ end }}
</ul>
</div>
</div>
<div class="col">
<div>
<h1>{{ .Title }}</h1>
{{.Content}}
</div>
</div>
</div>
{{ end }}

View File

@ -1,8 +1,7 @@
{{ define "main" }} {{ define "main" }}
<main> <main>
<div class="text-center container my-5"> <div class="container mt-2">
{{.Content}} {{.Content}}
</div> </div>
</main> </main>
{{ end }} {{ end }}

View File

@ -1,4 +1,8 @@
{{ define "main" }} {{ define "main" }}
<main>
<div class="container mt-2">
<h1>{{ .Title }}</h1> <h1>{{ .Title }}</h1>
{{.Content}} {{.Content}}
</div>
</main>
{{ end }} {{ end }}

View File

@ -1,5 +1,7 @@
<div class="container"> <footer class="footer fixed-bottom mt-auto mt-auto py-3 bg-light row">
<footer class="row py-5 my-5"> <div class="col mb-3">
</div>
<div class="col mb-3"> <div class="col mb-3">
<a href="/" class="d-flex align-items-center mb-3 link-dark text-decoration-none"> <a href="/" class="d-flex align-items-center mb-3 link-dark text-decoration-none">
<img src="/Hilbish/hilbish-flower.png" alt="" height="48" class="d-inline-block align-text-top"> <img src="/Hilbish/hilbish-flower.png" alt="" height="48" class="d-inline-block align-text-top">
@ -8,14 +10,9 @@
<p class="text-muted">Made with <i class="fa-solid fa-heart" style="color: #f6345b;"></i></p> <p class="text-muted">Made with <i class="fa-solid fa-heart" style="color: #f6345b;"></i></p>
</div> </div>
<div class="col mb-3"> <div class="col mb-3"></div>
</div> <div class="col mb-3"></div>
<div class="col mb-3"></div>
<div class="col mb-3">
</div>
<div class="col mb-3">
</div>
<div class="col mb-3"> <div class="col mb-3">
<h5>Hilbish</h5> <h5>Hilbish</h5>
@ -27,5 +24,6 @@
<li class="nav-item mb-2"><a href="#" class="nav-link p-0 text-muted">Documentation</a></li> <li class="nav-item mb-2"><a href="#" class="nav-link p-0 text-muted">Documentation</a></li>
</ul> </ul>
</div> </div>
<div class="col mb-3"></div>
</footer> </footer>
</div>

View File

@ -1,5 +1,5 @@
<head> <head>
{{ $title := print .Title " | " .Site.Title }} {{ $title := print .Title " " .Site.Title }}
{{ if .IsHome }}{{ $title = .Site.Title }}{{ end }} {{ if .IsHome }}{{ $title = .Site.Title }}{{ end }}
<title>{{ $title }}</title> <title>{{ $title }}</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>

View File

@ -1,7 +1,7 @@
<header class="site-header sticky-top py-1"> <header>
<nav class="navbar navbar-expand-lg bg-light"> <nav class="navbar navbar-expand-md sticky-top bg-light">
<div class="container-fluid"> <div class="container-fluid">
<a class="navbar-brand" href="#"> <a class="navbar-brand" href="/Hilbish">
<img src="/Hilbish/hilbish-flower.png" alt="" height="24" class="d-inline-block align-text-top"> <img src="/Hilbish/hilbish-flower.png" alt="" height="24" class="d-inline-block align-text-top">
Hilbish Hilbish
</a> </a>
@ -13,7 +13,7 @@
{{ $currentPage := . }} {{ $currentPage := . }}
{{ range .Site.Menus.nav }} {{ range .Site.Menus.nav }}
<li class="nav-item"> <li class="nav-item">
<a href="{{ .URL }}" class="nav-link {{ if $currentPage.HasMenuCurrent "nav" . }}active{{ end }}"> <a href="{{ .URL }}" class="nav-link {{ if $currentPage.IsMenuCurrent "nav" . }}active{{ end }}">
{{ .Name }} {{ .Name }}
</a> </a>
</li> </li>