# docsify-tools

> Quickly document your (typescript or otherwise) projects!

Latest version **1.0.20** (published 2020-03-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install docsify-tools
pnpm add docsify-tools
yarn add docsify-tools
bun add docsify-tools
```

Provides the commands `docsify-init`, `generate-ts-docs`, `docsify-auto-sidebar`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.20 |
| Published | 2020-03-20 |
| First published | 2019-04-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 690.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | gdamjan-h4, gphfour, ivasilov, skid, spion, tin-h4, whoeverest |

## Links

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

## Dependencies (5)

- [yargs](https://npm.io/package/yargs.md) ^13.2.2
- [colors](https://npm.io/package/colors.md) ^1.3.3
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [@microsoft/ts-command-line](https://npm.io/package/@microsoft/ts-command-line.md) ^4.2.3
- [@microsoft/api-extractor-model](https://npm.io/package/@microsoft/api-extractor-model.md) ^7.7.9

## Recent versions

- 1.0.20 (latest) — 2020-03-20
- 1.0.19 — 2019-05-15
- 1.0.18 — 2019-04-25
- 1.0.16 — 2019-04-24
- 1.0.15 — 2019-04-24
- 1.0.13 — 2019-04-23
- 1.0.12 — 2019-04-23
- 1.0.11 — 2019-04-15
- 1.0.10 — 2019-04-15
- 1.0.9 — 2019-04-15
- 1.0.8 — 2019-04-09
- 1.0.7 — 2019-04-09
- 1.0.6 — 2019-04-03
- 1.0.5 — 2019-04-03
- 1.0.4 — 2019-04-03
- … 3 more at https://npm.io/package/docsify-tools/versions

## README

# docsify-tools

Quickly document your (typescript or otherwise) projects!

- docsify-init provides a client-side [Docsify](https://docsify.js.org/) based markdown
  documentation site with full text search
- generate-ts-doc generates markdown documentation from api-extractor api.json files
- docsify-auto-sidebar automatically populates the sidebar from the resulting docs tree

### docsify-init

Usage:

    docsify-init [-r repoDir] [-d docsDir]

Initializes docsify in the specified repo and docs sub-directory. By default, the repo is the
current directory and the subdirectory is "docs".

You can use `docsify-init -r . -d .` to initialize in a pure-documentation repo.

### docsify-auto-sidebar

Usage:

    docsify-auto-sidebar -d docs

Generates a new `_sidebar.md` for docsify. You can prefix directories with a number and a dash to
control the ordering, the number and dash will not appear in the sidebar text. For example:

    1-Guides
    2-API

will result with "Guides" and "API" items in the sidebar.

Other dashes will be replaced with spaces

### generate-ts-doc

Like api-documenter, but it doesn't generate separate files for methods or properties. Create
the .api.json files in a directory (e.g. in docs/2-API) and then run it:

    generate-ts-doc markdown -i docs/2-API -o docs/2-API


## Notes

Don't forget to [setup your repo so that github generates a documentation site](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages)

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