diff --git a/README.md b/README.md index 28215c0..e339606 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ # template-gh-pages-mkdocs -Template repository for provisioning a document repository with the happiness combo: __Mkdocs__ + __Github Actions__ + __GitHub Pages__. +Template repository for provisioning a document repository with the happiness combo: __MkDocs__ + __Github Actions__ + __GitHub Pages__. Each commit on the `main` branch triggers a [GitHub Action Pipeline](/.github/workflows/deploy-contents-to-github-pages.yml) that transpiles Markdown files to modern web static files with [MkDocs](https://github.com/mkdocs/mkdocs) and provides them via GitHub Pages.