diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-03-02 08:00:33 +0000 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-03-02 08:00:33 +0000 |
| commit | 07bc0b43b021088fb3784a013b250c4127ff4e0b (patch) | |
| tree | 6f83e034b69b00af09feba553d7d3026c4dc435a /doc | |
| parent | 156642cfa47b7bf7fcf64ca3f6d86d060af4a581 (diff) | |
| parent | bfeab78ab5a0a62919ce8af0ad2f1f8a56032531 (diff) | |
| download | gitlab-ce-07bc0b43b021088fb3784a013b250c4127ff4e0b.tar.gz | |
Merge branch 'notes_guidelines' into 'master'
Change doc styleguide to use blockquotes for notes
See merge request !3009
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/development/doc_styleguide.md | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md index 96d1dffbc52..187ec9e7b75 100644 --- a/doc/development/doc_styleguide.md +++ b/doc/development/doc_styleguide.md @@ -85,9 +85,19 @@ Inside the document: ## Notes -- Notes should be in italics with the word `Note:` being bold. Use this form: - `_**Note:** This is something to note._`. If the note spans across multiple - lines it's OK to split the line. +- Notes should be quoted with the word `Note:` being bold. Use this form: + + ``` + >**Note:** + This is something to note. + ``` + + which renders to: + + >**Note:** + This is something to note. + + If the note spans across multiple lines it's OK to split the line. ## New features |