Update the styleguide #2332
Merged
Update the styleguide #2332
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Merged
Also normalize admonition titles with the colon outside the bold.
test.md
Outdated
| @@ -43,6 +48,10 @@ Some Lorem ipsum text with formatting and styling. | |||
|
|
|||
| ### Heading 3 | |||
|
|
|||
| > **Note**: This is the lowest heading included in the right-nav. | |||
There was a problem hiding this comment.
I would add "by default" at the end of this sentence.
test.md
Outdated
| @@ -43,6 +48,10 @@ Some Lorem ipsum text with formatting and styling. | |||
|
|
|||
| ### Heading 3 | |||
|
|
|||
| > **Note**: This is the lowest heading included in the right-nav. | |||
| > To include more heading levels, set `toc_max: 4` in the page-s front-matter. | |||
|
Added a couple comments, but other than those nits, this LGTM. Long-live FAR! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also normalize admonition titles with the colon outside the bold, add some info about
toc_maxandtoc_min, and add some examples of more complex notes.