mbdocsify-autoheaders v1.1.0

Getting started

Installation

1. Configure the docsify-autoHeaders:

<script>
window.$docsify = {
    autoHeading: {
        separator: '',
        levels:    '',
        scope:     ''
    },
};
</script>

2. Insert script into docsify document:

<script src="docsify-autoHeaders.js"></script>

Configuration

There are some options available for the docsify-autoHeaders:

Usage

At the top of your md files add the following snippet:

@autoHeader:

At the end of the identifier, add the section starting number. If you don't have that it won't auto number (good for pages not needing numbering).

You can :heart: have a starting header at 0 using:

@autoHeader:0

Example

@autoHeader:34

# Black Books

## Season 2

### Episode 1

#### Characters
- Bernard
- Fran

#### Quotes
You! What have you been telling Kate? She thinks I'm
the renaissance. I have to go along with all this
"reclusive genius" stuff... she's going to be very
upset when she finds out I'm a reclusive wanker.

Example output

Contributing

1. Clone the repo:

git clone https://github.com/markbattistella/docsify-autoHeadings.git

2. Create your feature branch: git checkout -b my-feature

3. Commit your changes: git commit -am 'Add some feature'

4. Push to the branch:

git push origin my-new-feature

5. Submit a pull request

Roadmap

• Allow custom separators
• Allow the scope to be either a class or ID
• Convert it to usable outside Docsify

Author: @me

• 🔭 I’m currently working on some secret projects
• 🌱 I’m learning
• 📫 Reach me: Twitter 🐦