# remark-heading-shift

> This plugin increments headings by `shift`. It guards against shifting too far backwards or forwards.

Latest version **1.1.2** (published 2024-04-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install remark-heading-shift
pnpm add remark-heading-shift
yarn add remark-heading-shift
bun add remark-heading-shift
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2024-04-27 |
| First published | 2017-06-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 237 |
| Author | Victor Felder |
| Maintainers | situphen, talone |
| Keywords | remark |

## Links

- npm: https://www.npmjs.com/package/remark-heading-shift
- Repository: https://github.com/zestedesavoir/zmarkdown.git#master
- Homepage: https://github.com/zestedesavoir/zmarkdown/tree/master#readme
- Issues: https://github.com/zestedesavoir/zmarkdown/issues
- npm.io page: https://npm.io/package/remark-heading-shift

## Dependencies (1)

- [unist-util-visit](https://npm.io/package/unist-util-visit.md) ^2.0.3

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.1.2 (latest) — 2024-04-27
- 1.1.1 — 2021-02-14
- 1.1.0 — 2020-02-03
- 1.0.14 — 2019-07-27
- 1.0.13 — 2019-04-14
- 1.0.12 — 2019-02-04
- 1.0.11 — 2018-11-23
- 1.0.10 — 2018-10-04
- 1.0.9 — 2018-07-20
- 1.0.8 — 2018-03-06
- 1.0.7 — 2018-02-21
- 1.0.6 — 2018-01-20
- 1.0.5 — 2018-01-19
- 1.0.4 — 2018-01-13
- 1.0.3 — 2017-08-31
- … 14 more at https://npm.io/package/remark-heading-shift/versions

## README

# remark-heading-shift [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status]

This plugin increments headings by `shift`. It guards against shifting too far backwards or forwards.

`shift` defaults to `1`, it can be a positive or negative value, it will never shift a heading past `6` (because `h6` is the smallest HTML heading) in case of a positive `shift`, or lower than `1` (`h0` is not a valid HTML heading) in case of a negative `shift`.

For example, the following markdown:

    ## foo
    #### bar
    ##### baz

Yields:

    (shift=1)
    ### foo
    ##### bar
    ###### baz


    (shift=3)
    ##### foo
    ###### bar
    ###### baz


    (shift=-2)
    # foo
    ## bar
    ### baz

## License

[MIT][license] © [Zeste de Savoir][zds]

<!-- Definitions -->

[build-badge]: https://img.shields.io/travis/zestedesavoir/zmarkdown.svg

[build-status]: https://travis-ci.org/zestedesavoir/zmarkdown

[coverage-badge]: https://img.shields.io/coveralls/zestedesavoir/zmarkdown.svg

[coverage-status]: https://coveralls.io/github/zestedesavoir/zmarkdown

[license]: https://github.com/zestedesavoir/zmarkdown/blob/master/packages/remark-heading-shift/LICENSE-MIT

[zds]: https://zestedesavoir.com

---
_Source: https://npm.io/package/remark-heading-shift · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._