diff --git a/docs/opts.md b/docs/opts.md new file mode 100644 index 0000000..1c07163 --- /dev/null +++ b/docs/opts.md @@ -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). diff --git a/website/content/docs/opts.md b/website/content/docs/opts.md deleted file mode 100644 index 1c07163..0000000 --- a/website/content/docs/opts.md +++ /dev/null @@ -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). diff --git a/website/content/docs/opts.md b/website/content/docs/opts.md new file mode 120000 index 0000000..2ed7c15 --- /dev/null +++ b/website/content/docs/opts.md @@ -0,0 +1 @@ +../../../docs/opts.md \ No newline at end of file