https://github.com/samlau95/gitbook-plugin-section-numbering

[WIP] Automatically add section numbers to Gitbook SUMMARY.md
https://github.com/samlau95/gitbook-plugin-section-numbering

Last synced: 19 days ago
JSON representation

[WIP] Automatically add section numbers to Gitbook SUMMARY.md

• Host: GitHub
• URL: https://github.com/samlau95/gitbook-plugin-section-numbering
• Owner: SamLau95
• License: mit
• Created: 2018-01-06T06:46:33.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-06T21:42:42.000Z (about 7 years ago)
• Last Synced: 2024-12-05T13:07:00.456Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 34.2 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [WIP] Automatic Section Numbering in Gitbook Sidebar

**Note that this plugin is a work in progress and won't behave as expected.**

This plugin will take a `SUMMARY.md` that you've already written and add

section numbers in the generated Gitbook's sidebar.

For example, given this `SUMMARY.md` file:

```markdown

# Table of Contents

* [Read Me](/README.md)

* [Introduction](/introduction/README.md)

  * [Motivation](/introduction/Motivation.md)

  * [Getting Started](/introduction/Getting_Started.md)

* [Tutorial](/tutorial/README.md)

  * [Simple Widgets](/tutorial/Simple_Widgets.md)

  * [Interact](/tutorial/Interact.md)

```

This plugin will generate:

```markdown

# Table of Contents

* [1. Read Me](/README.md)

* [2. Introduction](/introduction/README.md)

  * [2.1 Motivation](/introduction/Motivation.md)

  * [2.2 Getting Started](/introduction/Getting_Started.md)

* [3. Tutorial](/tutorial/README.md)

  * [3.1 Simple Widgets](/tutorial/Simple_Widgets.md)

  * [3.2 Interact](/tutorial/Interact.md)

```