Write HTML documents with custom tags and render them with your React components.
Renderdoc is a static document generator. It takes an input HTML document with custom tags. You provide the React components that implement the tags. The output file is the rendered HTML.
Example
As input, you need two things: an input HTML file, and a directory that contains some React components.
my-document.html
components/
Chapter.js
Header.js
Page.js
Here is your input file: my-document.html
My Life Story It was a dark and stormy night.
In the components
directory, you have these React components:
// components/Chapter.js; { return <div className="Chapter"> <h2>title</h2> children </div> ;}
// components/Header.js; { return <h1 className="Header">children</h1>;}
// components/Page.js; { return <html> <head> <meta charSet="utf-8" /> </head> <body>children</body> </html> ;}
Run renderdoc on the source file. The components
directory will be automatically used to load the components.
renderdoc my-document.html
The rendered output file:
My Life Story The Beginning It was a dark and stormy night.
Caveats
- The HTML inpujt must be well-formed XML. Every tag must be closed or self-closing.
- The tags are case sensitive (that's because they're loaded by filename from the
components
directory) - You need to supply a parent component to act as a wrapper. To render a HTML page, you probably want a component that renders a
<html>
element with the children wrapped in a<body>
- The final output will be prepended with
<!doctype html>
unless you disable this feature.