Hi, I'm Eric.

I’m an avid world traveler, photographer, software developer, and digital storyteller.

I help implement the Content Authenticity Initiative at Adobe.

Search Results

mkdocs: Make a unified, searchable documentation set

Found on 5 July 2023 via Mastodon 450

via Christie Koehler: Oh! That reminds me to share something I’ve found super useful at work. If you’re in a situation where a team’s docs are in markdown spread across a bunch of git repos and you want a unified, searchable interface: mkdocs is your friend.

In a new git repo I add all the repos I want in the unified docs as git submodules. Them I use mkdocs to generate unified docs that I render with GH pages.

Doesn’t interfere with original docs at all.

MkDocs: Project documentation with Markdown

If you’ve enjoyed this …

Subscribe to my free and occasional (never more than weekly) e-mail newsletter with my latest travel and other stories:

Or follow me on one or more of the socials: