skills.rest
pantheon-org
pantheon-orgOFFICIAL
Explore all skills by this author →
GitHub

markdown-authoring

Author lint-compliant Markdown documentation with deterministic structure and CI integration.

9|Updated Feb 21, 2026
Search Tags:#linting#documentation#markdown#style guide#readme#ci
One-click install
npx skills add https://github.com/pantheon-org/tekhne --skill markdown-authoring-pantheon-org
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: markdown-authoring
Source: https://github.com/pantheon-org/tekhne/tree/main/skills/documentation/markdown-authoring
Command: npx skills add https://github.com/pantheon-org/tekhne --skill markdown-authoring-pantheon-org

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the creation of well-structured, lint-compliant Markdown documentation, ensuring consistency and professionalism across all your written content.

Core Features & Use Cases

  • Deterministic Structure: Enforces consistent organization for READMEs, docs pages, and more.
  • Lint Compliance: Automatically checks and helps fix Markdown syntax and style violations.
  • CI Integration: Provides commands and guidance for integrating checks into pipelines.
  • Use Case: When writing a new README file for a project, use this Skill to ensure it follows best practices for structure, syntax, and linting.

Quick Start

Run the command bunx markdownlint-cli2 "**/*.md" to lint all Markdown files in the current directory.

Frequently Asked Questions about markdown-authoring

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I fix markdownlint failures in my README file?▼

To wire markdown checks into CI, integrate markdownlint-cli2 commands into your pre-commit hooks and pipeline configurations to automatically enforce documentation standards and block non-compliant commits.

What is the best way to structure a README file for consistency?▼

Yes, you can define custom markdown style rules by configuring markdownlint-cli2, allowing you to enforce specific syntax and structural guidelines tailored to your project's documentation requirements.

Do I need markdownlint-cli2 to enforce markdown style guide rules?▼

Yes, you need markdownlint-cli2 installed as a dependency to perform the linting checks and validate your markdown files against the defined style guide rules and structural standards.

How do I wire markdown checks into pre-commit and CI pipelines?▼

To wire markdown checks into CI, integrate markdownlint-cli2 commands into your pre-commit hooks and pipeline configurations to automatically enforce documentation standards and block non-compliant commits.

What is the best way to structure a README file for consistency?▼

The best way to structure a README is to enforce a deterministic organization that follows established documentation standards, ensuring consistent sections, syntax, and professional formatting across all project files.

Can I define custom markdown style guide rules for my documentation?▼

Yes, you can define custom markdown style rules by configuring markdownlint-cli2, allowing you to enforce specific syntax and structural guidelines tailored to your project's documentation requirements.

Related Skills

Explore More Content & Communication Skills→
mvillmowmvillmow
18

doc-validate-markdown

Validate Markdown formatting and style compliance with markdownlint.

Community
Intermediate
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate
tneztnez

install-git-hooks

Install a Git pre-commit hook that lints staged Markdown files with markdownlint-cli2.

Community
Intermediate
HomericIntelligenceHomericIntelligence
18

doc-validate-markdown

Validate markdown files for formatting, links, and style compliance using markdownlint-cli2.

Official
Basic