# mandown

> Documentation system using markdown

Latest version **0.0.2** (published 2017-06-14) · 0 weekly downloads

## Install

```sh
npm install mandown
pnpm add mandown
yarn add mandown
bun add mandown
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2017-06-14 |
| First published | 2017-06-14 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | grantila |

## Links

- npm: https://www.npmjs.com/package/mandown
- npm.io page: https://npm.io/package/mandown

## Recent versions

- 0.0.2 (latest) — 2017-06-14

## README

# mandown

Documentation system using Markdown.

mandown allows you to document a library using markdown and convert it to a JSON structure that can be rendered, searched and managed easily. This library contains the necessary functionality to work with mandown and convert a file tree of markdown files into one JSON.

# Structure

Generally you'll document a single class or function in its own markdown file, and follow the mandown structure for what it should contain. This begins with a top-level header ("h1") with the class the file documents:

```md
# class my_lib::my_class
```

When this is set, everything "under" this h1 will be part of this class (or function). You can then add any of the following second-level headers (h2's), each with their own specific requirements:

## Headers

Describe the header (or list of header files by writing them after each other with a space in-between each):

```md
## Header mylib/my_class.hpp mylib/mylib.hpp
```

## Definition

This is a section which can contain text and code. You can describe the function or class declaration.

```md
## Definition

\```c++
template< class T > class my_class_template;
\```
```

## Description

This section contains a description of the class or function. Its purpose and how to use it.

```md
## Description

`mylib::my_class_template` wraps a value to be used for ...
```

---
_Source: https://npm.io/package/mandown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
