https://prule.github.io/pauls-blog/tags/documentation/Recent content in Documentation on Pauls BlogHugoen-usSun, 28 Jun 2026 22:14:08 +1000https://prule.github.io/pauls-blog/post/coding/2026/markdown-repo-to-mkdocs-book/Sun, 28 Jun 2026 00:00:00 +1000https://prule.github.io/pauls-blog/post/coding/2026/markdown-repo-to-mkdocs-book/<p>Convert flat Markdown files into a searchable MkDocs site by moving them into a <code>docs/</code> folder, adding a simple YAML config, and deploying via GitHub Actions.</p> <div class="notice info"> <div class="notice-title">INFO</div> <div class="notice-content"> While often referred to colloquially as a &ldquo;GitBook&rdquo;, we use MkDocs with the Material theme because it&rsquo;s open-source, highly customizable, and looks incredibly professional out of the box. </div> </div> <h3 id="1-reorganize-the-files">1. Reorganize the Files</h3> <p>Static site generators expect a specific directory structure. Move all your standalone <code>.md</code> files into a dedicated <code>docs/</code> folder. Your root <code>ReadMe.md</code> should be copied to <code>docs/index.md</code> to serve as the homepage.</p>