Docs - Reconcile Jekyll, Kramdown, GFM formatting #350
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.
Notes
Our documentation lives on a GitHub Pages site, which is generated using Jekyll. Jekyll uses the Liquid templating language to process templates, and Liquid objects and variables are denoted by double curly braces: {{ }}.
Therefore, any fenced code blocks containing Ansible expressions or other phrases in {{ curly braces }} need to be wrapped with these escape tags to avoid being parsed as Liquid template tags:
Including them as HTML-style comments ensures they don't appear on the Markdown page either.
See ARCHITECTURE.md#L36 for an example.
Jekyll also uses Kramdown to render Markdown, which is just different enough from GitHub-flavored Markdown. 🙃 There's updated HTML creating the show/hide disclosures in EXAMPLES.md, which now render code blocks and syntax-highlighting. Also,
<and>need to be escaped inside the HTML blocks, which fixes #314.I tried to minimize the complexity. As long as future content follows the same inline HTML formatting scheme, we're golden. 🚀