1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/hacking/templates
Dale Sedivec 7681b1ce68 Improve Markdown (and other) module doc output
- The html_ify filter now escapes HTML found in module documentation.
  THIS COULD AFFECT MORE THAN JUST MARKDOWN but I didn't see any modules
  expecting to use e.g. HTML entities or HTML tags in their
  documentation.

- The markdown_ify filter (used as jpfunc in markdown.j2) escapes at
  least a few Markdown in-line formatting characters.

- Improvements to markdown.j2:

    - Call jpfunc on the module name heading so that it gets escaped for
      Markdown (e.g. my_module_name becomes my\_module\_name).

    - Added paragraph breaks between paragraphs in the description.

    - Added examples heading, which is consistent with the notes heading
      below it.
2013-06-14 13:27:59 -05:00
..
html.j2 module_formatter in hacking/ 2012-09-26 20:41:44 +02:00
js.j2 Unified document generator and make to generate JSON and JS files 2012-10-10 18:41:50 -04:00
latex.j2 DOCUMENTATION: LaTeX template is back 2012-10-24 19:42:52 +02:00
man.j2 Add support for additional EXAMPLES string in Ansible modules 2013-02-18 20:02:46 +01:00
markdown.j2 Improve Markdown (and other) module doc output 2013-06-14 13:27:59 -05:00
rst.j2 Show 'yes' and 'no' in choices on docs page. 2013-06-01 12:33:11 -04:00