# filesystem-doctoc

> Make documentation from filetree

Latest version **1.0.2** (published 2017-07-05) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install filesystem-doctoc
pnpm add filesystem-doctoc
yarn add filesystem-doctoc
bun add filesystem-doctoc
```

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2017-07-05 |
| First published | 2017-07-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Daniel Lizik |
| Maintainers | daniellizik |

## Links

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

## Recent versions

- 1.0.2 (latest) — 2017-07-05
- 1.0.1 — 2017-07-05
- 1.0.0 — 2017-07-05

## README

Other table of contents generators take a single readme file. What if you have several readmes, or many? You can use `filetree-doctoc` to join many readme files in your filesystem tree into a single .md file with a table of contents that matches your file structure.

For now, it only supports github-flavor markdown.

## api

```js
import fileSystemDocToc from 'filesystem-doctoc'

fileSystemDocToc({
  // should be a file that serves as the root of your docs directory
  rootPath: `${__dirname}/docs/readmes`,
  // filepath to specify where you want output to be written
  output: `${__dirname}/docs/dist/index.md`
})
```

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