This directory contains the Docusaurus documentation site for undatum.
- Node.js 18+ and npm
cd docs
npm installStart the development server:
npm startThis starts a local development server and opens a browser window. Most changes
are reflected live without restarting the server. From the repository root you
can also run make docs-serve.
Build the site for production:
npm run buildThis generates static content into the build directory. From the repository
root you can also run make docs.
Serve the built site locally:
npm run servedocs/
├── docusaurus.config.js # Docusaurus configuration
├── sidebars.js # Sidebar navigation
├── package.json # Node.js dependencies
├── babel.config.js # Babel configuration
├── src/
│ ├── css/custom.css # Custom styles
│ ├── pages/index.js # Homepage (documentation contents)
│ └── components/ # React components
├── static/img/ # Logo and favicon
└── docs/ # Documentation content
├── getting-started/ # Installation, quick start, cookbook
├── use-cases/ # End-to-end examples
├── commands/ # CLI reference
├── formats/ # Format support matrix
├── integrations/ # SDK, MCP, Data API, cloud, plugins
├── development/ # Contributing and internals
└── license.md
The documentation is deployed to GitHub Pages at
datenoio.github.io/undatum when changes
are pushed to main. The workflow lives in .github/workflows/deploy-docs.yml.
- Open the repository settings on GitHub.
- Navigate to Pages.
- Under Source, select GitHub Actions.
See GITHUB_PAGES_SETUP.md for details.
- Getting Started: Installation, quick start, positioning, cookbook
- Use Cases: Conversion, pipelines, quality, SQL, agents
- CLI Reference: Command-by-command documentation
- Data File Formats: Honest capability matrix (140+ formats via iterabledata)
- Integrations: SDK, MCP, Data API, cloud storage, plugins
- Development: Contributing, error-handling patterns, community
When adding or updating documentation:
- Edit the markdown files in
docs/docs/. - Follow the existing frontmatter (
title,description). - Test locally with
npm start. - Confirm
npm run buildsucceeds (broken links fail the build).