Add "Markdown support" section to main docs #403
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
|
I'm not a writer by trade! I tried to catch typos and write something decent, but please proof read in case I missed something or you don't like my wordsmithing 😅 |
mhils
force-pushed
the
document-which-markdown
branch
from
75df6e1
to
457efb5
Compare
|
Fantastic, thanks! 😃 🍰 |
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.
Born out of #401 this adds documentation describing what Markdown spec pdoc supports, why, and what additional extras are enabled.
Screenshots for the lazy:
As for the README I'm personally torn between using a footnote or just hyperlinking
Markdownto the new doc section. I don't feel strongly one way or the other. You can see I tried a few variations in some commits. It's whatever you prefer!