https://github.com/raku/rakudoc-gamma
Community review of the RakuDoc standard
https://github.com/raku/rakudoc-gamma
Last synced: 3 months ago
JSON representation
Community review of the RakuDoc standard
- Host: GitHub
- URL: https://github.com/raku/rakudoc-gamma
- Owner: Raku
- License: artistic-2.0
- Created: 2023-07-28T11:59:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-15T10:52:17.000Z (4 months ago)
- Last Synced: 2025-01-29T11:22:09.229Z (4 months ago)
- Language: HTML
- Size: 681 KB
- Stars: 2
- Watchers: 11
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RakuDoc Version 2
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.
----
## Table of Contents
Overview
Renderers
----
## Overview
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.
----
## Renderers
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](compliance-files/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](https://github.com/finanalyst/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