markdown-folder-to-sidebar
v1.0.0
Published
A simple tool to convert a markdown folder structure into a Github wiki sidebar
Downloads
13
Maintainers
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
npm install -g markdown-folder-to-sidebar
Usage
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
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
.