heading-case
v0.1.6
Published
Format page titles and section headings in markdown files to use [sentence-style capitalization](https://learn.microsoft.com/en-us/style-guide/text-formatting/using-type/use-sentence-style-capitalization).
Downloads
5,356
Readme
heading-case
Format page titles and section headings in markdown files to use sentence-style capitalization.
Example
- Input:
# A New Method for Creating JavaScript Rollovers
- Output:
# A new method for creating JavaScript rollovers
Limitations
This package is designed for Rspack's documentation. It follows the writing style of Rspack documentation and may not work well for other projects.
There are some edge cases that can not be correctly handled, so the execution result is not completely reliable.
Usage
Install:
npm add heading-case -D
Check all markdown and MDX files in the current directory:
npx heading-case
Check and write the formatted content to the file:
npx heading-case --write
License
MIT.