https://github.com/remarkjs/remark-heading-gap
plugin to adjust the gap between headings in markdown
https://github.com/remarkjs/remark-heading-gap
gap heading remark remark-plugin whitespace
Last synced: 18 days ago
JSON representation
plugin to adjust the gap between headings in markdown
- Host: GitHub
- URL: https://github.com/remarkjs/remark-heading-gap
- Owner: remarkjs
- License: mit
- Created: 2016-01-17T19:03:30.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2023-09-23T14:31:41.000Z (almost 2 years ago)
- Last Synced: 2025-06-01T05:48:53.472Z (28 days ago)
- Topics: gap, heading, remark, remark-plugin, whitespace
- Language: JavaScript
- Homepage: https://unified.js.org
- Size: 97.7 KB
- Stars: 6
- Watchers: 8
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# remark-heading-gap
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
**[remark][]** plugin to adjust the gap between headings in markdown.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`unified().use(remarkHeadingGap[, options])`](#unifieduseremarkheadinggap-options)
* [`Gap`](#gap)
* [`Options`](#options)
* [Examples](#examples)
* [Example: blank lines around first/last headings](#example-blank-lines-around-firstlast-headings)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)
## What is this?
This package is a [unified][] ([remark][]) plugin that lets you change the gap
(number of blank lines) between headings and surrounding text when formatting
markdown.
## When should I use this?
This project is useful when you want to adjust the gap around headings when
formatting markdown.
For example, when you want two blank lines before headings with a rank of 2
(`## Like so`).
From personal experience, adding extra blank lines helps visualize breaks in
sections, especially when quickly scanning documentation.
The default when serializing markdown with `remark-stringify` is to always
but a single blank line between blocks (headings, paragraphs, lists, code, etc).
## Install
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
```sh
npm install remark-heading-gap
```
In Deno with [`esm.sh`][esmsh]:
```js
import remarkHeadingGap from 'https://esm.sh/remark-heading-gap@6'
```
In browsers with [`esm.sh`][esmsh]:
```html
import remarkHeadingGap from 'https://esm.sh/remark-heading-gap@6?bundle'
```
## Use
Say we have the following file `example.md`:
```markdown
# Pluto
## Contents
## History
### Discovery
### Name and symbol
### Planet X disproved
## Orbit
```
…and a module `example.js`:
```js
import {remark} from 'remark'
import remarkHeadingGap from 'remark-heading-gap'
import {read} from 'to-vfile'
const file = await remark()
.use(remarkHeadingGap)
.process(await read('example.md'))
console.log(String(file))
```
…then running `node example.js` yields:
```markdown
# Pluto
## Contents
## History
### Discovery
### Name and symbol
### Planet X disproved
## Orbit
```
## API
This package exports no identifiers.
The default export is [`remarkHeadingGap`][api-remark-heading-gap].
### `unified().use(remarkHeadingGap[, options])`
Adjust the gap between headings.
There are no blank lines added if a heading is the first or last child of
the document, list item, or block quote.
For example, pass `{1: {before: 2, after: 2}}` to add two blank lines before
and after the main heading.
You can also set values to `0` to not add blank lines.
###### Parameters
* `options` ([`Options`][api-options], default: `{2: {before: 2}}`)
— configuration
###### Returns
Nothing (`undefined`).
### `Gap`
Gap between a heading (TypeScript type).
###### Fields
* `after` (`number`, default: `1`)
— blank lines after heading
* `before` (`number`, default: `1`)
— blank lines before heading
### `Options`
Configuration (TypeScript type).
###### Type
```ts
type Options = Partial>
```
## Examples
### Example: blank lines around first/last headings
This example shows that there are no blank lines added before the first and
after the last heading in a container.
Assuming we had `example.md` from before and changed it to contain this:
```markdown
# Alpha
Bravo charlie.
> ## Delta
>
> Echo foxtrott.
>
> ## Golf
```
Then configuring this plugin in `example.js` like so:
```diff
@@ -3,7 +3,10 @@ import remarkHeadingGap from 'remark-heading-gap'
import {read} from 'to-vfile'
const file = await remark()
- .use(remarkHeadingGap)
+ .use(remarkHeadingGap, {
+ 1: {after: 3, before: 3},
+ 2: {after: 2, before: 2}
+ })
.process(await read('example.md'))
console.log(String(file))
```
Then when running `node example.js` we’d get:
```markdown
# Alpha
Bravo charlie.
> ## Delta
>
>
> Echo foxtrott.
>
>
> ## Golf
```
## Types
This package is fully typed with [TypeScript][].
It exports the additional types [`Gap`][api-gap] and [`Options`][api-options].
## Compatibility
Projects maintained by the unified collective are compatible with maintained
versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, `remark-heading-gap@^6`,
compatible with Node.js 16.
This plugin works with `remark-stringify` version 9+ (`remark` version 13+).
Version 3 of this plugin worked with `remark-stringify` version 8- (`remark`
version 12-).
## Security
Use of `remark-heading-gap` does not involve **[rehype][]** (**[hast][]**) or
user content so there are no openings for [cross-site scripting
(XSS)][wiki-xss] attacks.
## Related
* [`remarkjs/remark-normalize-headings`](https://github.com/remarkjs/remark-normalize-headings)
— make sure there is a single top level heading in a document by adjusting
heading ranks accordingly
## Contribute
See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways
to get started.
See [`support.md`][support] for ways to get help.
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
## License
[MIT][license] © [Ben Briggs][author]
[build-badge]: https://github.com/remarkjs/remark-heading-gap/workflows/main/badge.svg
[build]: https://github.com/remarkjs/remark-heading-gap/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-heading-gap.svg
[coverage]: https://codecov.io/github/remarkjs/remark-heading-gap
[downloads-badge]: https://img.shields.io/npm/dm/remark-heading-gap.svg
[downloads]: https://www.npmjs.com/package/remark-heading-gap
[size-badge]: https://img.shields.io/bundlejs/size/remark-heading-gap
[size]: https://bundlejs.com/?q=remark-heading-gap
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[collective]: https://opencollective.com/unified
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/remarkjs/remark/discussions
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[health]: https://github.com/remarkjs/.github
[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md
[support]: https://github.com/remarkjs/.github/blob/main/support.md
[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md
[license]: license
[author]: http://beneb.info
[hast]: https://github.com/syntax-tree/hast
[rehype]: https://github.com/rehypejs/rehype
[remark]: https://github.com/remarkjs/remark
[typescript]: https://www.typescriptlang.org
[unified]: https://github.com/unifiedjs/unified
[wiki-xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
[api-gap]: #gap
[api-options]: #options
[api-remark-heading-gap]: #unifieduseremarkheadinggap-options