ToryMD is a simple web-based markdown parser that converts markdown to HTML and displays the result. It is built completely from scratch without using any external packages to handle any of the logic of parsing through the markdown input.
The compiler makes use of concepts that I've learned. It works in 3 stages: a scanning stage, a parsing stage, and a code generation/conversion into html stage.
- It first scans the input markdown and converts it into tokens (doing some basic checks in the process).
- It then parses the tokens into a valid syntax tree for markdown (doing the remaining validity checks in the process).
- It then converts the tokens into html.
- Clone the repository.
- Run
npm installto install the dependencies for the project. - To build the project based on the dev environment run
npm run build. - Go to http://localhost:3000/ to view the project.
I am still updating this project and plan to add support for additional features that make the whole editing experience nicer and provide support for additional markdown features that are not already supported.
The following are potential features I plan to support.
- Option to view the raw HTML generated.
- Option to change the theme of the editor.
- Support for aliasing links in markdown.
- Support for downloading the output as a PDF.
- Build custom editor component with line numbers.