agentleFS
Sign inStart free
pantheon-orgpantheon-org/tekhne/skills/documentation/markdown-authoring/AGENTS.md

tekhne / markdown-authoring

AGENTS.md10 starsChanged 39 days agoMITView on GitHub

Complete markdown authoring and documentation guidance covering syntax, documentation structure, markdownlint configuration, CI/CD integration, and writing style. Markdown Syntax (syntax-): - references/syntax-headings.md - Heading levels, ATX vs setext, best practices - references/syntax-lists.md - Ordered, unordered, nested, and task lists - references/syntax-code-blocks.md - Fenced code blocks, language tags, inline code - references/syntax-links-images.md - Inline, reference, automatic links, images, alt text - references/syntax-formatting.md - Bold, italic, strikethrough, inline code formatting - references/syntax-other-elements.md - Blockquotes, tables, horizontal rules, HTML, escaping Documentation Structure (docs-):…

The file

We split this AGENTS.md into the rules it gives an agent

2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Read SKILL.md to understand when to apply markdown best practices

    line 19
  2. Distinctive:

    Start with syntax, then move to documentation structure, then linting

    line 22

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

markdown-authoring

Overview

Complete markdown authoring and documentation guidance covering syntax, documentation structure, markdownlint configuration, CI/CD integration, and writing style.

Structure

markdown-authoring/
  SKILL.md       # Main navigation hub
  AGENTS.md      # This file - navigation reference
  references/    # Detailed reference files by category
  evals/         # Evaluation scenarios

Usage

  1. Read SKILL.md to understand when to apply markdown best practices
  2. Navigate to categories based on your task
  3. Load reference files on-demand
  4. Start with syntax, then move to documentation structure, then linting

Reference Categories

PriorityCategoryImpactPrefix
1Markdown SyntaxCRITICALsyntax-
2Documentation StructureHIGHdocs-
3Linting ConfigurationHIGHlint-
4Linting IntegrationMEDIUMlint-

Available References

Markdown Syntax (syntax-):

  • references/syntax-headings.md - Heading levels, ATX vs setext, best practices
  • references/syntax-lists.md - Ordered, unordered, nested, and task lists
  • references/syntax-code-blocks.md - Fenced code blocks, language tags, inline code
  • references/syntax-links-images.md - Inline, reference, automatic links, images, alt text
  • references/syntax-formatting.md - Bold, italic, strikethrough, inline code formatting
  • references/syntax-other-elements.md - Blockquotes, tables, horizontal rules, HTML, escaping

Documentation Structure (docs-):

  • references/docs-readme.md - README structure, templates, and best practices
  • references/docs-api.md - REST, function, GraphQL, and CLI documentation patterns
  • references/docs-changelog.md - Keep a Changelog format and writing good entries
  • references/docs-organization.md - File naming, directory structure, navigation, cross-references
  • references/docs-writing-style.md - Active voice, conciseness, tone, audience considerations

Linting Configuration (lint-):

  • references/lint-config.md - Configuration files, hierarchy, inline comments, common patterns
  • references/lint-rules.md - All markdownlint rule categories and configuration examples

Linting Integration (lint-):

  • references/lint-cli.md - markdownlint-cli2 usage, npm scripts, monorepo setup
  • references/lint-ci.md - GitHub Actions, GitLab CI, CircleCI, Jenkins, Azure Pipelines, pre-commit hooks
  • references/lint-api.md - Programmatic API, custom rules, build tool integration

Consolidated from 4 original skills: markdown-documentation, markdown-syntax-fundamentals, markdownlint-configuration, markdownlint-integration. 16 reference files across 4 categories.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free