website: move opts to docs and symlink on website

this allows use locally (in hilbish installs)
doc-opts
sammyette 2023-04-14 01:12:06 -04:00
parent c5085da2b0
commit d8c07dd7a4
Signed by: sammyette
GPG Key ID: 904FC49417B44DCD
2 changed files with 38 additions and 37 deletions

37
docs/opts.md 100644
View File

@ -0,0 +1,37 @@
---
title: "Opts"
date: 2023-04-14T01:01:10-04:00
draft: false
---
Opts are simple settings and switches to control certain Hilbish behavior.
This ranges from things like the greeting messages on bootup to "autocd"
functionality.
They can be changed via a simple assign (like `hilbish.opts.namehere = true`).
# Available Opts
## `autocd`
The `autocd` opt (default false) makes it so that if a lone path is
ran, Hilbish will change directory to that path.
Example:
```
sammy ~ ∆ hilbish.opts.autocd = true
sammy ~ ∆ ~/Downloads
sammy ~/Downloads ∆
```
## `history`
This opt controls if Hilbish will store commands in history. It
is default true.
## `greeting`
The `greeting` is exactly as the name says: a greeting message on Hilbish
startup. It can be set to any value, and when Hilbish finishes initalizing
will print that text. The `greeting` will be passed to Lunacolors for
formatting.
## `motd`
The `motd` is a message to summarize the current running version. It can be
set as a boolean (true or false).

View File

@ -1,37 +0,0 @@
---
title: "Opts"
date: 2023-04-14T01:01:10-04:00
draft: false
---
Opts are simple settings and switches to control certain Hilbish behavior.
This ranges from things like the greeting messages on bootup to "autocd"
functionality.
They can be changed via a simple assign (like `hilbish.opts.namehere = true`).
# Available Opts
## `autocd`
The `autocd` opt (default false) makes it so that if a lone path is
ran, Hilbish will change directory to that path.
Example:
```
sammy ~ ∆ hilbish.opts.autocd = true
sammy ~ ∆ ~/Downloads
sammy ~/Downloads ∆
```
## `history`
This opt controls if Hilbish will store commands in history. It
is default true.
## `greeting`
The `greeting` is exactly as the name says: a greeting message on Hilbish
startup. It can be set to any value, and when Hilbish finishes initalizing
will print that text. The `greeting` will be passed to Lunacolors for
formatting.
## `motd`
The `motd` is a message to summarize the current running version. It can be
set as a boolean (true or false).

View File

@ -0,0 +1 @@
../../../docs/opts.md