Skip to content

✍️ A minimal WYSIWYG Editor. Write markdown notes that get turned into HTML in place.

Notifications You must be signed in to change notification settings

amelieoller/markdown-notes

Repository files navigation

Markdown Notes

Markdown Notes is an application that helps you keep all your notes in one place. You can write notes in markdown which gets turned into HTML so you can see your notes transform in real time.

Motivation

I had always wanted to create my own markdown editor to keep track of my notes. Since I found remirror, it has made the journey easier than ever. In addition to the notes section, I also added a lecture section that will allow you to create lectures from your existing notes (I was teaching programming at the time I built this).

Screenshots

Walkthrough

Tech/Framework Used

Features

  • Write markdown notes in realtime
  • Link notes together
  • Assemble lectures from notes
  • Tag notes
  • Search and filter notes

Installation

  1. Clone the project
  2. Run yarn or npm install (this will install all the dependencies)
  3. Run yarn start or npm start (this will start a new server and run the application on localhost:3000)

How to use?

If you would like to demo the finished project, you can do that here: https://markdown-notes.com. If you prefer running the project locally you can achieve that with the instructions in the Installation section.

Contribute

Feel free to dive in! Open an issue or submit PRs.

Standard Readme follows the Contributor Covenant Code of Conduct.

License

MIT © Amelie Oller

About

✍️ A minimal WYSIWYG Editor. Write markdown notes that get turned into HTML in place.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published