Add @it-service-npm/remark-heading-adjustment to list of plugins

[sergey-s-betke]

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and discussions and couldn’t find anything or linked relevant results below
• I made sure the docs are up to date
• I included tests (or that’s not needed)

Description of changes

Updated plugins list.

Added a new plugins:

• @it-service-npm/remark-heading-adjustment.
• @it-service-npm/remark-gfm-admonition.

@it-service-npm/remark-gfm-admonition extends Remark’s functionality,
enabling it to read GitHub admonitions from Markdown
and to write them back to Markdown files.

Also published:

• @it-service-npm/micromark-extension-gfm-admonition
• @it-service-npm/mdast-util-gfm-admonition

@it-service-npm/remark-heading-adjustment Remark plugin helps to adjust headings depth in markdown file.

When processor.data().topHeadingDepth is specified, this plugin adjusts all headings so that the depth of the top heading aligns with the given value.

This plugin can be used for dynamically change headings depth. Example: https://github.com/IT-Service-NPM/remark-include/blob/649937ef3eb87bc1b0f3bbe8e4a9a47509aba5fc/src/index.ts#L214C1-L226C1

The plugin also exports a preset called remarkAdjustTopHeadingToH1. This preset includes the remarkHeadingsAdjustment plugin with settings {topHeadingDepth: 1}.

These are meant for use in .remarkrc files and help normalize the depth of the top-level heading.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (b8f5045) to head (aa6ad1b).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #1479   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines          138       138           
=========================================
  Hits           138       138           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[remcohaszing]

I’m ok with adding @it-service-npm/remark-heading-adjustment. However, I oppose adding @it-service-npm/remark-gfm-admonition. GFM doesn’t have admonitions. GitHub’s rendering pipeline transforms certain HTML output into admonitions.

> [!NOTE]
> This is an admonition.

> \[!TIP]
> This is an admonition.

> [!TIP]
> This is a regular blockquote.

[!TIP]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

Yields:

Note

This is an admonition.

Tip

This is an admonition.

!TIP
This is a regular blockquote.

[sergey-s-betke]

I’m ok with adding @it-service-npm/remark-heading-adjustment.

Thank You. I'll change pull request.

However, I oppose adding @it-service-npm/remark-gfm-admonition. GFM doesn’t have admonitions. GitHub’s rendering pipeline transforms certain HTML output into admonitions.

Ok. I'll update my package for Your example. Thank You!

[sergey-s-betke]

@remcohaszing, @it-service-npm/remark-gfm-admonition removed from pull request.