ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

style guide: add backtick syntax

translation-badges
lucas schneider 2021-01-10 10:11:45 -03:00 committed by Starbeamrainbowlabs
parent 826e7c8e3c
commit e4733f650c
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
contributing-guides/style-guide.md
View File

@ -67,3 +67,18 @@ Keep the following guidelines in mind when choosing tokens:
In general, tokens should make it as intuitive as possible
to figure out how to use the command and fill it in with values.
More technical wording on description lines should use the `backtick` syntax.
Use backticks on the following:
1. Filenames, ex. `package.json`.
2. Directories, ex `/etc/ansible/hosts`.
3. Extensions, ex `.dll`.
4. Commands, ex `ls`.
5. Keyboard commands, ex. `CTRL+ALT+DEL`.
6. Port numbers, ex. `8080`.