# hexo-heading-numbering

> Automatically add numbered index for the headings in hexo post.

Latest version **1.0.1** (published 2021-04-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install hexo-heading-numbering
pnpm add hexo-heading-numbering
yarn add hexo-heading-numbering
bun add hexo-heading-numbering
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-04-26 |
| First published | 2021-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | deadblue |
| Maintainers | deadbluex |
| Keywords | hexo, plugin |

## Links

- npm: https://www.npmjs.com/package/hexo-heading-numbering
- Repository: https://github.com/deadblue/hexo-heading-numbering
- Homepage: https://github.com/deadblue/hexo-heading-numbering#readme
- Issues: https://github.com/deadblue/hexo-heading-numbering/issues
- npm.io page: https://npm.io/package/hexo-heading-numbering

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2021-04-26
- 1.0.0 — 2021-04-26

## README

# hexo-heading-numbering

![](https://img.shields.io/badge/Version-1.0.1-brightgreen?style=flat-square)
![](https://img.shields.io/badge/License-MIT-blue?style=flat-square)

Automatically add numbered index for the headings in hexo post.

## Example

Assume the post is:

```markdown
# Top heading
## Sub heading
## Another sub heading
# Another top heading
```

Then it will be rendered as:

```text
1 Top heading
1.1 Sub heading
1.2 Another sub heading
2 Another top heading
```

## Usage

1. Run following command in your blog directory.

```shell
npm install hexo-heading-numbering --save
```

2. Add following content in `_config.yml` (under blog root directory).

```yaml
heading_numbering:
  enable: true
  separator: "."
  prefix: ""
  suffix: " "
```

3. Clean and rebuild.

```shell
hexo cl && hexo g
```

## Support

Hexo v5.x (Tested on v5.4.0)

## License

MIT

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