Directories
¶
| Path | Synopsis |
|---|---|
|
Package assets exposes the embedded vendor JS/CSS (paged.js, KaTeX) and the preview UI files (HTML/CSS/JS) as filesystems.
|
Package assets exposes the embedded vendor JS/CSS (paged.js, KaTeX) and the preview UI files (HTML/CSS/JS) as filesystems. |
|
Package browser wraps go-rod with two flavors used by mdoc:
|
Package browser wraps go-rod with two flavors used by mdoc: |
|
Package bundle packages a document and its dependencies into a portable .mdoc zip archive.
|
Package bundle packages a document and its dependencies into a portable .mdoc zip archive. |
|
Package document parses a markdown source file with YAML frontmatter into a Document value.
|
Package document parses a markdown source file with YAML frontmatter into a Document value. |
|
Package paths resolves mdoc's per-user directories.
|
Package paths resolves mdoc's per-user directories. |
|
Package preview runs the live-preview HTTP server: serves the SPA, an iframe-hosted paged.js view of the document, pushes a reload signal over WebSocket on file changes, and exposes /print to trigger PDF generation.
|
Package preview runs the live-preview HTTP server: serves the SPA, an iframe-hosted paged.js view of the document, pushes a reload signal over WebSocket on file changes, and exposes /print to trigger PDF generation. |
|
Package print runs the one-shot pipeline: parse -> render -> headless Chromium -> wait for paged.js -> page.PDF -> write to disk.
|
Package print runs the one-shot pipeline: parse -> render -> headless Chromium -> wait for paged.js -> page.PDF -> write to disk. |
|
Package render is the single rendering pipeline shared by `mdoc print` and `mdoc open`.
|
Package render is the single rendering pipeline shared by `mdoc print` and `mdoc open`. |
|
Package theme resolves and loads HTML theme templates.
|
Package theme resolves and loads HTML theme templates. |
Click to show internal directories.
Click to hide internal directories.