Markdown quick documentation
Description
mqd is command line tool for quickly creating static documentation from the markdown files
Installation
You can install the package from npm
npm i -g mqd
Usage
In order to use the utility mqd
it is enough to specify either a separate file or directory in which files with markdown markup are located:
mqd convert path/to/source/file.md path/to/destination/directory // or mqd convert path/to/source/directory path/to/destination/directory
Configuration file
For more convenient work with the utility mqd
you can use the file to configure your project.
The configuration file should be located in the root of the project and have the name mqd.json
.
To automatically create a file, you need to run the command in the project's root folder:
mqd init
You can also pass the path to the folder where you want to initialize the configuration file:
mqd init path/to/source/directory
Menu
For easy navigation between files, a menu is automatically created. By default, the menu is presented in the form of a list consisting of file names without an extension.
enim-sed-faucibus
lorem-ipsum
quis-varius-quam
This kind of appearance may not seem very pleasant and flexible. But there is a way to make the navigation menu display the way you want.
To do this, you need to specify in the menu
section of the mqd.json
file an array of menu objects consisting of the name of the menu item and the path to the file:
For a simpler start, you can use the command:
mqd init
This command not only initializes the mqd.json
file, but also populates the menu array with all available files in the directory with the extension .md
.
Tests
npm test