#documentation #mdbook #summary #combine #multiple #markdown #md

app mdbook-combiner

a utility to combine mdbook summaries from multiple source into one mdbook

18 releases

0.2.0 Apr 27, 2023
0.1.17 Jun 7, 2024
0.1.16 May 24, 2024
0.1.14 May 3, 2023
0.1.13 Apr 28, 2023

#147 in Text processing

Download history 47/week @ 2024-07-29 4/week @ 2024-08-19 3/week @ 2024-09-09 14/week @ 2024-09-16 46/week @ 2024-09-23 10/week @ 2024-09-30 2/week @ 2024-10-07 44/week @ 2024-10-14 15/week @ 2024-10-21 23/week @ 2024-10-28 33/week @ 2024-11-04

115 downloads per month

MIT license

15KB
248 lines

mdbook Combiner

The utility aims to help solve the issue of an org having multiple mdbooks spread across repos but also want the option of producing a single mdbook for convenience and searchability of an entire orgs information.

Examples

In general, the tool expects to have a folder that contains several SUMMARY.md or subfolders that contain them. I have used the repo tool to clone multiple repos to construct this folder but its documentation is err not great so your mileage may vary. A shell script that calls clone would probably work as well.

You can then call the tool as such mdbook-combiner -m METAFOLDER this will now output a new SUMMARY.md that can be fed into mdbook to create a combined mdbook.

With unsorted markdown files

You can also use the -j flag to pass in folders containing markdown files, this will generate a SUMMARY for those files based on file location and add them into the combined output.

Dependencies

~12–22MB
~331K SLoC