Hashlite

README editor with live preview

Loading the editor…

Project name

One sentence about what this project does and who it is for.

Installation

npm install project-name

Usage

import { hello } from 'project-name';
hello('world');

Features

  • Does one thing well
  • Planned: another thing

Tip

Keep the first screen short: what it is, how to install, how to use.

License

MIT

README editor with live preview, free and in your browser

Start from the README template, or paste your own. The preview follows GitHub-flavoured Markdown: tables, task lists, fenced code with highlighting, callouts, math and Mermaid diagrams.

How it works

  1. Edit the template

    Replace the placeholders with your project’s details.

  2. Check the preview

    It renders the way GitHub does for the features most READMEs use.

  3. Copy it

    Click Copy Markdown, or download it from the ⋯ menu and rename it to README.md.

Questions

Is the preview identical to GitHub?

Very close for standard features: headings, tables, task lists, code, callouts, math and Mermaid. GitHub-only extras like @mentions and issue links aren’t resolved.

Can I keep several READMEs?

Choose Save to keep them in a free account, with folders and version history.

What should a README contain?

What the project is, how to install it, how to use it, and how to contribute. Keep the first screen short.