adjust-md-for-publish
Advanced tools
This is a tool to adjust markdown document for publishing npm package
This is a tool to adjust markdown document for publishing npm package, such as removing some section out from the destination document
const adjustMD = require('adjust-md-for-publish');
adjustMD({
filename: 'README.md',
destname: 'dist/README.md',
filterSection: ['CHANGELOG', 'References']
});
The above code runs in the simulation that README.md needs to be copied to the dist directory for publishing npm package and some chapters (example means CHANGELOG and References) needs to be removed out. The result is as follows.
original README.md content:
# Title
> This is description
## Section 1
xxxxxxxxxxxxxxxx
## CHANGELOG
changelog link here
## References
1. reference link 1
1. reference link 2
## License
MIT
adjust README.md content:
# Title
> This is description
## Section 1
xxxxxxxxxxxxxxxx
## License
MIT
MIT
[1.0.0] - 2018-04-24
FAQs
This is a tool to adjust markdown document for publishing npm package
The npm package adjust-md-for-publish receives a total of 1 weekly downloads. As such, adjust-md-for-publish popularity was classified as not popular.
We found that adjust-md-for-publish demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.