Welcome to ReadMeEditor!🗒️

ReadMeEditor is a free, open source note taking / readme editing application, which helps you write and visualize your notes in real time. ReadMeEditor comes with an in-built Code Editor so you can seamlessly write your notes in Markdown. ReadMeEditor is available as a 💻 desktop web application and also comes with 🌓 Dark Mode.

Visit - https://readme-editor.herokuapp.com/

How to use ReadMeEditor?

• You can generate a starter template for a readme by clicking on the Generate Template button on the NavBar.
• Use the 📋 Note Editor to write notes in Markdown. ReadMeEditor renders it in real time.
• Directly fetch Readmes from GitHub by clicking on the Find from GitHub button. Enter the Username or Organization name, repository and branch name. ReadMeEditor will get the contents of that ReadMe file for you to edit.
• Are you an avid blogger 📔? Use it for writing blogs and visualize them on the fly.

Writing notes in Markdown

Markdown is a lightweight markup language with plain text formatting syntax. ReadMeEditor supports a Markdown Syntax.

In general, while Markdown is a markup language, it is meant to be human readable, even without being rendered. This is a simple example (you can see how it looks in the viewer panel):

---

Heading

Sub-heading

Paragraphs are separated by a blank line. Text attributes italic, bold and monospace are supported. You can create bullet lists:

• apples
• oranges
• pears

Or numbered lists:

1. wash
2. rinse
3. repeat

Or code blocks:

const count: number = 0;
console.log('Hello World');

Or Images:

This is a link and, finally, below is a horizontal rule:

---

A lot more is possible including adding code samples, math formulae or checkbox lists - see the Markdown documentation for more information.

Made with ❤ by NakshatraCodes

Buy me a coffee

See a bug? - File an issue Open to contributions - GitHub