https://github.com/craftcms/textlint-rule-linkable-params
Custom textlint rule for allowing lowercase variations of terms when linked.
https://github.com/craftcms/textlint-rule-linkable-params
textlint textlint-rule
Last synced: 29 days ago
JSON representation
Custom textlint rule for allowing lowercase variations of terms when linked.
- Host: GitHub
- URL: https://github.com/craftcms/textlint-rule-linkable-params
- Owner: craftcms
- Created: 2022-04-05T14:54:59.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-08T11:24:57.000Z (over 3 years ago)
- Last Synced: 2025-03-04T08:44:11.426Z (over 1 year ago)
- Topics: textlint, textlint-rule
- Language: JavaScript
- Homepage:
- Size: 507 KB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# textlint-rule-linkable-params
Permits linking to a lowercase instance of a parameter that should otherwise appear in caps in a normal sentence.
Example:
```markdown
# đź‘Ť
We always want to capitalize ID in a sentence.
# đź‘Ť
We also want to be able to link to a literal [id](#id) param.
# ❌
But we shouldn’t ever write id in normal text.
```
## Install
Install with [npm](https://www.npmjs.com/):
npm install textlint-rule-linkable-params
## Usage
Via `.textlintrc`(Recommended)
```json
{
"rules": {
"linkable-params": true
}
}
```
Via CLI
```
textlint --rule linkable-params README.md
```
### Build
Builds source codes for publish to the `lib` folder.
You can write ES2015+ source codes in `src/` folder.
npm run build
### Tests
Run test code in `test` folder.
Test textlint rule by [textlint-tester](https://github.com/textlint/textlint-tester).
npm test
## License
ISC ©