Skip to main content

Build and publish documentations automatically on Github Pages

Categories
CI/CDDevOpsGitWorkflow
  • Post Author
    By Martin Pham
  • Post Date
    Wed Nov 03 2021

With any project you work on, especially an open source project, documentation should be one of the most important things to do. It helps the end-users understand how to use the application, it helps the new developers understand how to work with the project, …

With MkDocs, we can maintenance the documents easily. Just write documentations in Markdown, and it will build it into HTML static pages for you. Beside it, with the help from GitHub workflows, we can also build the documentations automatically on every push into our GIT repository.

I’d like to share with you my workflow to build documentations. It will listen for changes on documentation files (*.md), then build it and publish it into Github Pages.

Result

Here is an example repository using this workflow

https://github.com/ActionsHackathon21/build-documentations