The Last Markdown Editor You'll Ever Need

Description

READMEGenerator makes creating beautiful README files a breeze. You can also use it for any other markdown editing, markdown to HTML conversion, HTML to markdown conversion, and more!

Usage

You can choose how you want to edit at the top right of the left pane. Current options are markdown or HTML. At the top right of the right pane, you can choose how you want to preview the markdown (either as formatted markdown or rendered). Also at the top right of the right pane you can upload an HTML or .md file for editing as well as copy the markdown source code to your clipboard.

All valid html tags will be converted to markdown automatically and vice versa as you type. Here are some common features you may want to use:

Code Snippets

To do block code segments, wrap a code tag in a pre tag:

  const codeSnippet = likeThis ? yes : no

Images

To preview images here, you need to use a base64 URI string as the source. Unfortunately, this isn't supported by most code repositories and the source will need to be a relative path to a file in the repository. For example, "< img src="data:image/png;base64,iVBORw0K... />" is needed here but in a repository, would need to be something like "< img src="./< directory >/< file >.< ext >" >. A base64 example can be seen with the READMEGenerator logo at the top of this document.

Coming Soon

Integrations with DropBox and other document repositories as well as exporting as HTML, Markdown, and PDF.

Eventually we plan to allow saving multiple files for continued maintenance/edits as well as some more advanced features (a WYSIWYG editor, editor color preferences, etc.)