# markdown-folder-to-sidebar

> A simple tool to convert a markdown folder structure into a Github wiki sidebar

Latest version **1.0.0** (published 2023-01-14) · 0 weekly downloads

## Install

```sh
npm install markdown-folder-to-sidebar
pnpm add markdown-folder-to-sidebar
yarn add markdown-folder-to-sidebar
bun add markdown-folder-to-sidebar
```

Provides the command `mdf-2-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.0 |
| Published | 2023-01-14 |
| First published | 2023-01-13 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 12 KB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Author | yannickbaudrazdev@gmail.com |
| Maintainers | yannickclifford |
| Keywords | markdown, wiki, sidebar, github, wiki-sidebar, github-wiki-sidebar, cli, command-line, command-line-interface |

## Links

- npm: https://www.npmjs.com/package/markdown-folder-to-sidebar
- Repository: https://github.com/yannickcpnv/markdown-folder-to-sidebar
- Homepage: https://github.com/yannickcpnv/markdown-folder-to-sidebar#readme
- Issues: https://github.com/yannickcpnv/markdown-folder-to-sidebar/issues
- npm.io page: https://npm.io/package/markdown-folder-to-sidebar

## Dependencies (3)

- [glob](https://npm.io/package/glob.md) ^8.0.3
- [commander](https://npm.io/package/commander.md) ^9.5.0
- [markdown-it](https://npm.io/package/markdown-it.md) ^13.0.1

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-01-14
- 0.0.3 — 2023-01-13
- 0.0.2 — 2023-01-13
- 0.0.1 — 2023-01-13

## README

# Markdown Folder to Sidebar

A simple npm package that takes a folder containing markdown files and generates a sidebar based on
the markdown folder structure.

## Installation

```shell    
npm install -g markdown-folder-to-sidebar
```

## Usage

```shell
mdf-2-sidebar -f path/to/markdown/folder
```

The package takes one argument, `-f` or `--folder`, which is the path to the folder containing the
markdown files.

## Example

```shell
mdf-2-sidebar -f docs
```

This command will take all the markdown files in the `docs` folder and generate a sidebar
based on the folder structure. The sidebar will be written to `./_Sidebar.md`.

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