For an overview of all available workflows, see the main README.
Run Markdown quality checks across all documentation files and get a prioritized issue report of violations
The Markdown Linter workflow runs the Super Linter tool on every Markdown file in your repository, then uses an AI agent to analyze the results and create a detailed GitHub issue listing each violation with suggested fixes. Only Markdown files are checked — other file types are unaffected.
# Install the 'gh aw' extension
gh extension install github/gh-aw
# Add the workflow to your repository
gh aw add-wizard githubnext/agentics/markdown-linterThis walks you through adding the workflow to your repository.
graph LR
A[Scheduled Trigger] --> B[Run Super Linter]
B --> C[Check Markdown Files]
C --> D{Violations Found?}
D -->|Yes| E[AI Analyzes Results]
E --> F[Create Issue Report]
D -->|No| G[Noop: All Clear]
The workflow runs in two jobs. The first job runs Super Linter to lint all Markdown files and uploads the log as an artifact. The second job (the AI agent) downloads that log, categorizes violations by severity, and creates a prioritized GitHub issue with recommended fixes. Previous issues expire after 2 days to avoid accumulation.
The workflow runs on weekdays at 2 PM UTC and can also be triggered manually via workflow_dispatch.
After editing run gh aw compile to update the workflow and commit all changes to the default branch.
By default only Markdown files are validated (VALIDATE_MARKDOWN: "true", VALIDATE_ALL_CODEBASE: "false"). To extend validation to other file types, add the appropriate VALIDATE_* environment variables to the Super Linter step. See the Super Linter documentation for a full list.