skills.rest
xiaolai
xiaolaiCOMMUNITY
Explore all skills by this author →
Website𝕏@xiaolaiGitHub

fw-plain-markdown

Map plain Markdown projects to a consistent documentation layout and navigation.

6|Updated Feb 28, 2026
Search Tags:#templates#documentation#markdown#framework#conventions#docs#mapping
One-click install
npx skills add https://github.com/xiaolai/docs-guardian-for-claude --skill fw-plain-markdown
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: fw-plain-markdown
Source: https://github.com/xiaolai/docs-guardian-for-claude/tree/main/skills/docs-guardian/frameworks/plain-markdown
Command: npx skills add https://github.com/xiaolai/docs-guardian-for-claude --skill fw-plain-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Plain Markdown projects often lack a consistent structure and discovery mechanism when no framework is configured; this Skill provides a convention-based adapter that identifies plain Markdown layouts and standardizes their organization for automatic tooling.

Core Features & Use Cases

  • Detection of plain Markdown projects by presence of docs/ with .md files or README.md and absence of framework config files.
  • Definition of a conventional Doc Root and Directory Conventions to ensure predictable navigation and mapping.
  • Code-to-Doc Mapping guidance and a reusable Document Template to accelerate documentation generation.

Quick Start

Apply the plain Markdown framework adapter to organize your docs/ into the standard structure and begin mapping sources to docs.

Frequently Asked Questions about fw-plain-markdown

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

FAQPage Schema
How do I organize plain Markdown documentation without using a static site generator?▼

Plain Markdown projects can use convention-based adapters to map a docs/ directory or README.md into a standard layout, defining a predictable doc root and directory structure without heavy build tooling.

What is convention-based Markdown documentation mapping?▼

Convention-based Markdown mapping detects plain Markdown layouts via a docs/ directory or README.md, infers a doc root, and standardizes directory conventions for predictable navigation without framework configuration files.

Can I use this Markdown convention adapter for projects that only have a README.md file?▼

Yes, the adapter auto-detects plain Markdown projects using a standalone README.md or a docs/ directory with .md files, provided there are no framework config files present.

How do I map source code to Markdown docs using conventions?▼

You map source code to Markdown docs using provided code-to-doc mapping guidance and reusable document templates, applying conventional file organization rules to accelerate documentation generation.

When should I avoid using a convention-based Markdown layout?▼

Avoid this convention-based Markdown layout if your project already uses dedicated documentation framework config files, as it is designed exclusively for simple Markdown projects lacking an existing framework.

Related Skills

Explore More Software Engineering Skills→
lukoshkinlukoshkin
11

upd-docs

Map changed source files to relevant docs via aggregator indexes and dispatch parallel agents.

Community
Advanced
The-RabakThe-Rabak

compound-docs

Generate categorized Markdown entries with YAML frontmatter for solved problems.

Community
Advanced
kcenonkcenon
2

documentation

Enforce documentation standards for READMEs, API docs, and code comments.

Community
Basic
microsoftmicrosoft
2.9k

wiki-vitepress

Package wiki Markdown into a VitePress static site with dark theme and Mermaid diagrams.

Official
Advanced