remarked

Remarked

In-browser markdown editor.

View Demo
·
Report Bug
·
Request Feature

Table of Contents

What is markdown?
About The Project
- Built With
Roadmap
Contributing
License
Contact

What is markdown?

Markdown is a lightweight markup language for creating formatted text using a plain-text editor. Created by John Gruber in 2004, Markdown is now one of the world’s most popular markup languages. While most prefer to use it in collaborative software, documentation pages, and readme files, others prefer it purely for the writing experience it offers.

Using Markdown is different than using a WYSIWYG editor. In an application like Microsoft Word, you click buttons to format words and phrases, and the changes are visible immediately. Markdown isn’t like that. When you create a Markdown-formatted file, you add Markdown syntax to the text to indicate which words and phrases should look different.

For example, to denote a heading, you add a number sign before it (e.g., # Heading One) It may take a while to get used to seeing Markdown syntax in your text, and that is why tools like this project can help users by blending the writing experiences of pure markdown and common WYSIWYG apps together.

To learn how to write markdown I suggest reading the standard, unambiguous syntax specification CommonMark. Another great resource is this basic syntax guide, with a list of all markdown’s most used features.

(back to top)

About The Project

This projects aims to create a web editor for markdown with an easy to use interface that helps the user write faster. The app has local storage support to save all the documents, as well as features to download the documents in .md, .txt and .pdf file formats.

This app provides a toolbar with common WYSIWYG tools, and helps visualizing the output of what the user is writing by showing a live preview. The website shows the optimal layout for the app depending on the device’s screen size.

Eventually I would like to turn this project into a full-stack web app (maybe with firebase?) that supports user registration and login to be able to sync your files on multiple devices. I would also like to write my own markdown interpreter instead of using the React-mde package.

(back to top)

Built With

(back to top)

Roadmap

App routing with placeholder pages
Main app interface mockup (responsive)
Side navbar
Local storage sync tools
Markdown text editor and live preview
Document save in localStorage
Toolbar layout (responsive)
Toolbar functionalities
Export of documents in supported file formats

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, you can simply open an issue with the tag “enhancement”. Don’t forget to give the project a star! Thanks again!

(back to top)