Skills
.Work. You
Rest

update-api-docs

Community

Generate markdown API docs for Nim.

Software Engineering#developer tools#code generation#api documentation#nim#jsondoc
Authorplanetis-m
Version1.0.0
Installs0

System Documentation

What problem does it solve?

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.

Core Features & Use Cases

  • Automated Documentation Generation: Converts Nim source code into human-readable markdown API documentation.
  • JSON Doc Conversion: Leverages jsondoc to generate intermediate JSON files for detailed API information.
  • Use Case: After updating your Nim library's API, run this skill to automatically regenerate the docs/ directory, providing up-to-date documentation for developers.

Quick Start

Run the update-api-docs skill to generate markdown documentation for all Nim files in the project.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: update-api-docs
Download link: https://github.com/planetis-m/skills/archive/main.zip#update-api-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.