Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jscarrott committed May 24, 2024
1 parent 738cafb commit 5adb8d9
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@

# 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.

The utilty 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.

## Notes
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.

Very early days
Hopefully will incorporate gitoxide at a later point to clone repos to extract mdbooks

## 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.

0 comments on commit 5adb8d9

Please sign in to comment.