# markdown_navigator

> markdown_navigator creates a link to quickly navigate to all the files in your folder.

Latest version **0.3.0** (published 2019-02-23) · MIT license · 0 weekly downloads

## Install

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

Provides the command `mdnv`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2019-02-23 |
| First published | 2017-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 1.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | minung.han |
| Maintainers | hmu332233 |
| Keywords | markdown |

## Links

- npm: https://www.npmjs.com/package/markdown_navigator
- Repository: https://github.com/hmu332233/markdown_navigator
- Homepage: https://github.com/hmu332233/markdown_navigator#readme
- Issues: https://github.com/hmu332233/markdown_navigator/issues
- npm.io page: https://npm.io/package/markdown_navigator

## Dependencies (2)

- [commander](https://npm.io/package/commander.md) ^2.19.0
- [path-reader](https://npm.io/package/path-reader.md) ^1.0.6

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.3.0 (latest) — 2019-02-23
- 0.2.0 — 2017-11-04
- 0.1.1 — 2017-11-01
- 0.1.0 — 2017-11-01

## README

English | [한국어](README-KR.md)

# markdown_navigator

**markdown_navigator** creates a link to quickly navigate to all the files in your directory.

Use it to quickly create index where markdown is used, such as "github".

![example](example.gif)
![example](example.PNG)

## Installation 
```bash
$ npm install -g markdown_navigator
```
## Usage
```bash
$ mdnv create <directory> [options]
```
```bash
Usage: create <directory> [options]

creates a index.md to quickly navigate to all the files in your directory.

Options:
  -n, --name [name]  The name of the index file to be created. (default: "index")
  -h, --help         output usage information

  Examples:

    $ mdnv create ./directory
    $ mdnv create ./directory -n navi
```


### Basic
If only the default command is entered,  
creates a 'index.md' for all files within the currently located directory.
```bash
$ mdnv create
```


### Example  
**example directory**
```bash
test_directory
|-- file1.md
|-- dir1
|   |-- file2.md
|   |-- file3.md
|-- dir2
|   |-- file4.md
|   |-- file5.md
```
<br/>

**basic example**
```bash
$ cd test_directory/
$ mdnv create ./
```
`index.md` is created with the following contents.
```bash
[file1.md](/file1.md)  
[file2.md](/dir1/file2.md)  
[file3.md](/dir1/file3.md)  
[file4.md](/dir2/file4.md)  
[file5.md](/dir2/file5.md)
```
<br/>  

**option example**  
This is an example of adding `directory` and `-n` options.
```bash
$ cd test_directory/
$ mdnv create ./dir1 -n menu
```
`menu.md` is created with the following contents.
```bash
[file2.md](/dir1/file2.md)
[file3.md](/dir1/file3.md)
```

## TODO
- enter multiple directory path
```bash
$ mdnv create ./dir1 ./dir2
```
```bash
[file2.md](/dir1/file2.md)
[file3.md](/dir1/file3.md)
[file4.md](/dir2/file4.md)
[file5.md](/dir2/file5.md)
```

- path option to index file to be created
```bash
$ mdnv create ./dir1 -p ./other_directory
```

## Version

**current verstion : 0.3.0**  

[change log](CHANGELOG.md)

## License

Licensed under [MIT License](LICENSE). © minung.han

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