This is the first revision of the RakuDoc markup language since the language was formulated to replace POD. POD was the documentation language for Perl 5.
This repository contains the most recent version of the RakuDoc v2 specification document, and some files that are intended to aid in determining compliance with the specification.
The specification is complete, but there are ideas about how to extend some parts of it.
Any change must be backwards compatible.
It is intended that there should be multiple renderers from RakuDoc into other output formats, and based on other languages.
A renderer is considered compliant if it can render into a chosen output format the file Rakudociem-ipsum.rakudoc. rakudociem-ipsum.rakudoc contains RakuDoc errors and the specification gives some recommendations about errors. So a compliant renderer should generate the expected warnings, though the way the warnings are handled is not defined. Some of the links in rakudociem-ipsum.rakudoc are to files in the compliance-files/ directory.
Currently, RakuAST::RakuDoc::Render is the most complete renderer, and the distribution contains renderers to Text, HTML and Markdown.
Rendered from ./README.rakudoc at 08:56 UTC on 2024-07-13
Source last modified at 08:55 UTC on 2024-07-13