search

rust-lang / mdBook

Create book from markdown files. Like Gitbook but implemented in Rust
https://rust-lang.github.io/mdBook/
Mozilla Public License 2.0
17.84k stars 1.62k forks source link

Support include directives in SUMMARY.md #2429

Closed jplwill closed 1 month ago

jplwill commented 1 month ago

Problem

I have a tool that generates content for inclusion in an mdBook book; but not an entire mdBook. As a result, when I generate new content I have to update the SUMMARY.md file by hand.

Proposed Solution

The SUMMARY.md file should support the same {{#include file.md}} syntax as other markdown files do. Then a tool can generate a piece of a SUMMARY.md corresponding to the generated documentation content, and have it included in SUMMARY.md by mdbook build, using a mechanism that's already familiar to mdBook content creators.

Notes

No response

ehuss commented 1 month ago

Thanks for the report! Closing as a duplicate of #2287.

jplwill commented 1 month ago

I'm sorry, I looked for something like #2287 and didn't find it.