diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml index dd71799..6ee4349 100644 --- a/.github/workflows/website.yml +++ b/.github/workflows/website.yml @@ -19,13 +19,17 @@ jobs: hugo-version: 'latest' extended: true - - name: Build - run: 'cd website && hugo --minify' - - name: Set branch name id: branch run: echo "::set-output name=BRANCH_NAME::${GITHUB_REF##*/}" + - name: Fix base URL + if: steps.branch.outputs.BRANCH_NAME != 'master' && github.repository_owner == 'Rosettea' + run: sed -i "s%baseURL = 'https://rosettea.github.io/Hilbish/'%baseURL = 'https://rosettea.github.io/Hilbish/versions/${{ steps.branch.outputs.BRANCH_NAME }}'%" website/config.toml + + - name: Build + run: 'cd website && hugo --minify' + - name: Deploy if: steps.branch.outputs.BRANCH_NAME == 'master' && github.repository_owner == 'Rosettea' uses: peaceiris/actions-gh-pages@v3 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 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