check-mkdocs-task.md

"Check Website" workflow (MkDocs, Task)

Check for problems with a MkDocs-based static website.

This is the version of the workflow for projects using the Task task runner tool.

Installation

Workflow

Install the check-mkdocs-task.yml GitHub Actions workflow to .github/workflows/

Assets

• Taskfile.yml - Build task.
  • Install to: repository root (or merge into the existing Taskfile.yml).
• Taskfile.yml - Installation task.
  • Merge into Taskfile.yml
• .gitignore
  • Install to: repository root (or merge into the existing .gitignore).
• Website assets - See the "Deploy Website" (MkDocs, Poetry) workflow documentation.

Dependencies

See the "Deploy Website" (MkDocs, Poetry) workflow documentation

Configuration

Taskfile

Add any documentation generation processes to the docs:generate umbrella task.

MkDocs

See the "Deploy Website" (MkDocs, Poetry) workflow documentation

Readme badge

Markdown badge:

[![Check Website status](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-mkdocs-task.yml/badge.svg)](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-mkdocs-task.yml)

Replace the TODO_REPO_OWNER and TODO_REPO_NAME placeholders in the URLs with the final repository owner and name (example).

---

Asciidoc badge:

image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-mkdocs-task.yml/badge.svg["Check Website status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-mkdocs-task.yml"]

Define the {repository-owner} and {repository-name} attributes and use them throughout the readme (example).

Commit message

Add CI workflow to check for problems with MkDocs-based website

On every push or pull request that affects the source and configuration for the repository's MkDocs-based static
website, build the site and fail if any problems were encountered.

PR message

On every push or pull request that affects the source and configuration for the repository's [MkDocs](https://www.mkdocs.org/)-based static website, build the site and fail if any problems were encountered.