Skip to content

A tool to add chapter numbers based on a toc.md and content files.

License

Notifications You must be signed in to change notification settings

TSchmiedlechner/DocFxChapterNumbers

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A hacked together tool to add chapter numbers to a toc.md file as it is used by docfx.

Usage:

Edit your toc.md file, reference content files as usual

For example:

# Content
## [Chapter 1 - Introduction](docs/chapter1.md)

Inside the content files add your headings as you would:

For example (inside chapter1.md from above):

# Chapter 1 - Introduction
## More Information
## Even more information

Run the tool from this repo, for example:

DocFxChapterNumbers.exe .\mydocs\toc.md .\output

The folder output will have the same (sub-)folders that mydocs had, containing the same files, but the headings in toc.md will be numbered as will be the headings in the content files that are referenced from toc.md.

For example:

# Content
## [1. Chapter 1 - Introduction](docs/chapter1.md)

and

# 1. Chapter 1 - Introduction
## 1.1. More Information
## 1.2. Even more information

About

A tool to add chapter numbers based on a toc.md and content files.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 100.0%