1.6.3

What's Changed

We resolved an issue in the interlink json, which didn't include the full permalink to the articles. And added support for tables in our ReStructedText theme. All features of commonmark are now covered an should give our users the ability to render there documentation in RST format.

• [1.x] Merge pull request #1175 from phpDocumentor/bugfix/interlink-prefix by @phpdoc-bot in #1181
• [1.x] Merge pull request #1179 from phpDocumentor/feature/tables-to-rst by @phpdoc-bot in #1182

Full Changelog: 1.6.2...1.6.3

1.6.2

What's Changed

This version includes a bugfix regarding list items in markdown based documentation. Before we did produce a paragraph node inside the list item. Now we do flatten this when the list item contains just 1 single paragraph. This prevents issues in rendering lists, but also makes is more compliant with the ReStructuredText based documentation.

Full Changelog: 1.6.1...1.6.2

1.6.1

Bugfix release to resolve an issue with combined inline text styling.

• [1.x] Merge pull request #1162 from phpDocumentor/nested-inline-nodes by @phpdoc-bot in #1163

Full Changelog: 1.6.0...1.7.0

1.6.0

What's Changed

Migration Markdown to RST

This version contains a new theme that will allow documentation writers to migrate from markdown to RestructuredText by rendering their docs using guides. We hope that this will make it easier to help people getting started with ReStructuredText documentation, when the need is there.

Post parse transformations

In order to make it possible to change the output of a parsed document we do now allow changes on the document via event listeners. This will allow you to do some simple changes to the document before it's compiled. To add some extra static metadata that is not part of the file for example.

• [1.x] Merge pull request #1146 from phpDocumentor/feature/post-parse-mutable by @phpdoc-bot in #1147
• [1.x] Merge pull request #1058 from phpDocumentor/task/rst-theme by @phpdoc-bot in #1152

Full Changelog: 1.5.0...1.6.0

1.5.0

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

1.4.1

What's Changed

Add support for ** in menu and toctree directives. This will do a deep search for all documents in a documentation including / where * will only include the current level.

• [1.x] Merge pull request #1081 from phpDocumentor/fix/deep-glob by @jaapio in #1082

Full Changelog: 1.4.0...1.4.1

1.4.0

What's Changed

The menu directive now has support for section titles of all levels, this could be seen as a bugfix or breaking change as the end result is changing. But we thing this is a welcome addition to the way the menu directive works and makes it equal to the toctree behavior.

• [1.x] Merge pull request #1079 from phpDocumentor/feature/menu-subtitles by @jaapio in #1080

Full Changelog: 1.3.10...1.4.0

1.3.10

What's Changed

• [1.x] Fix invalid url parsing by @phpdoc-bot in #1062
• [1.x] Merge pull request #958 from phpDocumentor/task/complex-grid-table by @phpdoc-bot in #1064
• [1.x] Merge pull request #1065 from phpDocumentor/fix/955-table-content by @phpdoc-bot in #1066
• [BUGFIX] Allow escaped version by @jaapio in #1069

Full Changelog: 1.3.9...1.3.10

1.3.9

What's Changed

• [1.x] [FEATURE] Link to phpdomain API by @phpdoc-bot in #1055

Full Changelog: 1.3.8...1.3.9

1.3.8

What's Changed

• [1.x] [BUGFIX] Fix confval required | [TASK] Add tests and make them work by @phpdoc-bot in #1030

Full Changelog: 1.3.6...1.3.8