Static Site Generators

How to Structure an MkDocs Repository to host multiple Docs

In this post, I’ll walk you through how I set up multiple product documentations within a single GitHub repository. Here’s what I’ll cover: Creating a single repository to host multiple product documentations Setting up a shared assets folder (for images, files, and text snippets) Optional: Using variables to switch assets based on the selected product Optional: Creating a central batch file to serve one or more product documentations at once Keep in mind that this is just one approach to managing multiple projects in a single repository—other methods may suit different needs.

Thursday, December 12, 2024 | 8 minutes Read

Index Websites with Google Search Console

In this post I’d like to show you how to use the Google Search Console to index your website. The Google Search Console offers tools and reports to help you measure your site’s search traffic and performance, fix issues, and improve Google Search results. For a website to show up in a search engines (e.g. Google, Bing, etc.), the website needs to be indexed by the search engine. This can take between a few days, weeks to even months if indexing is not explicitly requested using the Google Search Console.

Saturday, August 10, 2024 | 3 minutes Read

Auto-Generate Markdown Content Using Power Automate

In this post I’d like to show you how to use Microsoft Power Automate to generate markdown content for your MkDocs project. Power Automate is a cloud-based process automation service that can be used to create automated workflows to synchronize and collect data, get notifications, start approvals, and more. About this Use Case There are multiple reasons to automate content creation. In our case, we wanted to make it easier for non-developers to publish news in the “Latest News” section of our HelpCenter, see screenshot below.

Tuesday, May 7, 2024 | 5 minutes Read

Migrating from Jekyll to MkDocs

Our company (or rather I as the technical writer responsible for our documentation) recently decided to say goodbye to our current solution for creating documentation: Jekyll. Instead, we are now working on migrating our existing content to MkDocs. In this post I want to tell you a little bit about the reasons behind this decision. Status Quo Currently, we still use Jekyll 3 to build our documentation. Jekyll is a static site generator that uses static Markdown files and converts them to a website.

Saturday, April 20, 2024 | 4 minutes Read