OctoMark

A CommonMark and GitHub-Flavored Markdown editor.

Dependencies

This app was made possible with:

• Next.js
• Material UI
• TypeScript
• Jest
• react-markdown
• remark-gemoji
• remark-gfm
• remark-github
• remark-github-blockquote-alert
• remark-remove-comments

Starting a local development environment

1. Make sure you have the latest version of Node.js
2. Clone this repository into a directory of your choosing.
3. With a command line interface, e.g.: Windows Powershell, cd into the repository you just cloned.
4. Still in the command line, run the following commands: npm install to install all the necessary dependencies and npm run dev to start a local development environment.
5. Finally, open you web browser in the address http://localhost:3000.