Generic Markdown Reader

A fast and lightweight Markdown reader made in Vue and Typescript.

Current plans

• Parse basic Markdown
• Edit Markdown
• Open text and Markdown files
• Save files as txt, md, or html
• Parse CommonMark + Task lists
• Basic insert toolbar

Building from source

1. Clone this repo. Usually with git clone https://github.com/njshockey/generic-markdown-reader.git.
2. Open the directory in your terminal or console and install the necessary npm packages with npm install.
3. To run the development server to test changes, run npm run serve and to build the production version, run npm run build. Built files will be in the dist folder.

Special Thanks

Special thanks goes to the developers and contributors of markdown-it, Vue, and Bootstrap. Without them, the making of Generic Markdown Reader would have been infinitely harder!