Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 1.18 KB

README.md

File metadata and controls

51 lines (38 loc) · 1.18 KB
Raw

Markdown Notes

A React.js web application for creating, editing, and organizing notes in Markdown.

Markdown Notes GIF 1 Markdown Notes GIF 2

Features

  • Material Design UI
  • Live editor previews
  • Dynamic Latex rendering
  • Autosave
  • Customization
  • Export to PDF

Usage

Before you start, run:

yarn run build:prod

Then run:

yarn run start

And your Markdown notes server will be ready to use at port 5000. The actual files, and file index will be saved to a directory called user-data. Exported PDFs are saved in a temp directory called temp.

Testing/Dev

Uses webpack, babel to transpile the JSX to regular JavaScript, webpack-dev-server and nodemon for automatic reloading of client and server. In the terminal, run:

yarn run dev