evergreen-docs:dig_style_guide
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revision | Next revisionBoth sides next revision | ||
| evergreen-docs:dig_style_guide [2018/07/09 08:37] – [Linking] rjs7 | evergreen-docs:dig_style_guide [2019/03/07 08:54] – [Headers] rjs7 | ||
|---|---|---|---|
| Line 11: | Line 11: | ||
| * Headers should be in title case (i.e. capitalize important words) | * Headers should be in title case (i.e. capitalize important words) | ||
| * Headers can be formatted in either of two ways, but a single AsciiDoc file should use the same style consistently. | * Headers can be formatted in either of two ways, but a single AsciiDoc file should use the same style consistently. | ||
| + | |||
| + | === Changing A Section Heading === | ||
| + | To prevent breaking internal links: | ||
| + | - Any time we edit a section heading (even fixing a typo), first check the HTML of the docs for the autogenerated anchor name. (This will be in an <a id=""> | ||
| + | - Search the docs code for that exact anchor name to find any references. (These will look like "<< | ||
| + | - Update the section heading and any references you found (it's okay to guess at the new anchor name; the docs committer can double-check this after it's published). | ||
| + | - NOTE: This may change the docs page URL, which would break external links and bookmarks. To prevent this, ask the DIG email list how they handle redirecting pages that move. | ||
| **Header Prefix Syntax** | **Header Prefix Syntax** | ||
| Line 31: | Line 38: | ||
| ++++++++++++++ | ++++++++++++++ | ||
| </ | </ | ||
| + | |||
| ==== Other Formatting ==== | ==== Other Formatting ==== | ||
evergreen-docs/dig_style_guide.txt · Last modified: 2023/06/01 12:22 by gmcharlton