Add summary of supported markdown syntax #17644
Merged
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
Outline all the syntax that Julia's markdown parser currently supports and provide examples of each. This should not be considered a complete markdown tutorial, but just a summary and style guide for Julia's flavour of markdown.
MichaelHatherly
added
the
domain:docs
|
|
||
| .. note:: | ||
|
|
||
| No checks are done during parsing to make sure that all footnote references have matching footnotes. |
There was a problem hiding this comment.
this should probably be added as a check in Documenter or other doc renderers then??
There was a problem hiding this comment.
Yes, there's a "linting" stage in Documenter that this could slot into quite nicely I think.
|
OSX failure is unrelated, will merge later this evening. |
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.
As promised in #17632 (comment), any suggestions for better wording are most welcome.
This outlines all the syntax that Julia's markdown parser currently supports and provides examples of each. This should not be considered a complete markdown tutorial, but just a summary and style guide for Julia's flavour of markdown.