Skip to main content
Back to registry

markdown-documentation

aj-geddes/useful-ai-prompts

Master markdown syntax and best practices for creating well-formatted, readable documentation using standard Markdown and GitHub Flavored Markdown (GFM).

Installs443
Install command
npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill markdown-documentation
Security audits
Gen Agent Trust HubPASS
SocketPASS
SnykPASS
About this skill
Master markdown syntax and best practices for creating well-formatted, readable documentation using standard Markdown and GitHub Flavored Markdown (GFM). Detailed implementations in the references/ directory: - Overview - When to Use - Quick Start - Reference Guides - Best Practices - README files - Documentation pages - GitHub/GitLab wikis - Blog posts - Technical writing - Project documentation - Comment formatting - Comment formatting - Use descriptive link text - Include table of contents for long documents - Add alt text to images - Use code blocks with language specification - Keep lines under 80-100 characters - Use relative links for internal docs - Add badges for build status, coverage, etc. - Include examples and screenshots - Use semantic line breaks - Test all links regularly - Use "click here" as link text - Forget alt text on images - Mix HTML and Markdown unnecessarily - Use absolute paths for local files - Create walls of text without breaks - Skip language specification in code blocks - Use images for text content (accessibility)

Source description provided by the upstream skill listing. Community reviews and install context appear in the sections below.

Community Reviews

Latest reviews

Sign in to review

No community reviews yet. Be the first to review.

Browse this skill in context
FAQ
What does markdown-documentation do?

Master markdown syntax and best practices for creating well-formatted, readable documentation using standard Markdown and GitHub Flavored Markdown (GFM).

Is markdown-documentation good?

markdown-documentation does not have approved reviews yet, so SkillJury cannot publish a community verdict.

What agent does markdown-documentation work with?

markdown-documentation currently lists compatibility with codex, gemini-cli, opencode, cursor, amp, github-copilot.

What are alternatives to markdown-documentation?

Skills in the same category include telegram-bot-builder, flutter-app-size, sharp-edges, iterative-retrieval.

How do I install markdown-documentation?

npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill markdown-documentation

Related skills

More from aj-geddes/useful-ai-prompts

Related skills

Alternatives in Software Engineering