Skip to content

G
gitlab-ce
Commit c962319c authored by Suzanne Selhorn's avatar Suzanne Selhorn Committed by Craig Norris
Browse files
Options

Docs style: How to format keystrokes 

Related to: https://gitlab.com/gitlab-org/gitlab/-/issues/241769
parent 006d8cd3
Hide whitespace changes
Inline Side-by-side
Showing with 12 additions and 0 deletions
doc/development/documentation/styleguide.md
View file @ c962319c
...@@ -626,6 +626,18 @@ For example: ...@@ -626,6 +626,18 @@ For example:
cp <your_source_directory> <your_destination_directory> cp <your_source_directory> <your_destination_directory>
``` ```
### Keyboard commands
Use the HTML `<kbd>` tag when referring to keystroke presses. For example:
```plaintext
To stop the command, press <kbd>Ctrl</kbd>+<kbd>C</kbd>.
```
When the docs are generated, the output is:
To stop the command, press <kbd>Ctrl</kbd>+<kbd>C</kbd>.
## Lists ## Lists
- Always start list items with a capital letter, unless they are parameters or - Always start list items with a capital letter, unless they are parameters or
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7