Fix Custom Rendering Markdown example #102
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
NickCrews
force-pushed
the
fix-md-docs
branch
from
ea2f9c8
to
33f45d1
Compare
This was referenced Nov 11, 2020
Closed
Move example/ into examples/simple so that we can add other examples.
This is the start of a fix for #87, where the current markdown rendering example is totally outdated. Instead of just fixing the examples embedded in the docs, I wanted to give users a fully featured example that they could run straightaway or copy adn modify. This format of examples folder could also could be used for tests, not sure yet...
See issues #87 and #91 for more context. I unified the language from `compile` to `render` because that is the term the source code and API uses for this step in the build process. I'm not sure if my definition of the rendering step is very good/complete/clear. I tweaked @PatrickMassot's example if #87: 1. Use the markdown instead of mistletoe library, I'm more familiar with it and it seems more popular? 2. Do the md->html translation in the context generator because that's simple, the point of this example was to show off the custom render function. 3. Don't use the Path library, instead just use vanilla os.path utilities, as I think they may be mofre familiar to people. 4. Don't use a jinja2 extension, that is sorta out of scope I think? I was just trying to show off custom rendering functions.
NickCrews
force-pushed
the
fix-md-docs
branch
from
33f45d1
to
07bf36e
Compare
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.
This is an attempt to fix #87 and #91
To see the new version of the documentation after this change, see https://staticjinja.readthedocs.io/en/fix-md-docs
@PatrickMassot @garyrob @jboynyc @Minkiu, you all had some interaction with those two issues, if you're interested I'd love you feedback on this.