Project README

Docs-as-code — the file that lives in your repo and your editor at once.

Use this templateDocs template
Project READMEDocs-as-code — the file that lives in your repo and your editor at once.

<project>

One line: <what it does, and who it's for>.

How it fits together

flowchart LR
  CLI --> Parser --> Renderer --> Output

Features

  • <Feature> — <what it lets someone do>
  • Zero config — point it at a folder, get a rendered site
  • Plain text in, plain text out — your content stays portable .md

Quick start

npm install -g <project>
<project> ./notes --serve

Usage

import { render } from '<project>';

const html = await render('./roadmap.md', { theme: 'dark' });

Configuration

OptionDefaultDescription
<option><default><what it changes>
themelightRender theme: light, dark, or paper

Contributing

git clone <repo-url>
npm install && npm test

Open a PR against main. Tests run in CI; keep them green.

License

MIT

A README's natural home is a synced folder: link this doc's folder to a GitHub repo and the file stays the same file whether you edit it here or in the repo.