Skip to main content

Enumerates your markdown headers, inside the md file

Project description

1. Enumerates the headers in a markdown file

Enumerate headers in markdown file.

1.1 Usage:

Run from the command line

markdown-enum inputFile.md outputFile.md

The script will parse someFile.md, add an enumeration to each header and output the result to the file named outputFile.md. All previously existing headers will be overriden. So a useful scenario is

markdown-enum inputFile.md inputFile.md

1.2 Install:

Requires python 3.

pip install enumerate-markdown

1.3 Assumed markdown syntax:

The markdown syntax assumed is the one used by mistune, called "Sane CommonMark"

https://mistune.readthedocs.io/en/latest/intro.html#sane-commonmark

But, with a fine twist: headings defined by a single - or single = are considered too. For example:

This is a heading
-
This is also a heading
=

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

enumerate-markdown-1.0.0.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

enumerate_markdown-1.0.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file enumerate-markdown-1.0.0.tar.gz.

File metadata

  • Download URL: enumerate-markdown-1.0.0.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.6.1 pkginfo/1.8.2 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.10

File hashes

Hashes for enumerate-markdown-1.0.0.tar.gz
Algorithm Hash digest
SHA256 7467556f06497c11fb5005b7a618b6961f5bfd9665cd615a80b9bdb0efa9b64a
MD5 476577bd3c27ed62519e50c9b15f4a64
BLAKE2b-256 a9f634288462bd03ffe870851a5b625795a7841c87ebe445be43f74c0588e52a

See more details on using hashes here.

File details

Details for the file enumerate_markdown-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: enumerate_markdown-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.6.1 pkginfo/1.8.2 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.10

File hashes

Hashes for enumerate_markdown-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e3d287ef0ca54220f05550dac914aaa5b82ca14c6f477a2e491201bb16e8a6ee
MD5 0ed902a98a74d949222c561c93a02233
BLAKE2b-256 21ebbefe7a9002fcef4edcbf8772c24f654c0c8ed3801b7479775af83a8b16de

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page