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:46] – [Convert all headings from underline style to prefix/suffix style] aneiman | evergreen-docs:dig_style_guide [2021/05/28 14:36] – aneiman | ||
---|---|---|---|
Line 9: | Line 9: | ||
==== Add a Table of Contents to the top of each AsciiDoc file ==== | ==== Add a Table of Contents to the top of each AsciiDoc file ==== | ||
- | This simply means adding this AsciiDoc line near the top of each '' | + | This simply means adding this AsciiDoc line near the top of each '' |
- | <code asciidoc>: | ||
- | ==== Use underline | + | <code asciidoc> |
+ | : | ||
+ | |||
+ | |||
+ | |||
+ | ==== Use prefix/ | ||
The basic reasons are: | The basic reasons are: | ||
Line 44: | Line 48: | ||
The above breaks down as follows: | The above breaks down as follows: | ||
- | * xref - indicates a cross reference | + | * '' |
- | * reports - indicates the folder in the docs/ | + | * '' |
- | * reporter_folder.adoc - indicates the specific file being referenced | + | * '' |
- | * reporter_creating_folders - indicates the subheading being linked to within the file | + | * '' |
- | * [Creating Folders] - the link text that is displayed | + | * '' |
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. |
<code asciidoc> | <code asciidoc> | ||
<< | << | ||
Line 181: | Line 185: | ||
* **Don' | * **Don' | ||
* **When replacing a screenshot**, | * **When replacing a screenshot**, | ||
+ | * Image syntax: '' | ||
+ | * Screen shots can be from any installation of Evergreen, as long as it does not contain any personal identifiable information, | ||
===== 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