Documentation

Explain the system in the format it already uses.

Keep prose, examples, API details, tables, and diagrams together in Markdown that can return directly to a repository.

A repeatable writing rhythm

Spend time on the thinking, not the setup.

  1. 01Choose the README or API Documentation template.
  2. 02Write examples and Mermaid diagrams beside the explanation.
  3. 03Preview the structure and export the Markdown back to the project.
# Project Name

> A short, one-line description of what your project does.

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](#license)

## Table of Contents

- [About](#about)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## About

Describe your project in a few paragraphs. Explain the problem it solves, who it is for, and what makes it different from alternatives.

## Getting Started

### Prerequisites

- Node.js >= 18
- pnpm >= 8

### Installation

```bash
git clone https://github.com/your-username/project-name.git
cd project-name
pnpm install
```

## Usage

```bash
pnpm dev
```

Open [http://localhost:3000](http://localhost:3000) in your browser.

### Examples

```typescript
import { myFunction } from "project-name"

const result = myFunction({ input: "hello" })
console.log(result)
```

## Contributing

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## License

Distributed under the MIT License. See `LICENSE` for more information.

Why it works

Code blocks

Keep syntax-highlighted examples next to the concepts they demonstrate.

Available in the editor

Mermaid diagrams

Describe flows and systems in a versionable text block.

Available in the editor

Plain-text source

The resulting file remains readable in an editor, diff, repository, or static-site generator.

Available in the editor

Documentation templates

Begin with README or API Documentation structures when the outline is already known.

Available in the editor

Useful details

Questions, answered

Can I save back to a repository automatically?+

No repository integration is included. Export or save the Markdown file, then use your normal version-control workflow.

Does Glyphmark render Mermaid?+

Yes. Mermaid fenced code blocks render in Preview when the syntax is supported by the installed Mermaid version.

Can I write API documentation?+

Yes. Use the API Documentation template or begin with a blank Markdown document.