Components [[components: NarrativeDoc]]NarrativeDoc
System components of QMDC.
QMD.md Specification [[qmdc_specification: text]]textCLI CLI 74%Overview NarrativeDoc 74%Parse Command 73%
- about: QMD.md Format Specification
The QMD.md format specification defines syntax, rules, concepts, and behavior. It is the "law" for all parser implementations. All three parsers (Python, TypeScript, Rust) must implement the same specification.
See the QMD.md Format Specification namespace for the full specification.
Parser Implementations [[parser_implementations: text]]textCLI CLI 88%Overview NarrativeDoc 82%Parse Command 75%
- about: Python Parser, TypeScript Parser, Rust Parser
Three independent QMDC parser implementations sharing the same CLI interface.
All three parsers provide the same CLI:
qmdc parse— QMD.md → JSON conversionqmdc rebuild— JSON → QMD.md restorationqmdc workspace— multi-file workspace parsingqmdc query— SQL queries against workspace
The Rust parser additionally provides:
qmdc lsp— LSP server
| Parser | Language | Highlights |
|---|---|---|
| Python Parser | Python | Reference implementation, simple code |
| TypeScript Parser | TypeScript | For Node.js/browser, full typing |
| Rust Parser | Rust | High performance, LSP server |
See the Parsers namespace for detailed descriptions of each implementation.
LSP Server [[lsp_server_section: text]]textLSP Server Namespace 90%Completion LSPFeature 74%Diagnostics LSPFeature 73%
- about: Rust Parser
Language Server Protocol server for integrating QMDC with editors.
Implemented only in the Rust parser. Provides:
- ID, Kind, namespace autocompletion
- Reference validation and error diagnostics
- Go to Definition (F12, Ctrl+Click)
- Find All References (Shift+F12)
- Hover preview of objects
- Rename with reference updates
Transport: stdio (default, for editor integration), socket (debug mode).
Multi-Workspace Support: supports VS Code Multi-root Workspace — multiple folders with different QMDC workspaces simultaneously.
VS Code Extension [[vscode_extension_section: text]]textVS Code Extension Namespace 82%Capabilities NarrativeDoc 80%LSP Server Namespace 78%
- about: Rust Parser
Extension for Visual Studio Code providing QMDC integration.
Features:
- Language Client for launching and managing the LSP server
- Custom Views — QMDC Workspace Explorer with grouping by namespace/kind/file
- Preview Webview — rendered markdown with mermaid diagrams, SQL table blocks, QMDC ref navigation (rendering logic in
preview-renderer.ts) - Commands for workspace operations
- Settings for LSP server configuration