pantheon-ai/markdown-authoring
Author high-quality Markdown documentation with deterministic structure, lint compliance, and CI integration. Use when writing README files, creating docs pages, fixing markdownlint failures, defining style rules, or wiring markdown checks into pre-commit and pipelines. Keywords: markdown, markdownlint, readme, docs, headings, lists, code fences, links, images, lint config, ci, documentation style.
Overall
score
100%
Does it follow best practices?
Validation for skill structure
docs-changelog.mdreferences/
Changelog Documentation
Keep a Changelog Format
Follow the Keep a Changelog specification:
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- New features that haven't been released yet
### Changed
- Changes in existing functionality
### Deprecated
- Soon-to-be removed features
### Removed
- Features that have been removed
### Fixed
- Bug fixes
### Security
- Vulnerability patches
## [1.0.0] - 2024-01-15
### Added
- Initial release
- User authentication
- Dashboard view
[Unreleased]: https://github.com/user/repo/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/user/repo/releases/tag/v1.0.0Changelog Sections
Section Order (Standard)
- Added - New features
- Changed - Changes in existing functionality
- Deprecated - Soon-to-be removed features
- Removed - Removed features
- Fixed - Bug fixes
- Security - Security updates
Writing Good Entries
## [1.2.0] - 2024-03-10
### Added
- User profile page with avatar upload (#234)
- Dark mode support for all components (#245)
- Export data to CSV functionality (#256)
### Changed
- Improved search performance by 40% (#267)
- Updated dependency `library-name` from v2.0 to v3.0 (#278)
### Fixed
- Fixed crash when deleting items with special characters (#289)
- Corrected timezone handling in date picker (#290)Best Practices
- Write for Users - Focus on user-facing changes, not implementation details
- Be Specific - "Added dark mode" not "Added new feature"
- Include Issue/PR Numbers - Link to GitHub issues/PRs
- Group Similar Changes - Keep related changes together
- Use Present Tense - "Add feature" not "Added feature"
- Keep Unreleased Section - Always maintain an [Unreleased] section
- Date Format - Use ISO 8601 format (YYYY-MM-DD)
- Version Links - Include comparison links at the bottom
Common Mistakes
- Don't include every commit - summarize user-facing changes
- Don't use vague descriptions like "Various fixes"
- Don't forget to move Unreleased items when cutting a release
- Don't skip version numbers in the comparison links
- Don't mix internal and user-facing changes
Install with Tessl CLI
npx tessl i pantheon-ai/markdown-authoring@0.1.1