# dir-generate

> a easy tool to make dir with markdown

Latest version **0.1.2** (published 2014-10-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install dir-generate
pnpm add dir-generate
yarn add dir-generate
bun add dir-generate
```

Provides the command `dir-generate`.

## 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.1.2 |
| Published | 2014-10-16 |
| First published | 2014-08-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | GKuChan |
| Maintainers | gkuchan |
| Keywords | mkdir, dir, markdown, generate |

## Links

- npm: https://www.npmjs.com/package/dir-generate
- Repository: https://github.com/GKuChan/dir-generate
- Issues: https://github.com/GKuChan/dir-generate/issues
- npm.io page: https://npm.io/package/dir-generate

## Dependencies (5)

- [debug](https://npm.io/package/debug.md) ^2.1.0
- [process](https://npm.io/package/process.md) ^0.7.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^0.11.0
- [markdown](https://npm.io/package/markdown.md) ^0.5.0
- [commander](https://npm.io/package/commander.md) ^2.3.0

## 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.1.2 (latest) — 2014-10-16
- 0.0.0 (0.0.1) — 2014-08-12
- 0.1.1 — 2014-10-16
- 0.1.0 — 2014-10-16
- 0.0.6 — 2014-09-06
- 0.0.5 — 2014-09-05
- 0.0.4 — 2014-09-03
- 0.0.3 — 2014-09-03
- 0.0.2 — 2014-08-29
- 0.0.1 — 2014-08-29

## README

dir-generate
===============

a easy tool to make dir with markdown

generate dir with using a markdown file

[![NPM](https://nodei.co/npm/dir-generate.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/dir-generate/)

###usage for require

===============

####install
	npm install dir-generate

####usage
	var dg = require('dir-generate');
	dg.runMarkdownFile('/Users/gkuchan/Documents/index.md', '/Users/gkuchan/Documents', function (err) {
	  if(err) {
	    console.log('Oh no!');
	    return;
	  }
	  console.log('Everything is ok.')
	});

####methods
* runMarkdownFile(filePath, dirPath, callback)

###usage for command-line

===============

####install
	npm install -g dir-generate

####help
	dir-generate -help

####usage
	Usage: dir-generate [options]
  	Options:
    -h, --help                output usage information
    -d, --dir [source_dir]    set target dir path. defaults to ./
    -f, --file [source_file]  set config file path. defaults to ./index.md

###usage for dev

* make jshint
* make test
* make cov
* make test-all

###example file

===============

	index.md
	--------------------------
	* folder1
		* hello.html
		* 1-1
			* abc.txt
		* 1-2
	* folder2
		* 233.md
	* folder3
		* 3-1
			* 3-1-1
				* 3-1-1-1
					* hehe.js
	--------------------------

	dir-generate -d ./ -f ./index.md

###tip

===============

* the folder name cannot have a **Filename Extension**
* the file name must have a **Filename Extension**

###TODO

===============

* use json to generate dir

###Lincense

===============

MIT

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