by Lina Wolf
What is your idea about?
With the new php based rendering in place the door is open to extend the documentation rendering even more. We know that some people have a preference to use markdown to write their documentation. With this proposal we want to extend the existing support for markdown we already have full support for commonmark syntax. We want to implement this in an extendable way so we can add typo3 custom constructs or other flavor support later on. Which will not be part of this project.
What do you want to achieve by the end of Q4 2024?
When we are done all commonmark syntax will be supported by the render-guides project. Markdown documentation will be rendered the same way as we already do for ReStructuredText. Extensions may choose their preferred documentation format.
We will also have a migration tool from rst to markdown that helps Extensions migrating from Markdown to rst if they started out with Markdown but want to switch to the full feature set of reStructured Text.
What is the potential impact of your idea for the overall goal?
Extension authors used to Markdown can start using Markdown as they are used to from other tools or projects. They can then automatically switch to reStructured Text once they realize they want to use advanced features.
Which budget do you need for your idea?
5.000 Euro
Please note: After the start of the voting we can not change the idea description nor the idea outcome. If this idea is selected by the members, it must be archived as described.