@macalinao/codama-renderers-markdown
v0.5.1
Published
Codama visitor for rendering markdown documentation from IDL
Maintainers
Readme
@macalinao/codama-renderers-markdown
A Codama visitor that renders markdown documentation from Solana program IDLs.
Documentation
Full documentation and examples are available at coda.ianm.com/docs/packages/codama-renderers-markdown.
Quick Start
The easiest way to use this package is through the Coda CLI:
# Install Coda CLI
npm install -D @macalinao/coda
# Generate documentation
coda docsOr use directly:
npm install @macalinao/codama-renderers-markdownimport { renderMarkdownVisitor } from "@macalinao/codama-renderers-markdown";
import { rootNodeFromAnchor } from "@codama/nodes-from-anchor";
import { visit } from "codama";
const idl = JSON.parse(fs.readFileSync("idl.json", "utf-8"));
const root = rootNodeFromAnchor(idl);
visit(root, renderMarkdownVisitor("./docs"));Live Examples
- Quarry Protocol - Complete documentation for 6 Quarry programs
- Token Metadata - Metaplex Token Metadata documentation
License
Copyright © 2025 Ian Macalinao
Licensed under the Apache License, Version 2.0
