Skip to content

Conversation

@alishamayor
Copy link
Contributor

@alishamayor alishamayor commented Apr 3, 2020

  • Fixed most of the broken formatting on GitHub Pages
  • Docs should now render correctly on both GitHub and GitHub Pages
  • Also did a mass spellcheck

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:

<!-- {% raw %} -->
...
<!-- {% endraw %} -->

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. 🚀

@alishamayor
Copy link
Contributor Author

Using admin privilege to merge 🤓

@alishamayor alishamayor merged commit ab3cf94 into develop Apr 3, 2020
@alishamayor alishamayor deleted the docs/fix-jekyll-formatting branch April 3, 2020 17:26
alishamayor added a commit to splunk/splunk-ansible that referenced this pull request Apr 15, 2020
* Updating changelog to republish 8.0.3 + misc edits

* Applied formatting fixes from splunk/docker-splunk#350
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Formatting problem in documentation

1 participant