This repository has been archived by the owner on Apr 10, 2024. It is now read-only.
feat: format comments as markdown for rendering #21
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
simple wordwrap in the rendering causes formatting to be broken. Add custom jinja filter `wrap_markdown` based on the `mdformat` library.
markdownify, which is used to convert html or the api-ref into the markdown defaults to escape underscores with `\_`. This is unnecessary and screwes rendered documentation. Disable it.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
simple wordwrap in the rendering causes formatting to be broken. Add
custom jinja filter
wrap_markdownbased on themdformatlibrary.