The parser-enhancements directory is intended for use augmenting data before being parsed.
It is the second stage of the transformation from a document type (e.g. Textile) to a documentation page.
- Pre-parser - transforms plain text to plain text ready to be parsed.
- Post-parser - transforms data after it has been parsed by a dedicated parser such as
textile-js. - HTML Parser - for HTML manipulations that are too complex for string manipulation or the front-end.
- Component mapping - maps
{ data, type }objects to React components based ontype. - React components - standardise the behaviour, presentation, layout and markup semantics of
datafrom{ data, type }objects.
It is a good place to put:
- Augmentations based on article meta-data such as document
path,frontmatterattributes - Augmentations based on application meta-data/config such as
.yamlfiles
It is not the best place to put:
- Transformations designed to fix issues or make the text easier to understand; put these in pre- or post-parser
- Alterations to presentation and design - put these in component mapping or React components