RakuAST::RakuDoc::Render

Documentation for all the modules in this distribution

The RakuAST::RakuDoc::Render distribution contains a number of modules, each of which has been documented. They can be grouped as follows:

Sources containing key concepts and information

Minimal documentation of RakuDoc::Render Module Overview of rendering engine.
ProcessState and RakuDoc::Processed Collecting data to be used for rendering
PromiseStrings for templates How RakuAsT-RakuDoc-Render handles forward references or placement material that has not yet been rendered.
RakuDoc renderer Renders RakuDoc sources into an output format dependent on templates
Templates for RakuDoc-Render Snippets to customise RakuDoc blocks
The ScopeData module Handling RakuDoc v2 block scope concept.

Descriptions of the Renderer classes

Rendering RakuDoc v2 to HTML

RakuDoc v2 is rendered to minimal HTML. RakuAST::RakuDoc::Render on which this module is based uses the RakuAST parser. A rendering of the compliance document can be found online.

Rendering RakuDoc v2 to MarkDown Simple and customisable module for rendering RakuDoc v2 to Markdown.
The RakuDoc to HTML-Extra renderer Based on RakuAST-RakuDoc-Render engine, HTML with plugins and Bulma CSS

Classes that add templates and data to HTML-Extra

Bulma CSS Use the Bulma CSS framework for styling HTML output. This file only describes utilisation.
FontAwesome

Adds the fonts and utilities for FontAwesom v5.15.4. Includes ℱ<> markup code.

GraphViz RakuDoc::Plugin::Graphviz
Grouping files in an index The plugin takes data collected from other Rakudoc files, selects them according to criteria, and outputs the filename and descriptions.
Hilite plugin Using highlight-js and Deparse-syntax highlighter to highlight Raku
LatexFormula Using CodeCogs editor to process Latex formula markup
LeafletMap

The leafletmap plugin inserts a map in place of a custom =LeafletMap.

SCSS Creates CSS output and adds to Processor object from SCSS in other plugins

Small modules with much going on

MarkUpMeta module Short grammar
Numeration module Creating standard numeration

File from other sources or automatically generated

Templates in default-text-templates

Auto generated from lib/RakuDoc/Render.rakumod

Proving a renderer A file with many RakuDoc components and some idea about what is expected.
Raku by example 101 A basic introductory example of a Raku program
RakuDoc A Raku slang for documenting Raku software to aid development and use.

Credits§

Richard Hainsworth aka finanalyst

VERSION§