@synion/md-docs
Advanced tools
md-docs is a cli tool which generates a static webiste by resolving files recursivly from a source folder.
This script copies every file and directory from the docs directory into the dist directory and transforms every *.md file into a html file while adding the following features:
*.bpmn anchor is automaticly converted into a bpmn.io viewer;fir*openapi.yaml anchor is automaticly converted into a html documentation page;*asyncapi.yaml anchor is automaticly converted into a html documentation page;*.feature anchor is automaticly converted into a feature details list;*.dashboard.yaml anchor is automaticly converted into a BDD dashboard;*.user-task.yaml anchor is automaticly converted into a user-interface;*.puml filer is automaticly converted into an svg image file;*.drawio file is automaticly into an svg image file;*.java, *.cs, *.ts, *.js, *.json, *.py, *.yml, *.yml anchor is automaticly converted in a code block;_ is automaticly added to the markdown file;All links are relative so you do not need a webserver.
The application is written in node js and implements a plug in architecture. It uses Awilix under the hood for dependency resolving. Plugins can be used by extending App and adding or replacing service registrations.
There are several plugin strategies:
const App = require('md-docs-cli/app');
module.exports = class MyApp extends App {
constructor(options) {
super(options);
}
_getServices(options) {
const services = super(options);
//Option 1
services['newFileParser'] = asClass(NewFileParser).singleton();
services.fileParsers.push('newFileParser');
//Option 2
services['newHtmlParser'] = asClass(NewHtmlParser).singleton();
services.htmlParsers.push('newHtmlParser');
//Option 3
services['newAnchorParser'] = asClass(NewAnchorParser).singleton();
services.anchorParsers.push('newAnchorParser');
//Option 4
services.pageComponent = asClass(MyPageComponent).singleton();
//Option 5
services.pageComponentRenderFn = asValue((data) => '<html />');
return services;
}
}
npm install @synion/md-docs -g
mkdir ../documentation
cd documentation
mkdir docs
echo "# It works!" > docs/index.md
md-docs
google-chrome dist/index.html
md-docs -b
You can override all assets files by adding the same files to docs folder: docs/assets/style/custom-theme.css can then be overwritten by a custom theme implementation.
md-docs -s branch1 branch2
Set the environment to development. All intermediate steps are saved as files in the dist directory.
export NODE_ENV=development
FAQs
Business driven living documentation static site generator.
The npm package @synion/md-docs receives a total of 89 weekly downloads. As such, @synion/md-docs popularity was classified as not popular.
We found that @synion/md-docs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.