How p-rer/ymm-api-docs works
YMM API Docs is a documentation site for Yukkuri Movie Maker’s plugin API, with Markdown guides and YAML-based API references. The main workflow resolves a document slug, loads and renders its content, then presents it in a navigable documentation layout. Readers can also search, preview internal links, and request AI summaries. API-reference rendering and document metadata/contributor handling are distinct supporting stages. Relationships involving unsampled components are omitted or marked unverified where appropriate.
Main entry points: docs.ts Document loading · render-api-doc.ts API doc rendering · page.tsx Document page · doc-markdown.ts Markdown access
Components 25
Reader experience
- Home page
app/page.tsx - Document page
app/[...slug]/page.tsx - Documentation layout
app/docs-layout.tsx - Interactive navigation
components/DocsLayoutClient.tsx - Full-text search
hooks/useFullTextSearch.ts - Summary display
components/AiSummary.tsx
Content rendering
- Document loading
lib/docs.ts - Markdown access
lib/doc-markdown.ts - Contributor metadata
lib/doc-contributors.ts - Documentation content
API references
- YAML documents
lib/yaml-docs.ts - API doc rendering
lib/api-docs/render-api-doc.ts - YAML schema
lib/api-docs/yaml-v1-schema.ts - Symbol index
lib/api-docs/symbol-index.ts - Type model
lib/api-docs/type-node.ts - Reference URLs
lib/api-docs/reference-url.ts
Document services
- Search API
app/api/search/route.ts - Link preview API
app/api/doc-preview/route.ts - Preview text rendering
lib/doc-preview.ts - Summary API
app/api/summarize/route.ts - Content images
app/content-images/[...path]/route.ts - Search index data
Shared presentation
- Open Graph images
lib/og.tsx
Other components
- Documentation reader
- Google AI
Connections 26
- Documentation reader → Home page: opens
app/page.tsx - Documentation reader → Document page: opens
app/[...slug]/page.tsx - Home page → Document loading: loads documents
app/page.tsx - Document page → Document loading: loads document
app/[...slug]/page.tsx - Document page → Documentation layout: renders through
app/[...slug]/page.tsx - Document page → Open Graph images: generates metadata image
app/[...slug]/page.tsx - Document loading → Markdown access: reads Markdown
lib/docs.ts - Document loading → YAML documents: converts YAML
lib/docs.ts - Document loading → API doc rendering: renders API docs
lib/docs.ts - Document loading → Contributor metadata: resolves contributors
lib/docs.ts - Documentation layout → Interactive navigation: renders
app/docs-layout.tsx - Interactive navigation → Full-text search: uses
components/DocsLayoutClient.tsx - Full-text search → Search API: requests search
hooks/useFullTextSearch.ts - Search API → Search index data: loads
app/api/search/route.ts - API doc rendering → YAML schema: validates with
- API doc rendering → Symbol index: uses
- API doc rendering → Type model: uses
- API doc rendering → Reference URLs: uses
- Link preview API → Markdown access: loads source
app/api/doc-preview/route.ts - Link preview API → Preview text rendering: renders preview
app/api/doc-preview/route.ts - Summary API → Markdown access: loads article
app/api/summarize/route.ts - Summary API → Google AI: generates summary
app/api/summarize/route.ts - Summary display → Summary API: requests summary
- Document loading → Documentation content: reads content
- Markdown access → Documentation content: reads content
- Documentation reader → Content images: requests images