markdown-heading-numbering 0.1.0

CLI and pre-commit hook to add hierarchical numbering to Markdown headings.

markdown-heading-numbering

CLI formatter and pre-commit hook that adds hierarchical numbering to Markdown headings.

---

Table of Contents:

• 1. Installation
• 2. CLI Usage
• 3. Pre-commit Hook
• 4. Tests

---

1. Installation

pip install .

For development:

pip install -e .[dev]

2. CLI Usage

markdown-heading-numbering \
  --start-from-level 2 \
  --end-at-level 5 \
  --initial-numbering 1 \
  docs/README.md

Options:

• --start-from-level (int, default 2): first heading level to number.
• --end-at-level (int, default 6): last heading level to number (inclusive).
• --initial-numbering (int, default 1): starting value for the top-most numbered heading.

Any existing numbering is removed before the formatter applies the new sequence.

3. Pre-commit Hook

This repository ships a .pre-commit-hooks.yaml that points to the CLI. Add the hook to your .pre-commit-config.yaml:

- repo: https://github.com/jsh9/markdown-heading-numbering
  rev: <commit-or-tag>
  hooks:
    - id: markdown-heading-numbering
      args: ["--start-from-level", "2", "--end-at-level", "4"]

The hook shares the same options as the CLI and formats files in place.

4. Tests

pytest