Awesome
Directory tree plugin
Add directory tree to markdown files via markdown-magic
Install
npm i markdown-magic markdown-magic-directory-tree --save-dev
Adding the plugin
See example.js
for usage.
const fs = require('fs');
const path = require('path');
const markdownMagic = require('markdown-magic');
const config = {
transforms: {
DIRTREE: require('./index.js'),
},
};
const markdownPath = path.join(__dirname, 'README.md');
markdownMagic(markdownPath, config);
<!-- AUTO-GENERATED-CONTENT:START (CODE:src=./example.js) -->
<!-- AUTO-GENERATED-CONTENT:END *-->
Usage in markdown
<!-- AUTO-GENERATED-CONTENT:START (DIRTREE:dir=./&depth=1) -->markdown-magic-directory-tree/
├── .npmrc
├── example.js
├── index.js
├── package-lock.json
├── package.json
└── README.md
<!-- AUTO-GENERATED-CONTENT:END -->
Options
- dir -
process.cwd()
by default - ignore -
['.git', '.gitkeep', '.gitignore', 'node_modules']
by default - depth -
Infinity
by default (how deep in the tree to traverse) - onlyDirs -
false
by default (how mnuch t)