SDIF Documentation Site

Public documentation website for the Semantic Data Interchange Format (SDIF),
built with Docusaurus and hosted at sdif-format.github.io.

Development · Structure · Deploy · Ecosystem

sdif-format.github.io →

Compact Less repeated structure. Fewer wasted tokens.

Semantic Tables, relations, metadata and intent.

Canonical Stable output for hashing, signing and comparison.

Auditable Designed to be read, reviewed and trusted.

---

Development

Install dependencies and start the Docusaurus local development server:

npm install
npm start # dev server at http://localhost:3000/
npm run build # production build in build/
npm run serve # preview production build

---

Structure

docs/ # Documentation pages (sidebar-driven markdown)
src/pages/ # Standalone pages (home, benchmarks, ecosystem)
static/ # Static assets (llms.txt, llms-full.txt, images)
sidebars.ts # Sidebar navigation configuration
docusaurus.config.ts # Docusaurus site configuration

---

Deploy

Pushes to the main branch trigger a GitHub Actions workflow that automatically builds and deploys the production build to GitHub Pages (https://sdif-format.github.io/).

---

Ecosystem

This GitHub organization hosts the official SDIF ecosystem: the core format, reference tooling, benchmarks, examples, libraries, and editor extensions.

PYTHON CLIENT & CLI sdif-py Specification, parser, canonicalizer, and CLI. The normative reference implementation. Explore sdif-py →	SPECIFICATION (SSOT) sdif-spec Official format specification, canonicalization rules, and portable conformance test suite. View specification →	BENCHMARKS sdif-benchmarks Reproducible benchmark datasets and reports comparing SDIF with JSON, YAML, XML, and CSV. View benchmarks →
RUST IMPLEMENTATION sdif-rs Pure Rust parser implementation with a span-annotated AST designed for editor tooling. Explore sdif-rs →	LANGUAGE SERVER (LSP) sdif-lsp LSP language server binary (tower-lsp) providing real-time diagnostics and IDE features. View sdif-lsp →	EDITOR INTEGRATION vscode-sdif VS Code extension client providing syntax highlighting, diagnostics, and LSP configuration. Open extension →
GRAMMAR FOUNDATION tree-sitter-sdif Tree-sitter grammar foundation for syntax highlighting and incremental parsing. Open grammar →	DOCUMENTATION sdif-format.github.io Official documentation website containing specification guides, tutorials, and examples. Read docs →	ORGANIZATION META .github Organization profile, assets, and shared community configuration files. View profile →

Repository map

Repository	Purpose
sdif-py	Core Python parser, validator, canonicalizer, and CLI
sdif-spec	Official format specification and conformance test suite (SSOT)
sdif-benchmarks	Benchmark datasets, reports, and comparison tooling
sdif-rs	Rust parser crate with span-annotated AST
sdif-lsp	LSP language server binary
tree-sitter-sdif	Tree-sitter grammar foundation for syntax highlighting
vscode-sdif	VS Code extension client for SDIF
sdif-format.github.io	Public documentation website (Docusaurus)
.github	Organization profile, assets, and shared GitHub community files

License

See the sdif-spec repository for license information.