@publicodes/react-ui

API / @publicodes/react-ui

This package exports React components to display a publicodes explanation page and rule links. It requires the publicodes core package to be installed.

Getting started

npm install publicodes publicodes-react

Then follow the tutorial to create a simple page.

You can also jump to a specific guide for your framework:

Next.js
Svelte
Other example (on Github)

Functions

Function	Description
getDocumentationSiteMap	Get all the URLs of the documentation pages and their corresponding rule names.

Components

Function	Description
Explanation	Display the documentation of a parsed publicodes AST node
RuleLink	Create a link to a rule in the documentation.
RulePage	Display the documentation page of a given rule

Type Aliases

Type alias	Description
SupportedRenderers	The custom renderers for the markdown content.