Skip to content

A ready-to-use soupault setup for creating books, comparable to mdBook

License

Notifications You must be signed in to change notification settings

PataphysicalSociety/soupault-blueprints-book

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

soupault-blueprints-book

A ready-to-use soupault setup for creating books, comparable to mdBook.

If you want to see a real book based on this blueprint, check out OCaml From the Ground Up.

Dependencies

You need soupault 5.0.0 or later to use this blueprint.

Adding chapters

The sidebar with a list of chapters is generated completely automatically. There's no need to write a ToC/summary of the book by hand.

Chapter numbers are taken from file names. In the sample setup, there are book/00_preface.md and book/01_sample_chapter.md.

Those numbers are also removed from output file paths, so you will get clean /preface/ and /sample_chapter URLs instead.

Configuring the book

The configuration file is soupault.toml.

Book title

You can set the title that appears in the HTML <title> by editing the [widgets.page-title] section in the config.

Modifying the sidebar ToC

The template for rendering the chapters index is in the widgets.chapters-index.index_template option.

About

A ready-to-use soupault setup for creating books, comparable to mdBook

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published