badboy / mdbook-toc

A preprocessor for mdbook to add inline Table of Contents support.
Mozilla Public License 2.0
163 stars 20 forks source link

Not so clear on how to use this plugin #49

Closed GopherJ closed 11 months ago

GopherJ commented 11 months ago

I installed this plugin, updated book.toml then added marker to SUMMARY.md but nothing changes. summary is not updated automatically when I add new chapter.

perhaps the readme needs to be updated or I'm missing something?

joelouthan commented 11 months ago

@GopherJ hello! You have to manually build SUMMARY.md with chapters and links.

But, if in your book.toml you have the follow:

[build]
create-missing = true

Then whatever you put in your SUMMARY.md will automatically generate a file with the title of the link as the first line as h1.

Try it out.