Format Markdown and MDX docs with Metabase style using Prettier.
npx skills add https://github.com/joshkellett87/useful-skills --skill docs-write-joshkellett87
Please help me install this Agent Skill. Skill: docs-write Source: https://github.com/joshkellett87/useful-skills/tree/main/docs-write Command: npx skills add https://github.com/joshkellett87/useful-skills --skill docs-write-joshkellett87
Documentation writing is often inconsistent and hard to follow. This skill provides a clear, user-focused approach aligned with Metabase style to standardize doc creation and editing across Markdown, MDX, and related formats.
Create or update a documentation file following the Metabase style guide, then run yarn prettier --write <file-path> to format it.
High-intent search queries and answers about installing and using this skill.
To format Markdown documentation consistently, you can apply a style guide to your draft and run a formatter like prettier. This standardizes typography, headings, links, and code formatting for user-focused docs.
The best way to write user-focused product documentation in MDX is to apply a standardized style guide during creation and editing, followed by automated formatting to ensure clarity and structural consistency.
Yes, this approach works for onboarding guides and API references. Applying style guidelines to these documentation types ensures standard structure, readable examples, and consistent formatting across various product materials.
Yes, you need prettier to format MDX files with a style guide. Running prettier ensures consistent typography, headings, links, and code formatting across your documentation after applying the style guidelines.
Standardizing documentation formatting across Markdown files prevents inconsistent and hard-to-follow docs. Applying a user-focused style guide improves readability, structure, and maintainability across all product documentation.
kryptobaseddevAutomate drafting and editing Markdown, MDX, README, and guide content per CLEO style guidelines.
hashicorpValidate HashiCorp documentation against the official style guide.
metabaseGenerate and edit Metabase documentation in Markdown and MDX formats.
ghalacticEnforce Google developer documentation style guide rules on technical writing.
