Commit 83e64e49 authored by Evan Read's avatar Evan Read Committed by Achilleas Pipinellis

Add placeholder text guidance

parent b0759564
...@@ -253,13 +253,13 @@ table_display_block: true ...@@ -253,13 +253,13 @@ table_display_block: true
--- ---
``` ```
## Emphasis ### Emphasis
- Use double asterisks (`**`) to mark a word or text in bold (`**bold**`). - Use double asterisks (`**`) to mark a word or text in bold (`**bold**`).
- Use underscore (`_`) for text in italics (`_italic_`). - Use underscore (`_`) for text in italics (`_italic_`).
- Use greater than (`>`) for blockquotes. - Use greater than (`>`) for blockquotes.
## Punctuation ### Punctuation
Check the general punctuation rules for the GitLab documentation on the table below. Check the general punctuation rules for the GitLab documentation on the table below.
Check specific punctuation rules for [lists](#lists) below. Check specific punctuation rules for [lists](#lists) below.
...@@ -274,6 +274,20 @@ Check specific punctuation rules for [lists](#lists) below. ...@@ -274,6 +274,20 @@ Check specific punctuation rules for [lists](#lists) below.
| Always add a space before and after dashes when using it in a sentence (for replacing a comma, for example). | _You should try this - or not._ | | Always add a space before and after dashes when using it in a sentence (for replacing a comma, for example). | _You should try this - or not._ |
| Always use lowercase after a colon. | _Related Issues: a way to create a relationship between issues._ | | Always use lowercase after a colon. | _Related Issues: a way to create a relationship between issues._ |
### Placeholder text
Often in examples, a writer will provide a command or configuration that is complete apart from
a value specific to the reader.
In these cases, use [`<` and `>`](https://en.wikipedia.org/wiki/Usage_message#Pattern) to call out
where a reader must replace text with their own value.
For example:
```sh
cp <your_source_directory> <your_destination_directory>
```
## Lists ## Lists
- Always start list items with a capital letter, unless they are parameters or commands - Always start list items with a capital letter, unless they are parameters or commands
......
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