$ show obsidianmd/obsidian-developer-docs
This repository contains the official developer documentation for the Obsidian note-taking application. It is structured as an Obsidian vault with Markdown files, auto-generated TypeScript API reference pages, hand-written CSS variable references, and guides for plugin and theme development. The documentation is published as a static site via Obsidian Publish using a GitHub Actions workflow. The repo includes a build pipeline (api-extractor, api-documenter, custom post-processing) that generates the API reference from the Obsidian TypeScript API definitions. While the documentation itself is comprehensive and well-organized, the build tooling has some fragility (hardcoded paths, regex-based transformations) and the generated API pages are not directly editable. The repo serves as the primary resource for third-party developers building plugins and themes for Obsidian.
The LLM identified 2 files worth highlighting for reuse:
A Node.js script that post-processes Markdown output from API Documenter into the final documentation format. It strips namespace prefixes, renames symbols (e.g., Plugin_2 to Plugin), injects YAML frontmatter (aliases, cssclasses), unescapes backticks, rewrites markdown links, and reorganizes files into category folders. This pattern is reusable for any TypeScript API documentation pipeline that needs to transform generic API Documenter output into a format suitable for an Obsidian vault or similar static site.
A hand-written reference page documenting Obsidian's CSS color variables. It follows a consistent table format with variable name, default value, and description. This pattern is reusable for documenting CSS variable systems in any design system or application, providing a clear, maintainable structure that can be easily extended or adapted.