skills.rest
jey3dayo
jey3dayoCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

docs-write

Enforce consistent Markdown formatting and linting with Prettier and markdownlint-cli2.

6|1|Updated Dec 8, 2009
Search Tags:#documentation#markdown#prettier#docs#lint#format
One-click install
npx skills add https://github.com/jey3dayo/dotfiles --skill docs-write-jey3dayo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-write
Source: https://github.com/jey3dayo/dotfiles/tree/main/agents/skills-internal/docs-write/skills
Command: npx skills add https://github.com/jey3dayo/dotfiles --skill docs-write-jey3dayo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Markdown documentation consistency across the repository helps teams write and maintain docs with a unified style and reduced formatting drift.

Core Features & Use Cases

  • Enforces a consistent writing style and formatting across all Markdown files.
  • Validate against Prettier and markdownlint configurations to ensure formatting and linting quality.
  • Use cases include updating existing docs, adding new guides, and ensuring CI checks pass automatically.

Quick Start

Run the docs:fix and docs:format tasks to automatically fix and format Markdown docs.

Frequently Asked Questions about docs-write

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

FAQPage Schema
How do I standardize Markdown documentation style across a repository?▼

Standardize Markdown documentation by enforcing a consistent writing and formatting workflow that validates files against Prettier and markdownlint configurations to eliminate formatting drift.

How do I automatically fix Markdown formatting and linting errors?▼

Automatically fix Markdown formatting and linting errors by running the exposed Mise tasks, specifically docs:fix and docs:format, to apply prescribed style rules across all documentation files.

Does this documentation linting workflow require Prettier and markdownlint-cli2?▼

Yes, the documentation linting workflow requires and adheres to project tooling including Prettier and markdownlint-cli2 to ensure formatting and linting quality checks pass automatically.

What's the best way to ensure new Markdown guides pass CI formatting checks?▼

Ensure new Markdown guides pass CI checks by integrating a standardized workflow that applies Prettier and markdownlint rules, using Mise tasks like docs:format to automate validation before submission.

Can I use this to update existing docs without causing formatting drift?▼

Yes, you can update existing docs without formatting drift by applying the prescribed style and lint rules through automated Mise tasks, ensuring all modifications align with the unified repository standard.

Related Skills

Explore More Content & Communication Skills→
knowledgeislandsknowledgeislands

ki-authoring

Standardize Markdown and TOML formatting and audit documents against authoring conventions.

Official
Advanced
CERTCCCERTCC
21

format-markdown

Run markdownlint-cli2 to lint and auto-fix markdown files.

Official
Basic
taiidanitaiidani
1

mise

Install and manage tool versions with mise configuration files.

Community
Advanced
manastalukdarmanastalukdar
1

make-it-pretty

Automates code formatting and readability improvements using Prettier, Black, and Go fmt.

Community
Intermediate