No commit activity in last 3 years
No release in over 3 years
Add section numbers to markdown headings.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.6
>= 0
 Project Readme

MarkdownSectionNumbering

MarkdownSectionNumbering adds section numbers to markdown headings written in "#" style.

Installation

Add this line to your application's Gemfile:

gem 'markdown_section_numbering'

And then execute:

$ bundle

Or install it yourself as:

$ gem install markdown_section_numbering

Usage

Basic

require "markdown_section_numbering"

markdown = <<MD
# a
## b

foo bar

## c

- list
- list
- list
MD

puts MarkdownSectionNumbering.convert(markdown)

This code produces the following results.

# 1 a
## 1.1 b

foo bar

## 1.2 c

- list
- list
- list

Re-numbering

Section numbers are replaced with new number.

Following markdown is going to be converted,

# foo
# 1 a
## 1.1 b
## bar
## 1.2 c

like this.

# 1 foo
# 2 a
## 2.1 b
## 2.2 bar
## 2.3 c

Contributing

  1. Fork it ( https://github.com/[my-github-username]/markdown_section_numbering/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request