mdBook 0.5.4 fixed documentation, MPL-2.0. Original chapter · Original Markdown · Editable Libx document · Complete fixed upstream source. · Editable source and build context.
"}, {"kind": "editorial", "html": "Static Libx presentation: examples show their complete code, including lines hidden in the original demo. Editing, code execution and MathJax rendering are provided by the original project; formula examples retain their original TeX notation here. The document text and expanded examples are retained. This is an unofficial Libx static edition. Original text and examples are preserved; translated pages are identified separately.
"}] prev: {"text": "clean", "link": "/v0-5-4/en/01-guide/04-cli-clean"} next: {"text": "Format", "link": "/v0-5-4/en/01-guide/14-format-index"} ---The completions command is used to generate auto-completions for some common shells.
This means when you type mdbook in your shell, you can then press your shell’s auto-complete key (usually the Tab key) and it may display what the valid options are, or finish partial input.
The completions first need to be installed for your shell:
# bash
mdbook completions bash > ~/.local/share/bash-completion/completions/mdbook
# oh-my-zsh
mdbook completions zsh > ~/.oh-my-zsh/completions/_mdbook
autoload -U compinit && compinit
The command prints a completion script for the given shell.
Run mdbook completions --help for a list of supported shells.
Where to place the completions depend on which shell you are using and your operating system. Consult your shell’s documentation for more information one where to place the script.