refrakt.md@refrakt-md/docs
Technical documentation runes for API references, code symbols, and changelogs. Document REST APIs, TypeScript interfaces, functions, and version history from structured Markdown.
Installation
npm install @refrakt-md/docs
{
"packages": ["@refrakt-md/docs"]
}
Runes
| Rune | Description |
|---|---|
| api | API endpoint documentation with method, path, and parameters |
| symbol | Code construct documentation for functions, classes, interfaces, enums, and type aliases |
| changelog | Version history with release notes |
CLI
The package extends the refrakt CLI with the docs extract command for generating API reference documentation from TypeScript or Python source code.
When to use
Use this package when building technical documentation sites, API references, or SDK docs. The api rune handles REST endpoint documentation with method badges and parameter tables. The symbol rune covers code constructs like functions, classes, and interfaces. The changelog rune structures version history with release dates and categorized changes.