Generate markdown API documentation for Nim source files using jsondoc.
npx skills add https://github.com/planetis-m/skills --skill update-api-docs
Please help me install this Agent Skill. Skill: update-api-docs Source: https://github.com/planetis-m/skills/tree/main/update-api-docs Command: npx skills add https://github.com/planetis-m/skills --skill update-api-docs
This Skill automates the creation and updating of markdown API documentation for Nim source files, ensuring your project's documentation stays current with minimal manual effort.
jsondoc to generate intermediate JSON files for detailed API information.docs/ directory, providing up-to-date documentation for developers.Run the update-api-docs skill to generate markdown documentation for all Nim files in the project.
High-intent search queries and answers about installing and using this skill.
You can generate markdown API documentation for Nim source files by running this Skill, which parses Nim modules using the jsondoc tool and outputs human-readable markdown references into your project's docs directory.
The best way to keep API docs updated for a Nim library is to automate the generation process. This Skill converts Nim source code into markdown documentation, ensuring your references stay current with minimal manual effort after API changes.
Yes, you need the Nim compiler and the jsondoc tool to generate API references. The Skill relies on jsondoc to parse Nim modules and produce intermediate JSON files for the custom conversion logic to build the final markdown.
The jsondoc conversion works by first generating intermediate JSON files from Nim source code, which contain detailed API information. The Skill then applies custom conversion logic to transform this JSON data into structured markdown documentation.
Yes, you can automatically regenerate the docs directory for your Nim project. After updating your library's API, running this Skill scans all Nim files and regenerates the markdown documentation to provide up-to-date references for developers.
TheBushidoCollectiveEnable Nim-C interop with importc/exportc pragmas and typed boundaries.
JongsixGenerate technical documentation from source code and API definitions.
wtthorntonGenerate API documentation, READMEs, and docstrings in Markdown, reStructuredText, and HTML.
Srujan0798Compare README.md, Core_Idea_Clean.md, and API docs against the codebase to detect documentation drift.