Create and maintain markdown documentation with Eleventy templates and Vale prose linting.
npx skills add https://github.com/NVIDIA/elements --skill documentation-nvidia
Please help me install this Agent Skill. Skill: documentation Source: https://github.com/NVIDIA/elements/tree/main/.agents/skills/documentation Command: npx skills add https://github.com/NVIDIA/elements --skill documentation-nvidia
This Skill addresses the need for a consistent and structured approach to documentation creation and maintenance, providing guidelines and tools for effective documentation practices.
Run the documentation skill to apply Vale prose linting to your markdown files.
High-intent search queries and answers about installing and using this skill.
To lint markdown documentation, apply Vale prose linting to your files to enforce style and consistency guidelines. This checks your writing against defined rules to ensure high-quality software documentation.
Structuring software documentation with Eleventy templates involves using provided guidelines, shortcodes, and markdown files to build a consistent site. This approach ensures your content remains maintainable and user-friendly.
Yes, this approach supports JSDoc annotations by providing specific guidelines for integrating them into your workflow. You can use these annotations alongside markdown files to maintain accurate software documentation.
Yes, you can run Vale prose linting directly on your existing markdown files. It functions as a standalone checker to validate documentation quality without requiring immediate changes to your build process.
You need comprehensive guidelines for maintaining software documentation when your project requires a consistent structure across markdown files, templates, and annotations. This ensures content quality and consistency as the project scales.
jikig-aiAnalyze Eleventy documentation sites for SEO and AI discoverability issues.
JongsixGenerate technical documentation from source code and API definitions.
zzafergokConvert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.
Coffelix2023Generate inline code documentation, API specifications, and developer guides.
