diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md index 0dc1150..02831f9 100644 --- a/.github/SUPPORT.md +++ b/.github/SUPPORT.md @@ -1,11 +1,11 @@ -# Support [![Average issue resolution time][badge-issue-resolution]][link-issue-resolution] [![Issue open percentage][badge-issue-percentage]][open-issues] +# Support [![Average issue resolution time][x-badge-resolution-image]][x-badge-resolution-link] [![Issue open percentage][x-badge-percentage-image]][x-repo-open-issues] Need help? Want to help this project? See below! ## Reporting an Issue -Before you begin, please [search open and past issues][open-issues] to see if -your issue or feature request is already being talked about. +Before you begin, please [search open and past issues][x-repo-open-issues] to +see if your issue or feature request is already being talked about. If you find your issue already exists, make sure to [bump the issue by adding a reaction][github-blog]. **If you're serious about wanting an issue to get @@ -26,7 +26,7 @@ reaction emojis being present on issues, PRs, and replies: ### Bug Reports and Feature Requests For the timeliest resolution to bug reports specifically, please make a good -faith effort to [follow the template][choose-new-issue]. The more quality +faith effort to [follow the template][x-repo-choose-new-issue]. The more quality information you can provide, the quicker a fix will be found. Additionally: - Ensure you file one issue per problem or feature request. @@ -35,8 +35,8 @@ information you can provide, the quicker a fix will be found. Additionally: experiencing identical behavior or behavior that stems from the exact same problem. -That's it! You are now ready to [submit a new issue][choose-new-issue]! Thank -you for contribution πŸŽ‰, your efforts are greatly appreciated! πŸ™ŒπŸΏ +That's it! You are now ready to [submit a new issue][x-repo-choose-new-issue]! +Thank you for contribution πŸŽ‰, your efforts are greatly appreciated! πŸ™ŒπŸΏ #### Closure Policy @@ -45,15 +45,16 @@ you for contribution πŸŽ‰, your efforts are greatly appreciated! πŸ™ŒπŸΏ guidelines. - Issues that go for an extended period without activity are subject to closure. -[badge-issue-percentage]: +[github-blog]: + https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments +[x-badge-percentage-image]: https://isitmaintained.com/badge/open/Xunnamius/unified-utils.svg 'Open issues as a percentage of all issues' -[badge-issue-resolution]: +[x-badge-resolution-image]: https://isitmaintained.com/badge/resolution/Xunnamius/unified-utils.svg 'Average time to resolve an issue' -[choose-new-issue]: https://github.com/Xunnamius/unified-utils/issues/new/choose -[github-blog]: - https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments -[link-issue-resolution]: +[x-badge-resolution-link]: https://isitmaintained.com/project/Xunnamius/unified-utils -[open-issues]: https://github.com/Xunnamius/unified-utils/issues?q= +[x-repo-choose-new-issue]: + https://github.com/Xunnamius/unified-utils/issues/new/choose +[x-repo-open-issues]: https://github.com/Xunnamius/unified-utils/issues?q= diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9baabd0..e870cd8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,17 +39,17 @@ The ideal contributor flow is as follows: - Ensure any new tests still pass even when the `DEBUG` environment variable is defined. 6. Push your commits to your fork and, when you're ready, [_fearlessly_ submit - your PR][pr-compare]! Your changes will be tested in our CI pipeline. + your PR][x-repo-pr-compare]! Your changes will be tested in our CI pipeline. 7. Pat yourself on the back! Your hard work is well on its way to being reviewed and, if everything looks good, merged and released πŸš€ Additionally, there are a few things you can do to greatly increase the likelihood your PR passes review: -- **Do** [open an issue][choose-new-issue] and discuss your proposed changes (to - prevent wasting your valuable time, e.g. _maybe we're already working on a - fix!_), and [search][open-issues] to see if there are any existing issues - related to your concerns. +- **Do** [open an issue][x-repo-choose-new-issue] and discuss your proposed + changes (to prevent wasting your valuable time, e.g. _maybe we're already + working on a fix!_), and [search][open-issues] to see if there are any + existing issues related to your concerns. - **Do** practice [atomic committing][atomic-commits]. - **Do not** reduce code coverage ([codecov][codecov] checks are performed during CI). @@ -76,7 +76,6 @@ likelihood your PR passes review: At this point, you're ready to create your PR and ✨ contribute ✨! [atomic-commits]: https://www.codewithjason.com/atomic-commits-testing -[choose-new-issue]: https://github.com/Xunnamius/unified-utils/issues/new/choose [code-of-conduct]: /.github/CODE_OF_CONDUCT.md [codecov]: https://about.codecov.io [conventional-commits]: https://www.conventionalcommits.org/en/v1.0.0#summary @@ -92,5 +91,7 @@ At this point, you're ready to create your PR and ✨ contribute ✨! [open-issues]: https://github.com/Xunnamius/unified-utils/issues?q= [pkg-debug]: https://www.npmjs.com/package/debug [pkg-debug-wildcards]: https://www.npmjs.com/package/debug#wildcards -[pr-compare]: https://github.com/Xunnamius/unified-utils/compare [projector]: https://github.com/Xunnamius/unified-utils#readme +[x-repo-choose-new-issue]: + https://github.com/Xunnamius/unified-utils/issues/new/choose +[x-repo-pr-compare]: https://github.com/Xunnamius/unified-utils/compare diff --git a/MAINTAINING.md b/MAINTAINING.md new file mode 100644 index 0000000..ebbeb5f --- /dev/null +++ b/MAINTAINING.md @@ -0,0 +1,146 @@ +# Maintaining + +This is documentation for maintainers of this project. + +## Code of Conduct + +Please [review][1], understand, and be an example of it. Violations of the code +of conduct are taken seriously, even (especially) for maintainers. + +## Issues + +We want to support and build the community. We do that best by helping people +learn to solve their own problems. We have an issue template and hopefully most +folks follow it. If it's not clear what the issue is, invite them to create a +minimal reproduction of what they're trying to accomplish or the bug they think +they've found. + +Once it's determined that a code change is necessary, point people to +[makeapullrequest.com][2] and invite them to make a pull request. If they're the +one who needs the feature, they're the one who can build it. If they need some +hand holding and you have time to lend a hand, please do so. It's an investment +into another human being, and an investment into a potential maintainer. + +Remember that this is open source, so the code is not yours, it's ours. If +someone needs a change in the codebase, you don't have to make it happen +yourself. Commit as much time to the project as you want/need to. Nobody can ask +any more of you than that. + +## Pull Requests + +As a maintainer, you're fine to make your branches on the main repo or on your +own fork. Either way is fine. + +When we receive a pull request, a GitHub Actions build is kicked off +automatically (see [`.github/workflows`][3]). We avoid merging anything that +fails the Actions workflow. + +Please review PRs and focus on the code rather than the individual. You never +know when this is someone's first ever PR and we want their experience to be as +positive as possible, so be uplifting and constructive. + +When you merge the pull request, 99% of the time you should use the [rebase and +merge][4] feature. This keeps our git history clean. If commit messages need to +be adjusted, maintainers should force push new commits with adjusted messages to +the PR branch before merging it in. + +The [squash and merge][5] feature can also be used, but keep in mind that +squashing commits will likely damage the [generated][6] [CHANGELOG.md][7], +hinder [bisection][8], and result in [non-atomic commits][9], so use it +sparingly. + +## Release + +Our releases are automatic. They happen whenever code lands into `master`. A +GitHub Actions build gets kicked off and, if it's successful, a tool called +[`semantic-release`][10] is used to automatically publish a new release to npm +and GitHub along with an updated changelog. It is only able to determine the +version and whether a release is necessary by the git commit messages. With this +in mind, **please brush up on [the commit message convention][commit] which +drives our releases.** + +> One important note about this: please make sure that commit messages do NOT +> contain the words "BREAKING CHANGE" in them unless we want to push a major +> version. I've been burned by this more than once where someone will include +> "BREAKING CHANGE: None" and it will end up releasing a new major version. Do +> not do this! + +### Manual Releases + +This project has an automated release set up. That means things are only +released when there are useful changes in the code that justify a release. See +[the release rules][11] for a list of commit types that trigger releases. + +However, sometimes things get messed up (e.g. CI workflow / GitHub Actions +breaks) and we need to trigger a release ourselves. When this happens, +semantic-release can be triggered locally by following these steps: + +> If one of these steps fails, you should address the failure before running the +> next step. + +```bash +# These command must be run from the project root. It is recommended to clone a +# fresh version of the repo to a temp directory and run these commands from +# there. + +# 1. Install dependencies and add your auth tokens to the .env file. +# ! DO NOT COMMIT THE .env FILE ! +cp .env.default .env +npm ci + +# 2. Reset the working directory to a clean state (deletes all ignored files). +npm run clean + +# 3. Lint all files. +npm run lint:all + +# 4. Build distributables. +npm run build:dist + +# 5. Build auxiliary documentation. +npm run build:docs + +# 6. Build any external executables (used in GitHub Actions workflows). +npm run build:externals + +# 7. Format all files. +npm run format + +# 8. Run all possible tests and generate coverage information. +npm run test:all + +# 9. Upload coverage information to codecov (only if you have the proper token). +CODECOV_TOKEN=$(npx --yes dotenv-cli -p CODECOV_TOKEN) codecov + +# 10. Trigger semantic-release locally and generate a new release. This requires +# having tokens for NPM and GitHub with the appropriate permissions. +# +# Do a dry run first: +NPM_TOKEN="$(npx --yes dotenv-cli -p NPM_TOKEN)" GH_TOKEN="$(npx --yes dotenv-cli -p GITHUB_TOKEN)" HUSKY=0 UPDATE_CHANGELOG=true GIT_AUTHOR_NAME="$(npx --yes dotenv-cli -p GIT_AUTHOR_NAME)" GIT_COMMITTER_NAME="$(npx --yes dotenv-cli -p GIT_COMMITTER_NAME)" GIT_AUTHOR_EMAIL="$(npx --yes dotenv-cli -p GIT_AUTHOR_EMAIL)" GIT_COMMITTER_EMAIL="$(npx --yes dotenv-cli -p GIT_COMMITTER_EMAIL)" node node_modules/.bin/semantic-release --no-ci --extends "$(pwd)/release.config.js" --dry-run +# Then do the actual publish: +NPM_TOKEN="$(npx --yes dotenv-cli -p NPM_TOKEN)" GH_TOKEN="$(npx --yes dotenv-cli -p GITHUB_TOKEN)" HUSKY=0 UPDATE_CHANGELOG=true GIT_AUTHOR_NAME="$(npx --yes dotenv-cli -p GIT_AUTHOR_NAME)" GIT_COMMITTER_NAME="$(npx --yes dotenv-cli -p GIT_COMMITTER_NAME)" GIT_AUTHOR_EMAIL="$(npx --yes dotenv-cli -p GIT_AUTHOR_EMAIL)" GIT_COMMITTER_EMAIL="$(npx --yes dotenv-cli -p GIT_COMMITTER_EMAIL)" node node_modules/.bin/semantic-release --no-ci --extends "$(pwd)/release.config.js" +``` + + + +## Thanks! + +Thank you so much for helping to maintain this project! + +[commit]: + https://github.com/conventional-changelog-archived-repos/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md +[1]: ./.github/CODE_OF_CONDUCT.md +[2]: http://makeapullrequest.com +[3]: ./.github/workflows +[4]: + https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#rebase-and-merge-your-commits +[5]: + https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits +[6]: https://github.com/conventional-changelog/conventional-changelog +[7]: https://www.conventionalcommits.org/en/v1.0.0 +[8]: + https://www.metaltoad.com/blog/beginners-guide-git-bisect-process-elimination +[9]: https://dev.to/paulinevos/atomic-commits-will-help-you-git-legit-35i7 +[10]: https://github.com/semantic-release/semantic-release +[11]: + https://github.com/Xunnamius/unified-utils/blob/82312c4c1476796724169c1b44fc6128aeeb57fb/release.config.js#L27 diff --git a/README.md b/README.md index ce12ebb..6cfec0a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -[![Black Lives Matter!][badge-blm]][link-blm] -[![Last commit timestamp][badge-last-commit]][link-repo] -[![Open issues][badge-issues]][link-issues] -[![Pull requests][badge-pulls]][link-pulls] -[![Uses semantic-release][badge-semantic-release]][link-semantic-release] +[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link] +[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link] +[![Open issues][x-badge-issues-image]][x-badge-issues-link] +[![Pull requests][x-badge-pulls-image]][x-badge-pulls-link] +[![Uses semantic-release][x-badge-semanticrelease-image]][x-badge-semanticrelease-link] @@ -88,12 +88,13 @@ back upstream. ## Contributing and Support -**[New issues][choose-new-issue] and [pull requests][pr-compare] are always -welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 this -project][link-repo] to let me know you found it useful! ✊🏿 Thank you! +**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare] +are always welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 +this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Thank +you! -See [CONTRIBUTING.md][contributing] and [SUPPORT.md][support] for more -information. +See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for +more information. ### Contributors @@ -136,31 +137,34 @@ Thanks goes to these wonderful people ([emoji key][24]): -This project follows the [all-contributors][25] specification. Contributions of -any kind welcome! +This project follows the [all-contributors][x-repo-all-contributors] +specification. Contributions of any kind welcome! -[badge-blm]: https://xunn.at/badge-blm 'Join the movement!' -[badge-issues]: - https://img.shields.io/github/issues/Xunnamius/unified-utils +[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!' +[x-badge-blm-link]: https://xunn.at/donate-blm +[x-badge-issues-image]: + https://img.shields.io/github/issues/Xunnamius/unified-utils?style=flat-square 'Open issues' -[badge-last-commit]: - https://img.shields.io/github/last-commit/xunnamius/unified-utils +[x-badge-issues-link]: https://github.com/Xunnamius/unified-utils/issues?q= +[x-badge-lastcommit-image]: + https://img.shields.io/github/last-commit/xunnamius/unified-utils?style=flat-square 'Latest commit timestamp' -[badge-pulls]: - https://img.shields.io/github/issues-pr/xunnamius/unified-utils +[x-badge-pulls-image]: + https://img.shields.io/github/issues-pr/xunnamius/unified-utils?style=flat-square 'Open pull requests' -[badge-semantic-release]: - https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg +[x-badge-pulls-link]: https://github.com/xunnamius/unified-utils/pulls +[x-badge-repo-link]: https://github.com/xunnamius/unified-utils +[x-badge-semanticrelease-image]: + https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square 'This repo uses semantic-release!' -[choose-new-issue]: https://github.com/xunnamius/unified-utils/issues/new/choose -[contributing]: CONTRIBUTING.md -[link-blm]: https://xunn.at/donate-blm -[link-issues]: https://github.com/Xunnamius/unified-utils/issues?q= -[link-pulls]: https://github.com/xunnamius/unified-utils/pulls -[link-repo]: https://github.com/xunnamius/unified-utils -[link-semantic-release]: https://github.com/semantic-release/semantic-release -[pr-compare]: https://github.com/xunnamius/unified-utils/compare -[support]: .github/SUPPORT.md +[x-badge-semanticrelease-link]: + https://github.com/semantic-release/semantic-release +[x-repo-all-contributors]: https://github.com/all-contributors/all-contributors +[x-repo-choose-new-issue]: + https://github.com/xunnamius/unified-utils/issues/new/choose +[x-repo-contributing]: CONTRIBUTING.md +[x-repo-pr-compare]: https://github.com/xunnamius/unified-utils/compare +[x-repo-support]: .github/SUPPORT.md [1]: https://github.com/syntax-tree/unist [2]: https://github.com/syntax-tree/mdast [3]: https://github.com/remarkjs @@ -187,4 +191,3 @@ any kind welcome! https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-empty-url [23]: https://github.com/Xunnamius/projector/blob/main/packages/config-remark [24]: https://allcontributors.org/docs/en/emoji-key -[25]: https://github.com/all-contributors/all-contributors diff --git a/SECURITY.md b/SECURITY.md index 5fc40de..188d1fc 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,17 +2,18 @@ If the issue is related to a public alert from OWASP/GitHub/Dependabot/CVE/etc and [does not already have an open issue][open-issues], feel free to [open a new -issue][choose-new-issue]. Otherwise, please report any security vulnerability, -other security-related incident, or otherwise sensitive subject to us [via -email][security-mailto]. +issue][x-repo-choose-new-issue]. Otherwise, please report any security +vulnerability, other security-related incident, or otherwise sensitive subject +to us [via email][security-mailto]. Thank you for your contribution! [badge-security]: https://snyk.io/test/github/Xunnamius/unified-utils/badge.svg 'Number of vulnerabilities (scanned by Snyk)' -[choose-new-issue]: https://github.com/Xunnamius/unified-utils/issues/new/choose [link-security]: https://snyk.io/test/github/Xunnamius/unified-utils [open-issues]: https://github.com/Xunnamius/unified-utils/issues?q= [security-mailto]: mailto:security@ergodark.com?subject=ALERT%3A%20SECURITY%20INCIDENT%3A%20%28five%20word%20summary%29 +[x-repo-choose-new-issue]: + https://github.com/Xunnamius/unified-utils/issues/new/choose diff --git a/packages/mdast-util-hidden/README.md b/packages/mdast-util-hidden/README.md index 24dc02e..0993b9d 100644 --- a/packages/mdast-util-hidden/README.md +++ b/packages/mdast-util-hidden/README.md @@ -1,14 +1,12 @@ -[![Black Lives Matter!][badge-blm]][link-blm] -[![Maintenance status][badge-maintenance]][link-repo] -[![Last commit timestamp][badge-last-commit]][link-repo] -[![Open issues][badge-issues]][link-issues] -[![Pull requests][badge-pulls]][link-pulls] -[![Codecov][badge-codecov]][link-codecov] -[![Source license][badge-license]][link-license] -[![NPM version][badge-npm]][link-npm] -[![Uses Semantic Release!][badge-semantic-release]][link-semantic-release] +[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link] +[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link] +[![Codecov][x-badge-codecov-image]][x-badge-codecov-link] +[![Source license][x-badge-license-image]][x-badge-license-link] +[![Monthly Downloads][x-badge-downloads-image]][x-badge-npm-link] +[![NPM version][x-badge-npm-image]][x-badge-npm-link] +[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link] @@ -274,7 +272,7 @@ found in [the remark-renumber-references source code][13]. ## API -Detailed interface information can be found under [`docs/`][docs]. +Detailed interface information can be found under [`docs/`][x-repo-docs]. ### Ast Nodes @@ -304,57 +302,53 @@ and cannot be derived [from markdown][17] directly. ## Contributing and Support -**[New issues][choose-new-issue] and [pull requests][pr-compare] are always -welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 this -project][link-repo] to let me know you found it useful! ✊🏿 Thank you! +**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare] +are always welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 +this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Thank +you! -See [CONTRIBUTING.md][contributing] and [SUPPORT.md][support] for more -information. +See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for +more information. ### Contributors -See the [table of contributors][19]. +See the [table of contributors][x-repo-contributors]. -[badge-blm]: https://xunn.at/badge-blm 'Join the movement!' -[badge-codecov]: - https://codecov.io/gh/Xunnamius/unified-utils/branch/main/graph/badge.svg?token=HWRIOBAAPW +[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!' +[x-badge-blm-link]: https://xunn.at/donate-blm +[x-badge-codecov-image]: + https://img.shields.io/codecov/c/github/Xunnamius/unified-utils/main?style=flat-square&token=HWRIOBAAPW 'Is this package well-tested?' -[badge-issues]: - https://img.shields.io/github/issues/Xunnamius/unified-utils - 'Open issues' -[badge-last-commit]: - https://img.shields.io/github/last-commit/xunnamius/unified-utils +[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/unified-utils +[x-badge-downloads-image]: + https://img.shields.io/npm/dm/mdast-util-hidden?style=flat-square + 'Number of times this package has been downloaded per month' +[x-badge-lastcommit-image]: + https://img.shields.io/github/last-commit/xunnamius/unified-utils?style=flat-square 'Latest commit timestamp' -[badge-license]: - https://img.shields.io/npm/l/mdast-util-hidden +[x-badge-license-image]: + https://img.shields.io/npm/l/mdast-util-hidden?style=flat-square "This package's source license" -[badge-maintenance]: - https://img.shields.io/maintenance/active/2023 - 'Is this package maintained?' -[badge-npm]: - https://api.ergodark.com/badges/npm-pkg-version/mdast-util-hidden - 'Install this package using npm or yarn!' -[badge-pulls]: - https://img.shields.io/github/issues-pr/xunnamius/unified-utils - 'Open pull requests' -[badge-semantic-release]: - https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - 'This repo practices continuous integration and deployment!' -[choose-new-issue]: https://github.com/xunnamius/unified-utils/issues/new/choose -[contributing]: /CONTRIBUTING.md -[docs]: docs -[link-blm]: https://xunn.at/donate-blm -[link-codecov]: https://codecov.io/gh/Xunnamius/unified-utils -[link-issues]: https://github.com/Xunnamius/unified-utils/issues?q= -[link-license]: +[x-badge-license-link]: https://github.com/Xunnamius/unified-utils/blob/main/packages/mdast-util-hidden/LICENSE -[link-npm]: https://www.npmjs.com/package/mdast-util-hidden -[link-pulls]: https://github.com/xunnamius/unified-utils/pulls -[link-repo]: +[x-badge-npm-image]: + https://xunn.at/npm-pkg-version/mdast-util-hidden + 'Install this package using npm or yarn!' +[x-badge-npm-link]: https://www.npmjs.com/package/mdast-util-hidden +[x-badge-repo-link]: https://github.com/xunnamius/unified-utils/blob/main/packages/mdast-util-hidden -[link-semantic-release]: https://github.com/semantic-release/semantic-release -[pr-compare]: https://github.com/xunnamius/unified-utils/compare -[support]: /.github/SUPPORT.md +[x-badge-semanticrelease-image]: + https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square + 'This repo practices continuous integration and deployment!' +[x-badge-semanticrelease-link]: + https://github.com/semantic-release/semantic-release +[x-repo-choose-new-issue]: + https://github.com/xunnamius/unified-utils/issues/new/choose +[x-repo-contributing]: /CONTRIBUTING.md +[x-repo-contributors]: /README.md#contributors +[x-repo-docs]: docs +[x-repo-pr-compare]: https://github.com/xunnamius/unified-utils/compare +[x-repo-support]: /.github/SUPPORT.md [1]: https://github.com/syntax-tree/mdast [2]: #hidden [3]: https://github.com/xunnamius/unified-utils/blob/main/packages/remark-ignore @@ -374,4 +368,3 @@ See the [table of contributors][19]. [16]: https://github.com/syntax-tree/mdast-util-to-markdown [17]: https://github.com/syntax-tree/mdast-util-from-markdown [18]: https://npm.im/rehype-ignore -[19]: /README.md#contributors diff --git a/packages/mdast-util-hidden/docs/README.md b/packages/mdast-util-hidden/docs/README.md index 0b01ff0..2d677f3 100644 --- a/packages/mdast-util-hidden/docs/README.md +++ b/packages/mdast-util-hidden/docs/README.md @@ -36,7 +36,7 @@ Returns a new `Hidden` node ready to be inserted into a mdast tree. #### Defined in -[packages/mdast-util-hidden/src/index.ts:23](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/mdast-util-hidden/src/index.ts#L23) +[packages/mdast-util-hidden/src/index.ts:23](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/mdast-util-hidden/src/index.ts#L23) ___ @@ -69,7 +69,7 @@ in will become the hidden children of this new node. #### Defined in -[packages/mdast-util-hidden/src/index.ts:42](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/mdast-util-hidden/src/index.ts#L42) +[packages/mdast-util-hidden/src/index.ts:42](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/mdast-util-hidden/src/index.ts#L42) ___ @@ -92,7 +92,7 @@ node is Hidden #### Defined in -[packages/mdast-util-hidden/src/index.ts:34](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/mdast-util-hidden/src/index.ts#L34) +[packages/mdast-util-hidden/src/index.ts:34](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/mdast-util-hidden/src/index.ts#L34) ___ @@ -124,7 +124,7 @@ one or more `Hidden` `nodes`. #### Defined in -[packages/mdast-util-hidden/src/index.ts:85](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/mdast-util-hidden/src/index.ts#L85) +[packages/mdast-util-hidden/src/index.ts:85](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/mdast-util-hidden/src/index.ts#L85) ___ @@ -156,7 +156,7 @@ instead. | `Β«destructuredΒ»` | `Object` | - | | β€ΊΒ `reverse?` | `boolean` | **`See`** https://github.com/syntax-tree/unist-util-visit#visittree-test-visitor-reverse **`Default`** false | | β€ΊΒ `tree` | `Tree` | **`See`** https://github.com/syntax-tree/unist-util-visit#visittree-test-visitor-reverse | -| β€ΊΒ `visitor?` | `Visitor` | If `visitor` is provided but returns `false`, `reveal` is not called and the hidden is not revealed. Otherwise, `reveal` will always be called. If `visitor` is provided and returns a defined value other than `false`, that value will be passed through to unist-util-visit. If `visitor` is not provided, or it returns `undefined`, `[SKIP, index]` will be passed through instead. | +| β€ΊΒ `visitor?` | `Visitor`<`Node`<`Data`\>, `Parent`<`Node`<`Data`\>, `Data`\>\> | If `visitor` is provided but returns `false`, `reveal` is not called and the hidden is not revealed. Otherwise, `reveal` will always be called. If `visitor` is provided and returns a defined value other than `false`, that value will be passed through to unist-util-visit. If `visitor` is not provided, or it returns `undefined`, `[SKIP, index]` will be passed through instead. | #### Returns @@ -164,4 +164,4 @@ instead. #### Defined in -[packages/mdast-util-hidden/src/index.ts:113](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/mdast-util-hidden/src/index.ts#L113) +[packages/mdast-util-hidden/src/index.ts:113](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/mdast-util-hidden/src/index.ts#L113) diff --git a/packages/mdast-util-hidden/docs/interfaces/Hidden.md b/packages/mdast-util-hidden/docs/interfaces/Hidden.md index 30f01f2..e534b2f 100644 --- a/packages/mdast-util-hidden/docs/interfaces/Hidden.md +++ b/packages/mdast-util-hidden/docs/interfaces/Hidden.md @@ -47,7 +47,7 @@ ___ #### Defined in -[packages/mdast-util-hidden/src/index.ts:17](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/mdast-util-hidden/src/index.ts#L17) +[packages/mdast-util-hidden/src/index.ts:17](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/mdast-util-hidden/src/index.ts#L17) ___ @@ -78,4 +78,4 @@ Node.type #### Defined in -[packages/mdast-util-hidden/src/index.ts:16](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/mdast-util-hidden/src/index.ts#L16) +[packages/mdast-util-hidden/src/index.ts:16](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/mdast-util-hidden/src/index.ts#L16) diff --git a/packages/mdast-util-tight-comments/README.md b/packages/mdast-util-tight-comments/README.md index 8c0ca39..61e5cc3 100644 --- a/packages/mdast-util-tight-comments/README.md +++ b/packages/mdast-util-tight-comments/README.md @@ -1,14 +1,12 @@ -[![Black Lives Matter!][badge-blm]][link-blm] -[![Maintenance status][badge-maintenance]][link-repo] -[![Last commit timestamp][badge-last-commit]][link-repo] -[![Open issues][badge-issues]][link-issues] -[![Pull requests][badge-pulls]][link-pulls] -[![Codecov][badge-codecov]][link-codecov] -[![Source license][badge-license]][link-license] -[![NPM version][badge-npm]][link-npm] -[![Uses Semantic Release!][badge-semantic-release]][link-semantic-release] +[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link] +[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link] +[![Codecov][x-badge-codecov-image]][x-badge-codecov-link] +[![Source license][x-badge-license-image]][x-badge-license-link] +[![Monthly Downloads][x-badge-downloads-image]][x-badge-npm-link] +[![NPM version][x-badge-npm-image]][x-badge-npm-link] +[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link] @@ -227,7 +225,7 @@ special consideration in that: ## API -Detailed interface information can be found under [`docs/`][docs]. +Detailed interface information can be found under [`docs/`][x-repo-docs]. ## Related @@ -235,57 +233,53 @@ Detailed interface information can be found under [`docs/`][docs]. ## Contributing and Support -**[New issues][choose-new-issue] and [pull requests][pr-compare] are always -welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 this -project][link-repo] to let me know you found it useful! ✊🏿 Thank you! +**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare] +are always welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 +this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Thank +you! -See [CONTRIBUTING.md][contributing] and [SUPPORT.md][support] for more -information. +See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for +more information. ### Contributors -See the [table of contributors][8]. +See the [table of contributors][x-repo-contributors]. -[badge-blm]: https://xunn.at/badge-blm 'Join the movement!' -[badge-codecov]: - https://codecov.io/gh/Xunnamius/unified-utils/branch/main/graph/badge.svg?token=HWRIOBAAPW +[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!' +[x-badge-blm-link]: https://xunn.at/donate-blm +[x-badge-codecov-image]: + https://img.shields.io/codecov/c/github/xunnamius/unified-utils/main?style=flat-square&token=HWRIOBAAPW 'Is this package well-tested?' -[badge-issues]: - https://img.shields.io/github/issues/Xunnamius/unified-utils - 'Open issues' -[badge-last-commit]: - https://img.shields.io/github/last-commit/xunnamius/unified-utils +[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/unified-utils +[x-badge-downloads-image]: + https://img.shields.io/npm/dm/mdast-util-tight-comments?style=flat-square + 'Number of times this package has been downloaded per month' +[x-badge-lastcommit-image]: + https://img.shields.io/github/last-commit/xunnamius/unified-utils?style=flat-square 'Latest commit timestamp' -[badge-license]: - https://img.shields.io/npm/l/mdast-util-tight-comments +[x-badge-license-image]: + https://img.shields.io/npm/l/mdast-util-tight-comments?style=flat-square "This package's source license" -[badge-maintenance]: - https://img.shields.io/maintenance/active/2023 - 'Is this package maintained?' -[badge-npm]: - https://api.ergodark.com/badges/npm-pkg-version/mdast-util-tight-comments - 'Install this package using npm or yarn!' -[badge-pulls]: - https://img.shields.io/github/issues-pr/xunnamius/unified-utils - 'Open pull requests' -[badge-semantic-release]: - https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - 'This repo practices continuous integration and deployment!' -[choose-new-issue]: https://github.com/xunnamius/unified-utils/issues/new/choose -[contributing]: /CONTRIBUTING.md -[docs]: docs -[link-blm]: https://xunn.at/donate-blm -[link-codecov]: https://codecov.io/gh/Xunnamius/unified-utils -[link-issues]: https://github.com/Xunnamius/unified-utils/issues?q= -[link-license]: +[x-badge-license-link]: https://github.com/Xunnamius/unified-utils/blob/main/packages/mdast-util-tight-comments/LICENSE -[link-npm]: https://www.npmjs.com/package/mdast-util-tight-comments -[link-pulls]: https://github.com/xunnamius/unified-utils/pulls -[link-repo]: +[x-badge-npm-image]: + https://xunn.at/npm-pkg-version/mdast-util-tight-comments + 'Install this package using npm or yarn!' +[x-badge-npm-link]: https://www.npmjs.com/package/mdast-util-tight-comments +[x-badge-repo-link]: https://github.com/xunnamius/unified-utils/blob/main/packages/mdast-util-tight-comments -[link-semantic-release]: https://github.com/semantic-release/semantic-release -[pr-compare]: https://github.com/xunnamius/unified-utils/compare -[support]: /.github/SUPPORT.md +[x-badge-semanticrelease-image]: + https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square + 'This repo practices continuous integration and deployment!' +[x-badge-semanticrelease-link]: + https://github.com/semantic-release/semantic-release +[x-repo-choose-new-issue]: + https://github.com/xunnamius/unified-utils/issues/new/choose +[x-repo-contributing]: /CONTRIBUTING.md +[x-repo-contributors]: /README.md#contributors +[x-repo-docs]: docs +[x-repo-pr-compare]: https://github.com/xunnamius/unified-utils/compare +[x-repo-support]: /.github/SUPPORT.md [1]: https://github.com/thlorenz/doctoc [2]: https://github.com/syntax-tree/mdast-util-to-markdown [3]: @@ -294,4 +288,3 @@ See the [table of contributors][8]. [5]: https://github.com/thlorenz/doctoc#update-existing-doctoc-tocs-effortlessly [6]: /.remarkrc.mjs [7]: /packages/remark-tight-comments -[8]: /README.md#contributors diff --git a/packages/mdast-util-tight-comments/docs/README.md b/packages/mdast-util-tight-comments/docs/README.md index 83294ae..5cbd662 100644 --- a/packages/mdast-util-tight-comments/docs/README.md +++ b/packages/mdast-util-tight-comments/docs/README.md @@ -23,4 +23,4 @@ HTML comments and select other mdast nodes under certain conditions. #### Defined in -[index.ts:7](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/mdast-util-tight-comments/src/index.ts#L7) +[index.ts:7](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/mdast-util-tight-comments/src/index.ts#L7) diff --git a/packages/remark-capitalize-headings/README.md b/packages/remark-capitalize-headings/README.md index 933bea3..39f9627 100644 --- a/packages/remark-capitalize-headings/README.md +++ b/packages/remark-capitalize-headings/README.md @@ -1,14 +1,12 @@ -[![Black Lives Matter!][badge-blm]][link-blm] -[![Maintenance status][badge-maintenance]][link-repo] -[![Last commit timestamp][badge-last-commit]][link-repo] -[![Open issues][badge-issues]][link-issues] -[![Pull requests][badge-pulls]][link-pulls] -[![Codecov][badge-codecov]][link-codecov] -[![Source license][badge-license]][link-license] -[![NPM version][badge-npm]][link-npm] -[![Uses Semantic Release!][badge-semantic-release]][link-semantic-release] +[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link] +[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link] +[![Codecov][x-badge-codecov-image]][x-badge-codecov-link] +[![Source license][x-badge-license-image]][x-badge-license-link] +[![Monthly Downloads][x-badge-downloads-image]][x-badge-npm-link] +[![NPM version][x-badge-npm-image]][x-badge-npm-link] +[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link] @@ -137,7 +135,7 @@ export default { ## API -Detailed interface information can be found under [`docs/`][docs]. +Detailed interface information can be found under [`docs/`][x-repo-docs]. ### Options @@ -562,57 +560,53 @@ Would output the following compared to `example.md`: ## Contributing and Support -**[New issues][choose-new-issue] and [pull requests][pr-compare] are always -welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 this -project][link-repo] to let me know you found it useful! ✊🏿 Thank you! +**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare] +are always welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 +this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Thank +you! -See [CONTRIBUTING.md][contributing] and [SUPPORT.md][support] for more -information. +See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for +more information. ### Contributors -See the [table of contributors][14]. +See the [table of contributors][x-repo-contributors]. -[badge-blm]: https://xunn.at/badge-blm 'Join the movement!' -[badge-codecov]: - https://codecov.io/gh/Xunnamius/unified-utils/branch/main/graph/badge.svg?token=HWRIOBAAPW +[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!' +[x-badge-blm-link]: https://xunn.at/donate-blm +[x-badge-codecov-image]: + https://img.shields.io/codecov/c/github/Xunnamius/unified-utils/main?style=flat-square&token=HWRIOBAAPW 'Is this package well-tested?' -[badge-issues]: - https://img.shields.io/github/issues/Xunnamius/unified-utils - 'Open issues' -[badge-last-commit]: - https://img.shields.io/github/last-commit/xunnamius/unified-utils +[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/unified-utils +[x-badge-downloads-image]: + https://img.shields.io/npm/dm/remark-capitalize-headings?style=flat-square + 'Number of times this package has been downloaded per month' +[x-badge-lastcommit-image]: + https://img.shields.io/github/last-commit/xunnamius/unified-utils?style=flat-square 'Latest commit timestamp' -[badge-license]: - https://img.shields.io/npm/l/remark-capitalize-headings +[x-badge-license-image]: + https://img.shields.io/npm/l/remark-capitalize-headings?style=flat-square "This package's source license" -[badge-maintenance]: - https://img.shields.io/maintenance/active/2023 - 'Is this package maintained?' -[badge-npm]: - https://api.ergodark.com/badges/npm-pkg-version/remark-capitalize-headings - 'Install this package using npm or yarn!' -[badge-pulls]: - https://img.shields.io/github/issues-pr/xunnamius/unified-utils - 'Open pull requests' -[badge-semantic-release]: - https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - 'This repo practices continuous integration and deployment!' -[choose-new-issue]: https://github.com/xunnamius/unified-utils/issues/new/choose -[contributing]: /CONTRIBUTING.md -[docs]: docs -[link-blm]: https://xunn.at/donate-blm -[link-codecov]: https://codecov.io/gh/Xunnamius/unified-utils -[link-issues]: https://github.com/Xunnamius/unified-utils/issues?q= -[link-license]: +[x-badge-license-link]: https://github.com/Xunnamius/unified-utils/blob/main/packages/remark-capitalize-headings/LICENSE -[link-npm]: https://www.npmjs.com/package/remark-capitalize-headings -[link-pulls]: https://github.com/xunnamius/unified-utils/pulls -[link-repo]: +[x-badge-npm-image]: + https://xunn.at/npm-pkg-version/remark-capitalize-headings + 'Install this package using npm or yarn!' +[x-badge-npm-link]: https://www.npmjs.com/package/remark-capitalize-headings +[x-badge-repo-link]: https://github.com/xunnamius/unified-utils/blob/main/packages/remark-capitalize-headings -[link-semantic-release]: https://github.com/semantic-release/semantic-release -[pr-compare]: https://github.com/xunnamius/unified-utils/compare -[support]: /.github/SUPPORT.md +[x-badge-semanticrelease-image]: + https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square + 'This repo practices continuous integration and deployment!' +[x-badge-semanticrelease-link]: + https://github.com/semantic-release/semantic-release +[x-repo-choose-new-issue]: + https://github.com/xunnamius/unified-utils/issues/new/choose +[x-repo-contributing]: /CONTRIBUTING.md +[x-repo-contributors]: /README.md#contributors +[x-repo-docs]: docs +[x-repo-pr-compare]: https://github.com/xunnamius/unified-utils/compare +[x-repo-support]: /.github/SUPPORT.md [1]: https://github.com/unifiedjs/unified [2]: https://github.com/remarkjs/remark [3]: https://github.com/vercel/title @@ -628,4 +622,3 @@ See the [table of contributors][14]. [11]: https://github.com/vercel/remark-capitalize [12]: /packages/remark-ignore [13]: https://github.com/unifiedjs/unified#overview -[14]: /README.md#contributors diff --git a/packages/remark-capitalize-headings/docs/README.md b/packages/remark-capitalize-headings/docs/README.md index a5e2ed8..036c33b 100644 --- a/packages/remark-capitalize-headings/docs/README.md +++ b/packages/remark-capitalize-headings/docs/README.md @@ -30,7 +30,7 @@ Options type for the remark-remove-url-trailing-slash plugin. #### Defined in -[packages/remark-capitalize-headings/src/index.ts:12](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/remark-capitalize-headings/src/index.ts#L12) +[packages/remark-capitalize-headings/src/index.ts:12](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/remark-capitalize-headings/src/index.ts#L12) ## Functions diff --git a/packages/remark-ignore/README.md b/packages/remark-ignore/README.md index 13970f2..e0f8530 100644 --- a/packages/remark-ignore/README.md +++ b/packages/remark-ignore/README.md @@ -1,14 +1,12 @@ -[![Black Lives Matter!][badge-blm]][link-blm] -[![Maintenance status][badge-maintenance]][link-repo] -[![Last commit timestamp][badge-last-commit]][link-repo] -[![Open issues][badge-issues]][link-issues] -[![Pull requests][badge-pulls]][link-pulls] -[![Codecov][badge-codecov]][link-codecov] -[![Source license][badge-license]][link-license] -[![NPM version][badge-npm]][link-npm] -[![Uses Semantic Release!][badge-semantic-release]][link-semantic-release] +[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link] +[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link] +[![Codecov][x-badge-codecov-image]][x-badge-codecov-link] +[![Source license][x-badge-license-image]][x-badge-license-link] +[![Monthly Downloads][x-badge-downloads-image]][x-badge-npm-link] +[![NPM version][x-badge-npm-image]][x-badge-npm-link] +[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link] @@ -166,7 +164,7 @@ export default { ## API -Detailed interface information can be found under [`docs/`][docs]. +Detailed interface information can be found under [`docs/`][x-repo-docs]. ## Examples @@ -307,57 +305,53 @@ Then running that same JavaScript would output: ## Contributing and Support -**[New issues][choose-new-issue] and [pull requests][pr-compare] are always -welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 this -project][link-repo] to let me know you found it useful! ✊🏿 Thank you! +**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare] +are always welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 +this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Thank +you! -See [CONTRIBUTING.md][contributing] and [SUPPORT.md][support] for more -information. +See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for +more information. ### Contributors -See the [table of contributors][15]. +See the [table of contributors][x-repo-contributors]. -[badge-blm]: https://xunn.at/badge-blm 'Join the movement!' -[badge-codecov]: - https://codecov.io/gh/Xunnamius/unified-utils/branch/main/graph/badge.svg?token=HWRIOBAAPW +[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!' +[x-badge-blm-link]: https://xunn.at/donate-blm +[x-badge-codecov-image]: + https://img.shields.io/codecov/c/github/Xunnamius/unified-utils/main?style=flat-square&token=HWRIOBAAPW 'Is this package well-tested?' -[badge-issues]: - https://img.shields.io/github/issues/Xunnamius/unified-utils - 'Open issues' -[badge-last-commit]: - https://img.shields.io/github/last-commit/xunnamius/unified-utils +[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/unified-utils +[x-badge-downloads-image]: + https://img.shields.io/npm/dm/remark-ignore?style=flat-square + 'Number of times this package has been downloaded per month' +[x-badge-lastcommit-image]: + https://img.shields.io/github/last-commit/xunnamius/unified-utils?style=flat-square 'Latest commit timestamp' -[badge-license]: - https://img.shields.io/npm/l/remark-ignore +[x-badge-license-image]: + https://img.shields.io/npm/l/remark-ignore?style=flat-square "This package's source license" -[badge-maintenance]: - https://img.shields.io/maintenance/active/2023 - 'Is this package maintained?' -[badge-npm]: - https://api.ergodark.com/badges/npm-pkg-version/remark-ignore - 'Install this package using npm or yarn!' -[badge-pulls]: - https://img.shields.io/github/issues-pr/xunnamius/unified-utils - 'Open pull requests' -[badge-semantic-release]: - https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - 'This repo practices continuous integration and deployment!' -[choose-new-issue]: https://github.com/xunnamius/unified-utils/issues/new/choose -[contributing]: /CONTRIBUTING.md -[docs]: docs -[link-blm]: https://xunn.at/donate-blm -[link-codecov]: https://codecov.io/gh/Xunnamius/unified-utils -[link-issues]: https://github.com/Xunnamius/unified-utils/issues?q= -[link-license]: +[x-badge-license-link]: https://github.com/Xunnamius/unified-utils/blob/main/packages/remark-ignore/LICENSE -[link-npm]: https://www.npmjs.com/package/remark-ignore -[link-pulls]: https://github.com/xunnamius/unified-utils/pulls -[link-repo]: +[x-badge-npm-image]: + https://xunn.at/npm-pkg-version/remark-ignore + 'Install this package using npm or yarn!' +[x-badge-npm-link]: https://www.npmjs.com/package/remark-ignore +[x-badge-repo-link]: https://github.com/xunnamius/unified-utils/blob/main/packages/remark-ignore -[link-semantic-release]: https://github.com/semantic-release/semantic-release -[pr-compare]: https://github.com/xunnamius/unified-utils/compare -[support]: /.github/SUPPORT.md +[x-badge-semanticrelease-image]: + https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square + 'This repo practices continuous integration and deployment!' +[x-badge-semanticrelease-link]: + https://github.com/semantic-release/semantic-release +[x-repo-choose-new-issue]: + https://github.com/xunnamius/unified-utils/issues/new/choose +[x-repo-contributing]: /CONTRIBUTING.md +[x-repo-contributors]: /README.md#contributors +[x-repo-docs]: docs +[x-repo-pr-compare]: https://github.com/xunnamius/unified-utils/compare +[x-repo-support]: /.github/SUPPORT.md [1]: https://github.com/unifiedjs/unified [2]: https://github.com/remarkjs/remark [3]: https://prettier.io/docs/en/ignore.html#javascript @@ -374,4 +368,3 @@ See the [table of contributors][15]. [12]: https://github.com/unifiedjs/unified#overview [13]: https://github.com/syntax-tree/mdast-comment-marker [14]: https://github.com/syntax-tree/mdast-zone -[15]: /README.md#contributors diff --git a/packages/remark-ignore/docs/modules/end.md b/packages/remark-ignore/docs/modules/end.md index 2b9307a..8889b18 100644 --- a/packages/remark-ignore/docs/modules/end.md +++ b/packages/remark-ignore/docs/modules/end.md @@ -54,4 +54,4 @@ node with all hidden child nodes revealed. #### Defined in -[packages/remark-ignore/src/end.ts:18](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/remark-ignore/src/end.ts#L18) +[packages/remark-ignore/src/end.ts:18](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/remark-ignore/src/end.ts#L18) diff --git a/packages/remark-ignore/docs/modules/start.md b/packages/remark-ignore/docs/modules/start.md index 36bd48c..f0af526 100644 --- a/packages/remark-ignore/docs/modules/start.md +++ b/packages/remark-ignore/docs/modules/start.md @@ -57,4 +57,4 @@ node with all child nodes following an ignore command having been hidden. #### Defined in -[packages/remark-ignore/src/start.ts:23](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/remark-ignore/src/start.ts#L23) +[packages/remark-ignore/src/start.ts:23](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/remark-ignore/src/start.ts#L23) diff --git a/packages/remark-lint-fenced-code-flag-case/README.md b/packages/remark-lint-fenced-code-flag-case/README.md index ad4ebdd..ff36b11 100644 --- a/packages/remark-lint-fenced-code-flag-case/README.md +++ b/packages/remark-lint-fenced-code-flag-case/README.md @@ -1,14 +1,12 @@ -[![Black Lives Matter!][badge-blm]][link-blm] -[![Maintenance status][badge-maintenance]][link-repo] -[![Last commit timestamp][badge-last-commit]][link-repo] -[![Open issues][badge-issues]][link-issues] -[![Pull requests][badge-pulls]][link-pulls] -[![Codecov][badge-codecov]][link-codecov] -[![Source license][badge-license]][link-license] -[![NPM version][badge-npm]][link-npm] -[![Uses Semantic Release!][badge-semantic-release]][link-semantic-release] +[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link] +[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link] +[![Codecov][x-badge-codecov-image]][x-badge-codecov-link] +[![Source license][x-badge-license-image]][x-badge-license-link] +[![Monthly Downloads][x-badge-downloads-image]][x-badge-npm-link] +[![NPM version][x-badge-npm-image]][x-badge-npm-link] +[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link] @@ -129,7 +127,7 @@ export default { ## API -Detailed interface information can be found under [`docs/`][docs]. +Detailed interface information can be found under [`docs/`][x-repo-docs]. ### Options @@ -239,57 +237,54 @@ const str = 'string'; ## Contributing and Support -**[New issues][choose-new-issue] and [pull requests][pr-compare] are always -welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 this -project][link-repo] to let me know you found it useful! ✊🏿 Thank you! +**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare] +are always welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 +this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Thank +you! -See [CONTRIBUTING.md][contributing] and [SUPPORT.md][support] for more -information. +See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for +more information. ### Contributors -See the [table of contributors][6]. +See the [table of contributors][x-repo-contributors]. -[badge-blm]: https://xunn.at/badge-blm 'Join the movement!' -[badge-codecov]: - https://codecov.io/gh/Xunnamius/unified-utils/branch/main/graph/badge.svg?token=HWRIOBAAPW +[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!' +[x-badge-blm-link]: https://xunn.at/donate-blm +[x-badge-codecov-image]: + https://img.shields.io/codecov/c/github/Xunnamius/unified-utils/main?style=flat-square&token=HWRIOBAAPW 'Is this package well-tested?' -[badge-issues]: - https://img.shields.io/github/issues/Xunnamius/unified-utils - 'Open issues' -[badge-last-commit]: - https://img.shields.io/github/last-commit/xunnamius/unified-utils +[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/unified-utils +[x-badge-downloads-image]: + https://img.shields.io/npm/dm/remark-lint-fenced-code-flag-case?style=flat-square + 'Number of times this package has been downloaded per month' +[x-badge-lastcommit-image]: + https://img.shields.io/github/last-commit/xunnamius/unified-utils?style=flat-square 'Latest commit timestamp' -[badge-license]: - https://img.shields.io/npm/l/remark-lint-fenced-code-flag-case +[x-badge-license-image]: + https://img.shields.io/npm/l/remark-lint-fenced-code-flag-case?style=flat-square "This package's source license" -[badge-maintenance]: - https://img.shields.io/maintenance/active/2023 - 'Is this package maintained?' -[badge-npm]: - https://api.ergodark.com/badges/npm-pkg-version/remark-lint-fenced-code-flag-case - 'Install this package using npm or yarn!' -[badge-pulls]: - https://img.shields.io/github/issues-pr/xunnamius/unified-utils - 'Open pull requests' -[badge-semantic-release]: - https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - 'This repo practices continuous integration and deployment!' -[choose-new-issue]: https://github.com/xunnamius/unified-utils/issues/new/choose -[contributing]: /CONTRIBUTING.md -[docs]: docs -[link-blm]: https://xunn.at/donate-blm -[link-codecov]: https://codecov.io/gh/Xunnamius/unified-utils -[link-issues]: https://github.com/Xunnamius/unified-utils/issues?q= -[link-license]: +[x-badge-license-link]: https://github.com/Xunnamius/unified-utils/blob/main/packages/remark-lint-fenced-code-flag-case/LICENSE -[link-npm]: https://www.npmjs.com/package/remark-lint-fenced-code-flag-case -[link-pulls]: https://github.com/xunnamius/unified-utils/pulls -[link-repo]: +[x-badge-npm-image]: + https://xunn.at/npm-pkg-version/remark-lint-fenced-code-flag-case + 'Install this package using npm or yarn!' +[x-badge-npm-link]: + https://www.npmjs.com/package/remark-lint-fenced-code-flag-case +[x-badge-repo-link]: https://github.com/xunnamius/unified-utils/blob/main/packages/remark-lint-fenced-code-flag-case -[link-semantic-release]: https://github.com/semantic-release/semantic-release -[pr-compare]: https://github.com/xunnamius/unified-utils/compare -[support]: /.github/SUPPORT.md +[x-badge-semanticrelease-image]: + https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square + 'This repo practices continuous integration and deployment!' +[x-badge-semanticrelease-link]: + https://github.com/semantic-release/semantic-release +[x-repo-choose-new-issue]: + https://github.com/xunnamius/unified-utils/issues/new/choose +[x-repo-contributing]: /CONTRIBUTING.md +[x-repo-contributors]: /README.md#contributors +[x-repo-docs]: docs +[x-repo-pr-compare]: https://github.com/xunnamius/unified-utils/compare +[x-repo-support]: /.github/SUPPORT.md [1]: https://github.com/remarkjs/remark-lint [2]: https://prettier.io/blog/2017/11/07/1.8.0.html#support-markdown-2943httpsgithubcomprettierprettierpull2943-by-ikatyanghttpsgithubcomikatyang @@ -298,4 +293,3 @@ See the [table of contributors][6]. https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-fenced-code-flag [5]: https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-fenced-code-marker -[6]: /README.md#contributors diff --git a/packages/remark-lint-fenced-code-flag-case/docs/README.md b/packages/remark-lint-fenced-code-flag-case/docs/README.md index 9c692fa..221d218 100644 --- a/packages/remark-lint-fenced-code-flag-case/docs/README.md +++ b/packages/remark-lint-fenced-code-flag-case/docs/README.md @@ -32,7 +32,7 @@ Options type for the remark-lint-fenced-code-flag-case plugin. #### Defined in -[packages/remark-lint-fenced-code-flag-case/src/index.ts:17](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/remark-lint-fenced-code-flag-case/src/index.ts#L17) +[packages/remark-lint-fenced-code-flag-case/src/index.ts:17](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/remark-lint-fenced-code-flag-case/src/index.ts#L17) ## Variables @@ -44,7 +44,7 @@ Valid values for the Options.case property. #### Defined in -[packages/remark-lint-fenced-code-flag-case/src/index.ts:12](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/remark-lint-fenced-code-flag-case/src/index.ts#L12) +[packages/remark-lint-fenced-code-flag-case/src/index.ts:12](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/remark-lint-fenced-code-flag-case/src/index.ts#L12) ## Functions diff --git a/packages/remark-lint-heading-word-length/README.md b/packages/remark-lint-heading-word-length/README.md index 5de666e..581a3bb 100644 --- a/packages/remark-lint-heading-word-length/README.md +++ b/packages/remark-lint-heading-word-length/README.md @@ -1,14 +1,12 @@ -[![Black Lives Matter!][badge-blm]][link-blm] -[![Maintenance status][badge-maintenance]][link-repo] -[![Last commit timestamp][badge-last-commit]][link-repo] -[![Open issues][badge-issues]][link-issues] -[![Pull requests][badge-pulls]][link-pulls] -[![Codecov][badge-codecov]][link-codecov] -[![Source license][badge-license]][link-license] -[![NPM version][badge-npm]][link-npm] -[![Uses Semantic Release!][badge-semantic-release]][link-semantic-release] +[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link] +[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link] +[![Codecov][x-badge-codecov-image]][x-badge-codecov-link] +[![Source license][x-badge-license-image]][x-badge-license-link] +[![Monthly Downloads][x-badge-downloads-image]][x-badge-npm-link] +[![NPM version][x-badge-npm-image]][x-badge-npm-link] +[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link] @@ -122,7 +120,7 @@ export default { ## API -Detailed interface information can be found under [`docs/`][docs]. +Detailed interface information can be found under [`docs/`][x-repo-docs]. ### Options @@ -191,60 +189,56 @@ No messages. ## Contributing and Support -**[New issues][choose-new-issue] and [pull requests][pr-compare] are always -welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 this -project][link-repo] to let me know you found it useful! ✊🏿 Thank you! +**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare] +are always welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 +this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Thank +you! -See [CONTRIBUTING.md][contributing] and [SUPPORT.md][support] for more -information. +See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for +more information. ### Contributors -See the [table of contributors][5]. +See the [table of contributors][x-repo-contributors]. -[badge-blm]: https://xunn.at/badge-blm 'Join the movement!' -[badge-codecov]: - https://codecov.io/gh/Xunnamius/unified-utils/branch/main/graph/badge.svg?token=HWRIOBAAPW +[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!' +[x-badge-blm-link]: https://xunn.at/donate-blm +[x-badge-codecov-image]: + https://img.shields.io/codecov/c/github/Xunnamius/unified-utils/main?style=flat-square&token=HWRIOBAAPW 'Is this package well-tested?' -[badge-issues]: - https://img.shields.io/github/issues/Xunnamius/unified-utils - 'Open issues' -[badge-last-commit]: - https://img.shields.io/github/last-commit/xunnamius/unified-utils +[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/unified-utils +[x-badge-downloads-image]: + https://img.shields.io/npm/dm/remark-lint-heading-word-length?style=flat-square + 'Number of times this package has been downloaded per month' +[x-badge-lastcommit-image]: + https://img.shields.io/github/last-commit/xunnamius/unified-utils?style=flat-square 'Latest commit timestamp' -[badge-license]: - https://img.shields.io/npm/l/remark-lint-heading-word-length +[x-badge-license-image]: + https://img.shields.io/npm/l/remark-lint-heading-word-length?style=flat-square "This package's source license" -[badge-maintenance]: - https://img.shields.io/maintenance/active/2023 - 'Is this package maintained?' -[badge-npm]: - https://api.ergodark.com/badges/npm-pkg-version/remark-lint-heading-word-length - 'Install this package using npm or yarn!' -[badge-pulls]: - https://img.shields.io/github/issues-pr/xunnamius/unified-utils - 'Open pull requests' -[badge-semantic-release]: - https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - 'This repo practices continuous integration and deployment!' -[choose-new-issue]: https://github.com/xunnamius/unified-utils/issues/new/choose -[contributing]: /CONTRIBUTING.md -[docs]: docs -[link-blm]: https://xunn.at/donate-blm -[link-codecov]: https://codecov.io/gh/Xunnamius/unified-utils -[link-issues]: https://github.com/Xunnamius/unified-utils/issues?q= -[link-license]: +[x-badge-license-link]: https://github.com/Xunnamius/unified-utils/blob/main/packages/remark-lint-heading-word-length/LICENSE -[link-npm]: https://www.npmjs.com/package/remark-lint-heading-word-length -[link-pulls]: https://github.com/xunnamius/unified-utils/pulls -[link-repo]: +[x-badge-npm-image]: + https://xunn.at/npm-pkg-version/remark-lint-heading-word-length + 'Install this package using npm or yarn!' +[x-badge-npm-link]: + https://www.npmjs.com/package/remark-lint-heading-word-length +[x-badge-repo-link]: https://github.com/xunnamius/unified-utils/blob/main/packages/remark-lint-heading-word-length -[link-semantic-release]: https://github.com/semantic-release/semantic-release -[pr-compare]: https://github.com/xunnamius/unified-utils/compare -[support]: /.github/SUPPORT.md +[x-badge-semanticrelease-image]: + https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square + 'This repo practices continuous integration and deployment!' +[x-badge-semanticrelease-link]: + https://github.com/semantic-release/semantic-release +[x-repo-choose-new-issue]: + https://github.com/xunnamius/unified-utils/issues/new/choose +[x-repo-contributing]: /CONTRIBUTING.md +[x-repo-contributors]: /README.md#contributors +[x-repo-docs]: docs +[x-repo-pr-compare]: https://github.com/xunnamius/unified-utils/compare +[x-repo-support]: /.github/SUPPORT.md [1]: https://github.com/remarkjs/remark-lint [2]: https://github.com/zerok/remark-lint-heading-length [3]: https://github.com/remarkjs/remark-lint#configure [4]: https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-maximum-heading-length -[5]: /README.md#contributors diff --git a/packages/remark-lint-heading-word-length/docs/README.md b/packages/remark-lint-heading-word-length/docs/README.md index caaaf2b..63850b1 100644 --- a/packages/remark-lint-heading-word-length/docs/README.md +++ b/packages/remark-lint-heading-word-length/docs/README.md @@ -29,7 +29,7 @@ Options type for the remark-lint-heading-word-length plugin. #### Defined in -[packages/remark-lint-heading-word-length/src/index.ts:14](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/remark-lint-heading-word-length/src/index.ts#L14) +[packages/remark-lint-heading-word-length/src/index.ts:14](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/remark-lint-heading-word-length/src/index.ts#L14) ## Functions diff --git a/packages/remark-lint-list-item-style/README.md b/packages/remark-lint-list-item-style/README.md index 9ffd78d..166beca 100644 --- a/packages/remark-lint-list-item-style/README.md +++ b/packages/remark-lint-list-item-style/README.md @@ -1,14 +1,12 @@ -[![Black Lives Matter!][badge-blm]][link-blm] -[![Maintenance status][badge-maintenance]][link-repo] -[![Last commit timestamp][badge-last-commit]][link-repo] -[![Open issues][badge-issues]][link-issues] -[![Pull requests][badge-pulls]][link-pulls] -[![Codecov][badge-codecov]][link-codecov] -[![Source license][badge-license]][link-license] -[![NPM version][badge-npm]][link-npm] -[![Uses Semantic Release!][badge-semantic-release]][link-semantic-release] +[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link] +[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link] +[![Codecov][x-badge-codecov-image]][x-badge-codecov-link] +[![Source license][x-badge-license-image]][x-badge-license-link] +[![Monthly Downloads][x-badge-downloads-image]][x-badge-npm-link] +[![NPM version][x-badge-npm-image]][x-badge-npm-link] +[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link] @@ -129,7 +127,7 @@ export default { ## API -Detailed interface information can be found under [`docs/`][docs]. +Detailed interface information can be found under [`docs/`][x-repo-docs]. ### Options @@ -525,57 +523,53 @@ Note the final error, which only occurs when a list item containing single ## Contributing and Support -**[New issues][choose-new-issue] and [pull requests][pr-compare] are always -welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 this -project][link-repo] to let me know you found it useful! ✊🏿 Thank you! +**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare] +are always welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 +this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Thank +you! -See [CONTRIBUTING.md][contributing] and [SUPPORT.md][support] for more -information. +See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for +more information. ### Contributors -See the [table of contributors][12]. +See the [table of contributors][x-repo-contributors]. -[badge-blm]: https://xunn.at/badge-blm 'Join the movement!' -[badge-codecov]: - https://codecov.io/gh/Xunnamius/unified-utils/branch/main/graph/badge.svg?token=HWRIOBAAPW +[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!' +[x-badge-blm-link]: https://xunn.at/donate-blm +[x-badge-codecov-image]: + https://img.shields.io/codecov/c/github/Xunnamius/unified-utils/main?style=flat-square&token=HWRIOBAAPW 'Is this package well-tested?' -[badge-issues]: - https://img.shields.io/github/issues/Xunnamius/unified-utils - 'Open issues' -[badge-last-commit]: - https://img.shields.io/github/last-commit/xunnamius/unified-utils +[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/unified-utils +[x-badge-downloads-image]: + https://img.shields.io/npm/dm/remark-lint-list-item-style?style=flat-square + 'Number of times this package has been downloaded per month' +[x-badge-lastcommit-image]: + https://img.shields.io/github/last-commit/xunnamius/unified-utils?style=flat-square 'Latest commit timestamp' -[badge-license]: - https://img.shields.io/npm/l/remark-lint-list-item-style +[x-badge-license-image]: + https://img.shields.io/npm/l/remark-lint-list-item-style?style=flat-square "This package's source license" -[badge-maintenance]: - https://img.shields.io/maintenance/active/2023 - 'Is this package maintained?' -[badge-npm]: - https://api.ergodark.com/badges/npm-pkg-version/remark-lint-list-item-style - 'Install this package using npm or yarn!' -[badge-pulls]: - https://img.shields.io/github/issues-pr/xunnamius/unified-utils - 'Open pull requests' -[badge-semantic-release]: - https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - 'This repo practices continuous integration and deployment!' -[choose-new-issue]: https://github.com/xunnamius/unified-utils/issues/new/choose -[contributing]: /CONTRIBUTING.md -[docs]: docs -[link-blm]: https://xunn.at/donate-blm -[link-codecov]: https://codecov.io/gh/Xunnamius/unified-utils -[link-issues]: https://github.com/Xunnamius/unified-utils/issues?q= -[link-license]: +[x-badge-license-link]: https://github.com/Xunnamius/unified-utils/blob/main/packages/remark-lint-list-item-style/LICENSE -[link-npm]: https://www.npmjs.com/package/remark-lint-list-item-style -[link-pulls]: https://github.com/xunnamius/unified-utils/pulls -[link-repo]: +[x-badge-npm-image]: + https://xunn.at/npm-pkg-version/remark-lint-list-item-style + 'Install this package using npm or yarn!' +[x-badge-npm-link]: https://www.npmjs.com/package/remark-lint-list-item-style +[x-badge-repo-link]: https://github.com/xunnamius/unified-utils/blob/main/packages/remark-lint-list-item-style -[link-semantic-release]: https://github.com/semantic-release/semantic-release -[pr-compare]: https://github.com/xunnamius/unified-utils/compare -[support]: /.github/SUPPORT.md +[x-badge-semanticrelease-image]: + https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square + 'This repo practices continuous integration and deployment!' +[x-badge-semanticrelease-link]: + https://github.com/semantic-release/semantic-release +[x-repo-choose-new-issue]: + https://github.com/xunnamius/unified-utils/issues/new/choose +[x-repo-contributing]: /CONTRIBUTING.md +[x-repo-contributors]: /README.md#contributors +[x-repo-docs]: docs +[x-repo-pr-compare]: https://github.com/xunnamius/unified-utils/compare +[x-repo-support]: /.github/SUPPORT.md [1]: https://github.com/remarkjs/remark-lint [2]: https://github.com/wemake-services/remark-lint-list-item-punctuation/tree/master @@ -593,4 +587,3 @@ See the [table of contributors][12]. https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-list-item-spacing [11]: https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-list-item-indent -[12]: /README.md#contributors diff --git a/packages/remark-lint-list-item-style/docs/README.md b/packages/remark-lint-list-item-style/docs/README.md index 039ad30..a7ff350 100644 --- a/packages/remark-lint-list-item-style/docs/README.md +++ b/packages/remark-lint-list-item-style/docs/README.md @@ -36,7 +36,7 @@ Options type for the remark-lint-list-item-style plugin. #### Defined in -[packages/remark-lint-list-item-style/src/index.ts:29](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/remark-lint-list-item-style/src/index.ts#L29) +[packages/remark-lint-list-item-style/src/index.ts:29](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/remark-lint-list-item-style/src/index.ts#L29) ## Variables @@ -48,7 +48,7 @@ Valid values for the Options.checkFirstWord property. #### Defined in -[packages/remark-lint-list-item-style/src/index.ts:14](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/remark-lint-list-item-style/src/index.ts#L14) +[packages/remark-lint-list-item-style/src/index.ts:14](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/remark-lint-list-item-style/src/index.ts#L14) ___ @@ -60,7 +60,7 @@ Valid values for the Options.checkListSpread property. #### Defined in -[packages/remark-lint-list-item-style/src/index.ts:19](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/remark-lint-list-item-style/src/index.ts#L19) +[packages/remark-lint-list-item-style/src/index.ts:19](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/remark-lint-list-item-style/src/index.ts#L19) ## Functions diff --git a/packages/remark-remove-unused-definitions/README.md b/packages/remark-remove-unused-definitions/README.md index e40f515..1003b00 100644 --- a/packages/remark-remove-unused-definitions/README.md +++ b/packages/remark-remove-unused-definitions/README.md @@ -1,14 +1,12 @@ -[![Black Lives Matter!][badge-blm]][link-blm] -[![Maintenance status][badge-maintenance]][link-repo] -[![Last commit timestamp][badge-last-commit]][link-repo] -[![Open issues][badge-issues]][link-issues] -[![Pull requests][badge-pulls]][link-pulls] -[![Codecov][badge-codecov]][link-codecov] -[![Source license][badge-license]][link-license] -[![NPM version][badge-npm]][link-npm] -[![Uses Semantic Release!][badge-semantic-release]][link-semantic-release] +[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link] +[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link] +[![Codecov][x-badge-codecov-image]][x-badge-codecov-link] +[![Source license][x-badge-license-image]][x-badge-license-link] +[![Monthly Downloads][x-badge-downloads-image]][x-badge-npm-link] +[![NPM version][x-badge-npm-image]][x-badge-npm-link] +[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link] @@ -124,7 +122,7 @@ export default { ## API -Detailed interface information can be found under [`docs/`][docs]. +Detailed interface information can be found under [`docs/`][x-repo-docs]. ## Examples @@ -200,57 +198,54 @@ ascending order starting from `[1]`. ## Contributing and Support -**[New issues][choose-new-issue] and [pull requests][pr-compare] are always -welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 this -project][link-repo] to let me know you found it useful! ✊🏿 Thank you! +**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare] +are always welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 +this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Thank +you! -See [CONTRIBUTING.md][contributing] and [SUPPORT.md][support] for more -information. +See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for +more information. ### Contributors -See the [table of contributors][8]. +See the [table of contributors][x-repo-contributors]. -[badge-blm]: https://xunn.at/badge-blm 'Join the movement!' -[badge-codecov]: - https://codecov.io/gh/Xunnamius/unified-utils/branch/main/graph/badge.svg?token=HWRIOBAAPW +[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!' +[x-badge-blm-link]: https://xunn.at/donate-blm +[x-badge-codecov-image]: + https://img.shields.io/codecov/c/github/Xunnamius/unified-utils/main?style=flat-square&token=HWRIOBAAPW 'Is this package well-tested?' -[badge-issues]: - https://img.shields.io/github/issues/Xunnamius/unified-utils - 'Open issues' -[badge-last-commit]: - https://img.shields.io/github/last-commit/xunnamius/unified-utils +[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/unified-utils +[x-badge-downloads-image]: + https://img.shields.io/npm/dm/remark-remove-unused-definitions?style=flat-square + 'Number of times this package has been downloaded per month' +[x-badge-lastcommit-image]: + https://img.shields.io/github/last-commit/xunnamius/unified-utils?style=flat-square 'Latest commit timestamp' -[badge-license]: - https://img.shields.io/npm/l/remark-remove-unused-definitions +[x-badge-license-image]: + https://img.shields.io/npm/l/remark-remove-unused-definitions?style=flat-square "This package's source license" -[badge-maintenance]: - https://img.shields.io/maintenance/active/2023 - 'Is this package maintained?' -[badge-npm]: - https://api.ergodark.com/badges/npm-pkg-version/remark-remove-unused-definitions - 'Install this package using npm or yarn!' -[badge-pulls]: - https://img.shields.io/github/issues-pr/xunnamius/unified-utils - 'Open pull requests' -[badge-semantic-release]: - https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - 'This repo practices continuous integration and deployment!' -[choose-new-issue]: https://github.com/xunnamius/unified-utils/issues/new/choose -[contributing]: /CONTRIBUTING.md -[docs]: docs -[link-blm]: https://xunn.at/donate-blm -[link-codecov]: https://codecov.io/gh/Xunnamius/unified-utils -[link-issues]: https://github.com/Xunnamius/unified-utils/issues?q= -[link-license]: +[x-badge-license-link]: https://github.com/Xunnamius/unified-utils/blob/main/packages/remark-remove-unused-definitions/LICENSE -[link-npm]: https://www.npmjs.com/package/remark-remove-unused-definitions -[link-pulls]: https://github.com/xunnamius/unified-utils/pulls -[link-repo]: +[x-badge-npm-image]: + https://xunn.at/npm-pkg-version/remark-remove-unused-definitions + 'Install this package using npm or yarn!' +[x-badge-npm-link]: + https://www.npmjs.com/package/remark-remove-unused-definitions +[x-badge-repo-link]: https://github.com/xunnamius/unified-utils/blob/main/packages/remark-remove-unused-definitions -[link-semantic-release]: https://github.com/semantic-release/semantic-release -[pr-compare]: https://github.com/xunnamius/unified-utils/compare -[support]: /.github/SUPPORT.md +[x-badge-semanticrelease-image]: + https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square + 'This repo practices continuous integration and deployment!' +[x-badge-semanticrelease-link]: + https://github.com/semantic-release/semantic-release +[x-repo-choose-new-issue]: + https://github.com/xunnamius/unified-utils/issues/new/choose +[x-repo-contributing]: /CONTRIBUTING.md +[x-repo-contributors]: /README.md#contributors +[x-repo-docs]: docs +[x-repo-pr-compare]: https://github.com/xunnamius/unified-utils/compare +[x-repo-support]: /.github/SUPPORT.md [1]: https://github.com/unifiedjs/unified [2]: https://github.com/remarkjs/remark [3]: https://github.com/remarkjs/remark-gfm#what-is-this @@ -258,4 +253,3 @@ See the [table of contributors][8]. [5]: /packages/remark-renumber-references [6]: https://github.com/remarkjs/remark-reference-links [7]: /packages/remark-sort-definitions -[8]: /README.md#contributors diff --git a/packages/remark-remove-url-trailing-slash/README.md b/packages/remark-remove-url-trailing-slash/README.md index c4352f2..f471a0b 100644 --- a/packages/remark-remove-url-trailing-slash/README.md +++ b/packages/remark-remove-url-trailing-slash/README.md @@ -1,14 +1,12 @@ -[![Black Lives Matter!][badge-blm]][link-blm] -[![Maintenance status][badge-maintenance]][link-repo] -[![Last commit timestamp][badge-last-commit]][link-repo] -[![Open issues][badge-issues]][link-issues] -[![Pull requests][badge-pulls]][link-pulls] -[![Codecov][badge-codecov]][link-codecov] -[![Source license][badge-license]][link-license] -[![NPM version][badge-npm]][link-npm] -[![Uses Semantic Release!][badge-semantic-release]][link-semantic-release] +[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link] +[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link] +[![Codecov][x-badge-codecov-image]][x-badge-codecov-link] +[![Source license][x-badge-license-image]][x-badge-license-link] +[![Monthly Downloads][x-badge-downloads-image]][x-badge-npm-link] +[![NPM version][x-badge-npm-image]][x-badge-npm-link] +[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link] @@ -122,7 +120,7 @@ export default { ## API -Detailed interface information can be found under [`docs/`][docs]. +Detailed interface information can be found under [`docs/`][x-repo-docs]. ### Options @@ -228,57 +226,54 @@ Would output the following: ## Contributing and Support -**[New issues][choose-new-issue] and [pull requests][pr-compare] are always -welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 this -project][link-repo] to let me know you found it useful! ✊🏿 Thank you! +**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare] +are always welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 +this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Thank +you! -See [CONTRIBUTING.md][contributing] and [SUPPORT.md][support] for more -information. +See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for +more information. ### Contributors -See the [table of contributors][9]. +See the [table of contributors][x-repo-contributors]. -[badge-blm]: https://xunn.at/badge-blm 'Join the movement!' -[badge-codecov]: - https://codecov.io/gh/Xunnamius/unified-utils/branch/main/graph/badge.svg?token=HWRIOBAAPW +[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!' +[x-badge-blm-link]: https://xunn.at/donate-blm +[x-badge-codecov-image]: + https://img.shields.io/codecov/c/github/Xunnamius/unified-utils/main?style=flat-square&token=HWRIOBAAPW 'Is this package well-tested?' -[badge-issues]: - https://img.shields.io/github/issues/Xunnamius/unified-utils - 'Open issues' -[badge-last-commit]: - https://img.shields.io/github/last-commit/xunnamius/unified-utils +[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/unified-utils +[x-badge-downloads-image]: + https://img.shields.io/npm/dm/remark-remove-url-trailing-slash?style=flat-square + 'Number of times this package has been downloaded per month' +[x-badge-lastcommit-image]: + https://img.shields.io/github/last-commit/xunnamius/unified-utils?style=flat-square 'Latest commit timestamp' -[badge-license]: - https://img.shields.io/npm/l/remark-remove-url-trailing-slash +[x-badge-license-image]: + https://img.shields.io/npm/l/remark-remove-url-trailing-slash?style=flat-square "This package's source license" -[badge-maintenance]: - https://img.shields.io/maintenance/active/2023 - 'Is this package maintained?' -[badge-npm]: - https://api.ergodark.com/badges/npm-pkg-version/remark-remove-url-trailing-slash - 'Install this package using npm or yarn!' -[badge-pulls]: - https://img.shields.io/github/issues-pr/xunnamius/unified-utils - 'Open pull requests' -[badge-semantic-release]: - https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - 'This repo practices continuous integration and deployment!' -[choose-new-issue]: https://github.com/xunnamius/unified-utils/issues/new/choose -[contributing]: /CONTRIBUTING.md -[docs]: docs -[link-blm]: https://xunn.at/donate-blm -[link-codecov]: https://codecov.io/gh/Xunnamius/unified-utils -[link-issues]: https://github.com/Xunnamius/unified-utils/issues?q= -[link-license]: +[x-badge-license-link]: https://github.com/Xunnamius/unified-utils/blob/main/packages/remark-remove-url-trailing-slash/LICENSE -[link-npm]: https://www.npmjs.com/package/remark-remove-url-trailing-slash -[link-pulls]: https://github.com/xunnamius/unified-utils/pulls -[link-repo]: +[x-badge-npm-image]: + https://xunn.at/npm-pkg-version/remark-remove-url-trailing-slash + 'Install this package using npm or yarn!' +[x-badge-npm-link]: + https://www.npmjs.com/package/remark-remove-url-trailing-slash +[x-badge-repo-link]: https://github.com/xunnamius/unified-utils/blob/main/packages/remark-remove-url-trailing-slash -[link-semantic-release]: https://github.com/semantic-release/semantic-release -[pr-compare]: https://github.com/xunnamius/unified-utils/compare -[support]: /.github/SUPPORT.md +[x-badge-semanticrelease-image]: + https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square + 'This repo practices continuous integration and deployment!' +[x-badge-semanticrelease-link]: + https://github.com/semantic-release/semantic-release +[x-repo-choose-new-issue]: + https://github.com/xunnamius/unified-utils/issues/new/choose +[x-repo-contributing]: /CONTRIBUTING.md +[x-repo-contributors]: /README.md#contributors +[x-repo-docs]: docs +[x-repo-pr-compare]: https://github.com/xunnamius/unified-utils/compare +[x-repo-support]: /.github/SUPPORT.md [1]: https://github.com/unifiedjs/unified [2]: https://github.com/remarkjs/remark [3]: /packages/remark-renumber-references @@ -287,4 +282,3 @@ See the [table of contributors][9]. [6]: https://github.com/remarkjs/remark-lint [7]: /packages/remark-ignore [8]: https://github.com/unifiedjs/unified#overview -[9]: /README.md#contributors diff --git a/packages/remark-remove-url-trailing-slash/docs/README.md b/packages/remark-remove-url-trailing-slash/docs/README.md index a1922a3..849996c 100644 --- a/packages/remark-remove-url-trailing-slash/docs/README.md +++ b/packages/remark-remove-url-trailing-slash/docs/README.md @@ -28,7 +28,7 @@ Options type for the remark-remove-url-trailing-slash plugin. #### Defined in -[packages/remark-remove-url-trailing-slash/src/index.ts:11](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/remark-remove-url-trailing-slash/src/index.ts#L11) +[packages/remark-remove-url-trailing-slash/src/index.ts:11](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/remark-remove-url-trailing-slash/src/index.ts#L11) ## Functions diff --git a/packages/remark-renumber-references/README.md b/packages/remark-renumber-references/README.md index 9465910..bb1a36a 100644 --- a/packages/remark-renumber-references/README.md +++ b/packages/remark-renumber-references/README.md @@ -1,14 +1,12 @@ -[![Black Lives Matter!][badge-blm]][link-blm] -[![Maintenance status][badge-maintenance]][link-repo] -[![Last commit timestamp][badge-last-commit]][link-repo] -[![Open issues][badge-issues]][link-issues] -[![Pull requests][badge-pulls]][link-pulls] -[![Codecov][badge-codecov]][link-codecov] -[![Source license][badge-license]][link-license] -[![NPM version][badge-npm]][link-npm] -[![Uses Semantic Release!][badge-semantic-release]][link-semantic-release] +[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link] +[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link] +[![Codecov][x-badge-codecov-image]][x-badge-codecov-link] +[![Source license][x-badge-license-image]][x-badge-license-link] +[![Monthly Downloads][x-badge-downloads-image]][x-badge-npm-link] +[![NPM version][x-badge-npm-image]][x-badge-npm-link] +[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link] @@ -127,7 +125,7 @@ export default { ## API -Detailed interface information can be found under [`docs/`][docs]. +Detailed interface information can be found under [`docs/`][x-repo-docs]. ### Options @@ -341,57 +339,53 @@ will sort all your definitions in whatever order you choose. ## Contributing and Support -**[New issues][choose-new-issue] and [pull requests][pr-compare] are always -welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 this -project][link-repo] to let me know you found it useful! ✊🏿 Thank you! +**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare] +are always welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 +this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Thank +you! -See [CONTRIBUTING.md][contributing] and [SUPPORT.md][support] for more -information. +See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for +more information. ### Contributors -See the [table of contributors][10]. +See the [table of contributors][x-repo-contributors]. -[badge-blm]: https://xunn.at/badge-blm 'Join the movement!' -[badge-codecov]: - https://codecov.io/gh/Xunnamius/unified-utils/branch/main/graph/badge.svg?token=HWRIOBAAPW +[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!' +[x-badge-blm-link]: https://xunn.at/donate-blm +[x-badge-codecov-image]: + https://img.shields.io/codecov/c/github/Xunnamius/unified-utils/main?style=flat-square&token=HWRIOBAAPW 'Is this package well-tested?' -[badge-issues]: - https://img.shields.io/github/issues/Xunnamius/unified-utils - 'Open issues' -[badge-last-commit]: - https://img.shields.io/github/last-commit/xunnamius/unified-utils +[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/unified-utils +[x-badge-downloads-image]: + https://img.shields.io/npm/dm/remark-renumber-references?style=flat-square + 'Number of times this package has been downloaded per month' +[x-badge-lastcommit-image]: + https://img.shields.io/github/last-commit/xunnamius/unified-utils?style=flat-square 'Latest commit timestamp' -[badge-license]: - https://img.shields.io/npm/l/remark-renumber-references +[x-badge-license-image]: + https://img.shields.io/npm/l/remark-renumber-references?style=flat-square "This package's source license" -[badge-maintenance]: - https://img.shields.io/maintenance/active/2023 - 'Is this package maintained?' -[badge-npm]: - https://api.ergodark.com/badges/npm-pkg-version/remark-renumber-references - 'Install this package using npm or yarn!' -[badge-pulls]: - https://img.shields.io/github/issues-pr/xunnamius/unified-utils - 'Open pull requests' -[badge-semantic-release]: - https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - 'This repo practices continuous integration and deployment!' -[choose-new-issue]: https://github.com/xunnamius/unified-utils/issues/new/choose -[contributing]: /CONTRIBUTING.md -[docs]: docs -[link-blm]: https://xunn.at/donate-blm -[link-codecov]: https://codecov.io/gh/Xunnamius/unified-utils -[link-issues]: https://github.com/Xunnamius/unified-utils/issues?q= -[link-license]: +[x-badge-license-link]: https://github.com/Xunnamius/unified-utils/blob/main/packages/remark-renumber-references/LICENSE -[link-npm]: https://www.npmjs.com/package/remark-renumber-references -[link-pulls]: https://github.com/xunnamius/unified-utils/pulls -[link-repo]: +[x-badge-npm-image]: + https://xunn.at/npm-pkg-version/remark-renumber-references + 'Install this package using npm or yarn!' +[x-badge-npm-link]: https://www.npmjs.com/package/remark-renumber-references +[x-badge-repo-link]: https://github.com/xunnamius/unified-utils/blob/main/packages/remark-renumber-references -[link-semantic-release]: https://github.com/semantic-release/semantic-release -[pr-compare]: https://github.com/xunnamius/unified-utils/compare -[support]: /.github/SUPPORT.md +[x-badge-semanticrelease-image]: + https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square + 'This repo practices continuous integration and deployment!' +[x-badge-semanticrelease-link]: + https://github.com/semantic-release/semantic-release +[x-repo-choose-new-issue]: + https://github.com/xunnamius/unified-utils/issues/new/choose +[x-repo-contributing]: /CONTRIBUTING.md +[x-repo-contributors]: /README.md#contributors +[x-repo-docs]: docs +[x-repo-pr-compare]: https://github.com/xunnamius/unified-utils/compare +[x-repo-support]: /.github/SUPPORT.md [1]: https://github.com/unifiedjs/unified [2]: https://github.com/remarkjs/remark [3]: https://github.com/remarkjs/remark-gfm#what-is-this @@ -402,4 +396,3 @@ See the [table of contributors][10]. https://raw.githubusercontent.com/Xunnamius/unified-utils/main/packages/remark-renumber-references/README.md [8]: /.remarkrc.mjs [9]: /packages/remark-remove-unused-definitions -[10]: /README.md#contributors diff --git a/packages/remark-renumber-references/docs/README.md b/packages/remark-renumber-references/docs/README.md index 6e0d1c4..028ad7b 100644 --- a/packages/remark-renumber-references/docs/README.md +++ b/packages/remark-renumber-references/docs/README.md @@ -28,7 +28,7 @@ Options type for the remark-renumber-references plugin. #### Defined in -[packages/remark-renumber-references/src/index.ts:16](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/remark-renumber-references/src/index.ts#L16) +[packages/remark-renumber-references/src/index.ts:16](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/remark-renumber-references/src/index.ts#L16) ## Functions diff --git a/packages/remark-sort-definitions/README.md b/packages/remark-sort-definitions/README.md index 0aa12e6..1cd3b32 100644 --- a/packages/remark-sort-definitions/README.md +++ b/packages/remark-sort-definitions/README.md @@ -1,14 +1,12 @@ -[![Black Lives Matter!][badge-blm]][link-blm] -[![Maintenance status][badge-maintenance]][link-repo] -[![Last commit timestamp][badge-last-commit]][link-repo] -[![Open issues][badge-issues]][link-issues] -[![Pull requests][badge-pulls]][link-pulls] -[![Codecov][badge-codecov]][link-codecov] -[![Source license][badge-license]][link-license] -[![NPM version][badge-npm]][link-npm] -[![Uses Semantic Release!][badge-semantic-release]][link-semantic-release] +[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link] +[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link] +[![Codecov][x-badge-codecov-image]][x-badge-codecov-link] +[![Source license][x-badge-license-image]][x-badge-license-link] +[![Monthly Downloads][x-badge-downloads-image]][x-badge-npm-link] +[![NPM version][x-badge-npm-image]][x-badge-npm-link] +[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link] @@ -128,7 +126,7 @@ export default { ## API -Detailed interface information can be found under [`docs/`][docs]. +Detailed interface information can be found under [`docs/`][x-repo-docs]. ### Options @@ -265,57 +263,53 @@ reference ids flow through the document in ascending order starting from `[1]`. ## Contributing and Support -**[New issues][choose-new-issue] and [pull requests][pr-compare] are always -welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 this -project][link-repo] to let me know you found it useful! ✊🏿 Thank you! +**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare] +are always welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 +this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Thank +you! -See [CONTRIBUTING.md][contributing] and [SUPPORT.md][support] for more -information. +See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for +more information. ### Contributors -See the [table of contributors][10]. +See the [table of contributors][x-repo-contributors]. -[badge-blm]: https://xunn.at/badge-blm 'Join the movement!' -[badge-codecov]: - https://codecov.io/gh/Xunnamius/unified-utils/branch/main/graph/badge.svg?token=HWRIOBAAPW +[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!' +[x-badge-blm-link]: https://xunn.at/donate-blm +[x-badge-codecov-image]: + https://img.shields.io/codecov/c/github/Xunnamius/unified-utils/main?style=flat-square&token=HWRIOBAAPW 'Is this package well-tested?' -[badge-issues]: - https://img.shields.io/github/issues/Xunnamius/unified-utils - 'Open issues' -[badge-last-commit]: - https://img.shields.io/github/last-commit/xunnamius/unified-utils +[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/unified-utils +[x-badge-downloads-image]: + https://img.shields.io/npm/dm/remark-sort-definitions?style=flat-square + 'Number of times this package has been downloaded per month' +[x-badge-lastcommit-image]: + https://img.shields.io/github/last-commit/xunnamius/unified-utils?style=flat-square 'Latest commit timestamp' -[badge-license]: - https://img.shields.io/npm/l/remark-sort-definitions +[x-badge-license-image]: + https://img.shields.io/npm/l/remark-sort-definitions?style=flat-square "This package's source license" -[badge-maintenance]: - https://img.shields.io/maintenance/active/2023 - 'Is this package maintained?' -[badge-npm]: - https://api.ergodark.com/badges/npm-pkg-version/remark-sort-definitions - 'Install this package using npm or yarn!' -[badge-pulls]: - https://img.shields.io/github/issues-pr/xunnamius/unified-utils - 'Open pull requests' -[badge-semantic-release]: - https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - 'This repo practices continuous integration and deployment!' -[choose-new-issue]: https://github.com/xunnamius/unified-utils/issues/new/choose -[contributing]: /CONTRIBUTING.md -[docs]: docs -[link-blm]: https://xunn.at/donate-blm -[link-codecov]: https://codecov.io/gh/Xunnamius/unified-utils -[link-issues]: https://github.com/Xunnamius/unified-utils/issues?q= -[link-license]: +[x-badge-license-link]: https://github.com/Xunnamius/unified-utils/blob/main/packages/remark-sort-definitions/LICENSE -[link-npm]: https://www.npmjs.com/package/remark-sort-definitions -[link-pulls]: https://github.com/xunnamius/unified-utils/pulls -[link-repo]: +[x-badge-npm-image]: + https://xunn.at/npm-pkg-version/remark-sort-definitions + 'Install this package using npm or yarn!' +[x-badge-npm-link]: https://www.npmjs.com/package/remark-sort-definitions +[x-badge-repo-link]: https://github.com/xunnamius/unified-utils/blob/main/packages/remark-sort-definitions -[link-semantic-release]: https://github.com/semantic-release/semantic-release -[pr-compare]: https://github.com/xunnamius/unified-utils/compare -[support]: /.github/SUPPORT.md +[x-badge-semanticrelease-image]: + https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square + 'This repo practices continuous integration and deployment!' +[x-badge-semanticrelease-link]: + https://github.com/semantic-release/semantic-release +[x-repo-choose-new-issue]: + https://github.com/xunnamius/unified-utils/issues/new/choose +[x-repo-contributing]: /CONTRIBUTING.md +[x-repo-contributors]: /README.md#contributors +[x-repo-docs]: docs +[x-repo-pr-compare]: https://github.com/xunnamius/unified-utils/compare +[x-repo-support]: /.github/SUPPORT.md [1]: https://github.com/unifiedjs/unified [2]: https://github.com/remarkjs/remark [3]: https://github.com/remarkjs/remark-gfm#what-is-this @@ -326,4 +320,3 @@ See the [table of contributors][10]. [7]: https://en.wikipedia.org/wiki/Natural_sort_order [8]: /.remarkrc.mjs [9]: /packages/remark-remove-unused-definitions -[10]: /README.md#contributors diff --git a/packages/remark-sort-definitions/docs/README.md b/packages/remark-sort-definitions/docs/README.md index 9039a76..56d5cb4 100644 --- a/packages/remark-sort-definitions/docs/README.md +++ b/packages/remark-sort-definitions/docs/README.md @@ -28,7 +28,7 @@ Options type for the remark-sort-definitions plugin. #### Defined in -[packages/remark-sort-definitions/src/index.ts:12](https://github.com/Xunnamius/unified-utils/blob/34702e4/packages/remark-sort-definitions/src/index.ts#L12) +[packages/remark-sort-definitions/src/index.ts:12](https://github.com/Xunnamius/unified-utils/blob/82312c4/packages/remark-sort-definitions/src/index.ts#L12) ## Functions diff --git a/packages/remark-tight-comments/README.md b/packages/remark-tight-comments/README.md index f387994..cb016bc 100644 --- a/packages/remark-tight-comments/README.md +++ b/packages/remark-tight-comments/README.md @@ -1,14 +1,12 @@ -[![Black Lives Matter!][badge-blm]][link-blm] -[![Maintenance status][badge-maintenance]][link-repo] -[![Last commit timestamp][badge-last-commit]][link-repo] -[![Open issues][badge-issues]][link-issues] -[![Pull requests][badge-pulls]][link-pulls] -[![Codecov][badge-codecov]][link-codecov] -[![Source license][badge-license]][link-license] -[![NPM version][badge-npm]][link-npm] -[![Uses Semantic Release!][badge-semantic-release]][link-semantic-release] +[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link] +[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link] +[![Codecov][x-badge-codecov-image]][x-badge-codecov-link] +[![Source license][x-badge-license-image]][x-badge-license-link] +[![Monthly Downloads][x-badge-downloads-image]][x-badge-npm-link] +[![NPM version][x-badge-npm-image]][x-badge-npm-link] +[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link] @@ -119,7 +117,7 @@ export default { ## API -Detailed interface information can be found under [`docs/`][docs]. +Detailed interface information can be found under [`docs/`][x-repo-docs]. ## Examples @@ -134,57 +132,53 @@ See [mdast-util-tight-comments][7] for example outputs. ## Contributing and Support -**[New issues][choose-new-issue] and [pull requests][pr-compare] are always -welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 this -project][link-repo] to let me know you found it useful! ✊🏿 Thank you! +**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare] +are always welcome and greatly appreciated! 🀩** Just as well, you can [star 🌟 +this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Thank +you! -See [CONTRIBUTING.md][contributing] and [SUPPORT.md][support] for more -information. +See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for +more information. ### Contributors -See the [table of contributors][10]. +See the [table of contributors][x-repo-contributors]. -[badge-blm]: https://xunn.at/badge-blm 'Join the movement!' -[badge-codecov]: - https://codecov.io/gh/Xunnamius/unified-utils/branch/main/graph/badge.svg?token=HWRIOBAAPW +[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!' +[x-badge-blm-link]: https://xunn.at/donate-blm +[x-badge-codecov-image]: + https://img.shields.io/codecov/c/github/Xunnamius/unified-utils/main?style=flat-square&token=HWRIOBAAPW 'Is this package well-tested?' -[badge-issues]: - https://img.shields.io/github/issues/Xunnamius/unified-utils - 'Open issues' -[badge-last-commit]: - https://img.shields.io/github/last-commit/xunnamius/unified-utils +[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/unified-utils +[x-badge-downloads-image]: + https://img.shields.io/npm/dm/remark-tight-comments?style=flat-square + 'Number of times this package has been downloaded per month' +[x-badge-lastcommit-image]: + https://img.shields.io/github/last-commit/xunnamius/unified-utils?style=flat-square 'Latest commit timestamp' -[badge-license]: - https://img.shields.io/npm/l/remark-tight-comments +[x-badge-license-image]: + https://img.shields.io/npm/l/remark-tight-comments?style=flat-square "This package's source license" -[badge-maintenance]: - https://img.shields.io/maintenance/active/2023 - 'Is this package maintained?' -[badge-npm]: - https://api.ergodark.com/badges/npm-pkg-version/remark-tight-comments - 'Install this package using npm or yarn!' -[badge-pulls]: - https://img.shields.io/github/issues-pr/xunnamius/unified-utils - 'Open pull requests' -[badge-semantic-release]: - https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - 'This repo practices continuous integration and deployment!' -[choose-new-issue]: https://github.com/xunnamius/unified-utils/issues/new/choose -[contributing]: /CONTRIBUTING.md -[docs]: docs -[link-blm]: https://xunn.at/donate-blm -[link-codecov]: https://codecov.io/gh/Xunnamius/unified-utils -[link-issues]: https://github.com/Xunnamius/unified-utils/issues?q= -[link-license]: +[x-badge-license-link]: https://github.com/Xunnamius/unified-utils/blob/main/packages/remark-tight-comments/LICENSE -[link-npm]: https://www.npmjs.com/package/remark-tight-comments -[link-pulls]: https://github.com/xunnamius/unified-utils/pulls -[link-repo]: +[x-badge-npm-image]: + https://xunn.at/npm-pkg-version/remark-tight-comments + 'Install this package using npm or yarn!' +[x-badge-npm-link]: https://www.npmjs.com/package/remark-tight-comments +[x-badge-repo-link]: https://github.com/xunnamius/unified-utils/blob/main/packages/remark-tight-comments -[link-semantic-release]: https://github.com/semantic-release/semantic-release -[pr-compare]: https://github.com/xunnamius/unified-utils/compare -[support]: /.github/SUPPORT.md +[x-badge-semanticrelease-image]: + https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square + 'This repo practices continuous integration and deployment!' +[x-badge-semanticrelease-link]: + https://github.com/semantic-release/semantic-release +[x-repo-choose-new-issue]: + https://github.com/xunnamius/unified-utils/issues/new/choose +[x-repo-contributing]: /CONTRIBUTING.md +[x-repo-contributors]: /README.md#contributors +[x-repo-docs]: docs +[x-repo-pr-compare]: https://github.com/xunnamius/unified-utils/compare +[x-repo-support]: /.github/SUPPORT.md [1]: https://github.com/unifiedjs/unified [2]: https://github.com/remarkjs/remark [3]: https://github.com/all-contributors/all-contributors @@ -195,4 +189,3 @@ See the [table of contributors][10]. [7]: /packages/mdast-util-tight-comments/README.md#usage [8]: https://github.com/unifiedjs/unified#overview [9]: /packages/mdast-util-tight-comments -[10]: /README.md#contributors