markdown-reason-react

markdown-reason-react copied to clipboard

The goal of this library is to create a CLI that will take a directory of markdown files and then spit out those same markdown files as reason-react pages. This library is a work in progress, but is actively being worked on.

Optionally if you're just making a completely static site you can have a directory of just markdown files and nothing else and pass a --static that will generate a SPA.

Remaining Alpha Functionality to Implement

• [x] Parse top level elements
• [ ] Parse inline/nested elements
• [x] Generate AST
• [x] Codegen top level elements
• [ ] Codegen inline elements
• [x] Refmt generated code
• [ ] Highlight Code Blocks
• [ ] Interpolate ReasonReact components in markdown

Future work after Alpha

• [ ] Markdown Linting with fantastic error messages
• [ ] Implement --static
• [ ] Markdown -> plain html (only requires a different codegen, this is simple)
• [ ] Markdown -> react.js (only requires a different codegen, this is simple)

                                 MARKDOWN-TO-REASON-REACT



SYNOPSIS
       markdown-to-reason-react [OPTION]... DIRECTORY

DESCRIPTION
       markdown-to-reason-react takes a directory of markdown files
       and returns a directory of reason-react pages

ARGUMENTS
       DIRECTORY
           input directories

OPTIONS
       -static
           It will generate a single page application from the directory of
           markdown pages