evergreen-docs:dig_style_guide
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
evergreen-docs:dig_style_guide [2020/10/27 10:49] – [Changes to cross-reference structure] aneiman | evergreen-docs:dig_style_guide [2021/03/23 12:05] – [Use underline style headings instead of prefix/suffix style] aneiman | ||
---|---|---|---|
Line 13: | Line 13: | ||
<code asciidoc>: | <code asciidoc>: | ||
- | ==== Use underline | + | ==== Use prefix/ |
The basic reasons are: | The basic reasons are: | ||
Line 52: | Line 52: | ||
For historical purposes, the old xref syntax is below | For historical purposes, the old xref syntax is below | ||
- | **DO NOT USE THIS!** | + | The below is an example of the now-deprecated cross reference style. **DO NOT USE THIS!** |
<code asciidoc> | <code asciidoc> | ||
<< | << | ||
Line 181: | Line 181: | ||
* **Don' | * **Don' | ||
* **When replacing a screenshot**, | * **When replacing a screenshot**, | ||
+ | * Image syntax: '' | ||
===== Common Mistakes ===== | ===== Common Mistakes ===== | ||
* AsciiDoc lists (numbered or bulleted) need to be preceded by a blank line. If not, they will be absorbed into the previous paragraph of text, like this: | * AsciiDoc lists (numbered or bulleted) need to be preceded by a blank line. If not, they will be absorbed into the previous paragraph of text, like this: | ||
* '' | * '' | ||
- | * Callouts should be formatted as ''< | + | * Callouts should be formatted as ''< |
* Images, text blocks, or code blocks that are part of a numbered lists need to have a '' | * Images, text blocks, or code blocks that are part of a numbered lists need to have a '' | ||
evergreen-docs/dig_style_guide.txt · Last modified: 2023/06/01 12:22 by gmcharlton