From fbfd2e2546367f3d791ff7de4496cfb26fa2edeb Mon Sep 17 00:00:00 2001 From: decentral1se Date: Thu, 21 Oct 2021 20:31:59 +0200 Subject: [PATCH] Add abra docs --- docs/abra.md | 34 ++++++++++++++++++++++++++++++++++ mkdocs.yml | 5 +++-- 2 files changed, 37 insertions(+), 2 deletions(-) create mode 100644 docs/abra.md diff --git a/docs/abra.md b/docs/abra.md new file mode 100644 index 0000000..2a13fdd --- /dev/null +++ b/docs/abra.md @@ -0,0 +1,34 @@ +--- +title: Abra +--- + +## Enable auto-completion + +### Bash + +Copy `scripts/autocomplete/bash` into `/etc/bash_completion.d/` and rename +it to abra. + +``` +sudo cp scripts/autocomplete/bash /etc/bash_completion.d/abra +source /etc/bash_completion.d/abra +``` + +In development, you can source the script in your git checkout, just make sure +to set `PROG=abra`, otherwise it'll add completion to the wrong command: + +``` +PROG=abra source /path/to/abra/scripts/autocomplete/bash +``` + +### (Fi)Zsh + +(fi)zsh doesn't have an autocompletion folder by default but you can create one, then copy `scripts/autocomplete/zsh` into it and add a couple lines to your `~/.zshrc` or `~/.fizsh/.fizshrc` + +``` +sudo mkdir /etc/zsh/completion.d/ +sudo cp scripts/autocomplete/zsh /etc/zsh/completion.d/abra +echo "PROG=abra\n_CLI_ZSH_AUTOCOMPLETE_HACK=1\nsource /etc/zsh/completion.d/abra" >> ~/.zshrc +``` + +(replace .zshrc with ~/.fizsh/.fizshrc if you use fizsh) diff --git a/mkdocs.yml b/mkdocs.yml index 1c9152f..c2d2a5e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,7 +14,7 @@ theme: logo: img/favicon.ico favicon: img/favicon.ico -copyright: Copyleft 🄯 2021 The Co-operative Cloud +copyright: Copyleft 🄯 2021 Co-op Cloud markdown_extensions: - meta @@ -33,13 +33,14 @@ markdown_extensions: emoji_generator: !!python/name:materialx.emoji.to_svg nav: - - "A co-operative alternative 🥳": index.md + - "Introduction": index.md - Getting started guide: - Architecture overview: overview.md - Deploy your first app: deploy.md - App catalogue: apps.md - App config guide: app-config-guide.md - Recipe maintainer guide: recipe-maintainer-guide.md + - Abra guide: abra.md - Frequently asked questions: faq.md - Contributing guide: contribute.md - Community organising: comm-org.md