docs(cli): add docs for starport tools completions cmd #1421
Conversation
ghost
requested review from
ghost
changed the title
|
CLI reference is auto-generated, so the changes you made to it will be overwritten. Here are Now that I look at the docs, I realize it would be great to remove |
docs/cli/index.md
Outdated
| 1. Source the completion script in your ~/.bashrc file: | ||
| ```bash | ||
| echo 'source <(starport tools completions bash)' >> ~/.bashrc | ||
| ``` | ||
|
|
||
| 2. Add the completion script to the /etc/bash_completion.d directory: | ||
| ``` | ||
| starport tools completions bash > /etc/bash_completion.d/starport | ||
| ``` |
There was a problem hiding this comment.
| 1. Source the completion script in your ~/.bashrc file: | |
| ```bash | |
| echo 'source <(starport tools completions bash)' >> ~/.bashrc | |
| ``` | |
| 2. Add the completion script to the /etc/bash_completion.d directory: | |
| ``` | |
| starport tools completions bash > /etc/bash_completion.d/starport | |
| ``` | |
| 1. To enable autocompletion in your current session, source the completion script in your `~/.bashrc` file: | |
| ```bash | |
| echo 'source <(starport tools completions bash)' >> ~/.bashrc | |
| ``` | |
| 1. To persist the autocompletion, add the completion script to the `/etc/bash_completion.d` directory: | |
| ``` | |
| starport tools completions bash > /etc/bash_completion.d/starport | |
| ``` | |
There was a problem hiding this comment.
because these are alternate steps (one or the other) let's use unordered list items (bullets) instead of numbered steps
tip: to "nest" the command under the action step, you can indent. I used 4 spaces here, but in Markdown you can use the tab key
There was a problem hiding this comment.
of course, now that we've provided clearer steps, we can go back to using ordered steps again.
Check your deploy preview to make sure that the nesting commands don't interfere with the autonumbering. Read all about it on StackOverflow, auto-numbering and code blocks question has been asked and answered many times
ilgooz
changed the title
* docs: Add documentation for starport tools completions command * docs: fixing the link * docs: fix the example * Updated the documentation in the good place : inside the code * Reverting mds Co-authored-by: Denis Fadeev <denis@fadeev.org>
4 participants
See the deploy preview at https://deploy-preview-1421--starport-docs.netlify.app/cli/#starport-tools-completions