Skip to content

1.5.0
Compare
Choose a tag to compare
@jaapio jaapio released this 12 Oct 19:45
1.5.0
8409e2e
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

What's Changed

This release is focused on improved markdown support. We did a lot of changes in the markdown package to improve the support of markdown documents. This is part of a larger effort to make this package fully compatible with commonmark.

Following markdown features are now supported:

  • Headings
  • Paragraphs
  • Blockquotes & Codeblocks
  • Tables
  • Images
  • Inline link detection
  • Inline html
  • Admonitions github style

Sanitize HTML

The raw node that we supported in previous releases allows you now to sanitize the html to prevent XSS attacks. By default we allow all safe tags in body elements. unsafe attributes like style and javascript are removed. It's also possible to define your own sanitizer by configuring the allowed and blocked tags. The documentation will be updated to help our users to configure their documentation.

Auto menu

A new feature added in this version is auto generated menus. As markdown doesn't have a way to define menus we added a system to generate the menus automatically. The order of files are used to define the order of the menu items and headings are used to determine the menu title of each file. We do include all headers by default.

If you enable the auto menu option using ReStructuredText we will generate warnings when toctree directive is used. In this case the toctree directives are converted to menu directives and pages are not reordered.

Full Changelog: 1.4.1...1.5.0

Assets 2
Loading