Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
changelog-to-html
Advanced tools
Readme
This package provides a CLI to convert a CHANGELOG.md
file following the Keep a Changelog convention to a static web page with permalinks and a GitHub look and feel.
It will mostly be useful for closed source libraries where customers do not have access to the source code and thus cannot benefit from the Markdown viewer built into GitHub.
The generated HTML page looks like this:
This package generates permanent links for each section.
Let's take a changelog example:
## [0.3.0] - 2003-03-03
### Added
* A bullet.
## [0.2.0] - 2002-02-02
### Added
* Another bullet.
## [0.1.0] - 2001-01-01
### Added
* Last bullet.
GitHub will generates these URLs:
This makes the added
anchors ephemeral.
Indeed, when you release another version of your package, all the existing anchors will change because GitHub will increment their trailing number:
On the other hand, this package will generate these anchors:
By prefixing the type of changes section anchor with the release name, we guarantee that the link will be permanent.
npm install --save-dev changelog-to-html
"changelog-to-html": "changelog-to-html"
to your package.json
scripts
.You can get the command help by running npm run changelog-to-html -- --help
.
FAQs
CLI to convert a CHANGELOG.md following the http://keepachangelog.com convention to a static web page with permalinks and a GitHub look and feel
The npm package changelog-to-html receives a total of 329 weekly downloads. As such, changelog-to-html popularity was classified as not popular.
We found that changelog-to-html 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.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.