What are 'Magic Links' in Meldoc?

Magic links are a simplified internal linking syntax using double brackets, such as [[doc-alias]], which allows you to link between documents without managing complex relative paths.

How does the skill handle document organization?

It uses the parentAlias field in the frontmatter to establish logical hierarchies and project trees, ensuring that documentation remains organized as it scales.

Why does this skill avoid using H1 tags in the Markdown content?

In Meldoc, the document title is defined in the mandatory YAML frontmatter. To maintain proper hierarchy and SEO, the actual content should begin with an H2 heading.

Does this skill help with API documentation?

Yes, it includes specialized templates for API endpoints, including sections for methods, authentication, parameters, and example requests/responses.

Meldoc Documentation Writing

Name: Meldoc Documentation Writing
Author: meldoc-io

bymeldoc-io

0•

콘텐츠 관리

Streamlines the creation, structuring, and maintenance of professional technical documentation within the Meldoc ecosystem.

The Meldoc Documentation Writing skill provides Claude with expert-level guidance for managing technical content using the Meldoc format. It automates the generation of mandatory YAML frontmatter, enforces structural standards like H2-first hierarchies, and facilitates advanced features such as internal 'magic links' and Mermaid diagrams. This skill is essential for developers looking to maintain consistent, high-quality documentation projects, offering specialized templates for API references, feature guides, and tutorials while ensuring all content remains searchable and properly indexed through stable aliases.

주요 기능

01Pre-defined templates for API, Feature, and Tutorial documentation

020 GitHub stars

03Enforcement of Meldoc structural standards and H2-first hierarchy

04Integrated support for Mermaid diagrams and interactive task lists

05Support for internal magic links and cross-project referencing

06Automatic YAML frontmatter generation and validation

사용 사례

01Generating standardized API reference guides with curl examples

02Building and managing complex document hierarchies and parent-child trees

03Migrating legacy Markdown files to structured Meldoc documentation

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add meldoc-io/mcp-stdio-proxy documentation-writing

For use in Claude.ai and ChatGPT

Download Skill