Giter Club home page Giter Club logo

jekyll-numbered-headings's Introduction

Jekyll::NumberedHeadings

Simple jekyll pre_render hook to add ordered number to headings.

Requirement

It's tested only on jekyll 3.3.1.

Installation

Add this line to your application's Gemfile:

gem 'jekyll-numbered-headings'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-numbered-headings

Then, add to your _config.yml:

gems:
  - jekyll-numbered-headings

Usage

You can use following syntax on your pages, posts, and collections.

##1. At first

###1. One thing

###1. Another thing

##1. Second

##1. Third

will be replaced to:

## 1. At first

### 1.1. One thing

### 1.2. Another thing

## 2. Second

## 3. Third

That's it!

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/muratayusuke/jekyll-numbered-headings. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

jekyll-numbered-headings's People

Contributors

muratayusuke avatar

Stargazers

Casey Weed avatar Hokuto Hoshi avatar Kishorekumar Neelamegam avatar Kevin Kessler avatar  avatar  avatar

Watchers

 avatar James Cloos avatar

jekyll-numbered-headings's Issues

Breaks links to headings

This plugin is great, but it breaks any links to headings. E.g.:

##1. My Heading

<!-- This link won't work, because the actual anchor is now 1-my-heading -->
[link to My Heading](#my-heading)

Workaround is to manually create anchors for sections you want to link to, or include the heading number in the link, but that option is brittle as it changes when you add headings.

I think the fix would require modifying the HTML instead of the markdown with a :post_convert hook, but it would definitely add some complexity, and would result in e.g. Kramdown's {:toc} not including the heading numbers in its output. As-is, {:toc} works fine with this plugin.

This could be done with CSS instead, but would also not include the heading numbers in {:toc} without it being adapted.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.