{"id":28986772,"url":"https://github.com/clidey/dory","last_synced_at":"2025-10-06T08:14:39.363Z","repository":{"id":299448882,"uuid":"1002674125","full_name":"clidey/dory","owner":"clidey","description":"A lightweight static site generator for technical documentation.","archived":false,"fork":false,"pushed_at":"2025-10-02T08:47:52.000Z","size":30466,"stargazers_count":141,"open_issues_count":18,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-02T10:25:40.725Z","etag":null,"topics":["docs","docs-tooling"],"latest_commit_sha":null,"homepage":"https://docucod.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/clidey.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-06-16T00:39:41.000Z","updated_at":"2025-10-02T08:47:57.000Z","dependencies_parsed_at":"2025-07-10T18:27:24.191Z","dependency_job_id":"4b10bf45-bdb0-43c6-8922-244bdd44afc1","html_url":"https://github.com/clidey/dory","commit_stats":null,"previous_names":["clidey/dory"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/clidey/dory","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clidey%2Fdory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clidey%2Fdory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clidey%2Fdory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clidey%2Fdory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clidey","download_url":"https://codeload.github.com/clidey/dory/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clidey%2Fdory/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278577959,"owners_count":26009709,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","docs-tooling"],"created_at":"2025-06-24T20:33:45.048Z","updated_at":"2025-10-06T08:14:39.355Z","avatar_url":"https://github.com/clidey.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"./assets/logo.svg\" alt=\"Dory Logo\" width=\"100\" /\u003e\n\u003c/div\u003e\n\n# Dory\n\n\u003e 🐟 A lightweight static site generator for technical documentation.\n\nDory is a lightweight static site generator built for developers who want fast, clean, and customizable documentation — without the overhead of server-side rendering, complex CI/CD setups, or cloud-specific constraints.\n\nBuilt with [Preact](https://preactjs.com/), [Vite](https://vitejs.dev/), [Tailwind CSS](https://tailwindcss.com/), [Mermaid](https://mermaid.js.org/), and [TypeScript](https://www.typescriptlang.org/).\n\n\n## 🚀 Why Dory?\n\nWe created Dory while building a documentation platform and getting frustrated by bloated frameworks, slow build times, and cryptic deployment errors.\n\nDory is:\n\n- 🧠 **Simple** — Drop in `.mdx` files and configure one `dory.json`.\n- ⚡ **Fast** — Instant hot reload in dev, quick static builds for prod.\n- 🌐 **Portable** — No SSR, no lock-in, deploy anywhere.\n- 🧩 **Flexible** — Hackable theme, readable codebase, minimal magic.\n\n\n## 🎬 Quick Demo\n\nhttps://github.com/user-attachments/assets/5a2840ce-a0b9-41fd-8d15-3ee1d2356f07\n\n## ✨ Features\n\n- 📄 Write docs in `.mdx` (Markdown + JSX)\n- 🧭 Configure site structure with a single `dory.json`\n- 🧪 Built-in components for layout, navigation, and code highlighting\n- 🔁 Instant hot-reload during development\n- 📊 Mermaid support for diagrams and flows\n- 🎨 Customizable via Tailwind and minimal theme overrides\n- 🌍 Deploy to Netlify, Vercel, S3, GitHub Pages — your call\n- 🌐 HTTP client for testing API endpoints (automatic inference from openapi.json)\n\n\n## 📦 CLI Installation\n\nInstall Dory globally to use the CLI tool:\n\n```bash\nnpm install -g @clidey/dory\n```\n\n### CLI Usage\n\nOnce installed, you can use the `dory` command:\n\n#### `dory build`\nBuilds your documentation site:\n- Checks for `dory.json` in current directory\n- Clears and prepares the `docs` folder\n- Copies configuration to `docs` folder\n- Runs the build process\n- Creates `dist` folder with build output\n\n```bash\ndory build\n```\n\n#### `dory preview`\nPreviews the built documentation site:\n- Requires `dist` folder (run `dory build` first)\n- Starts a local preview server\n\n```bash\ndory preview\n```\n\n#### `dory verify:content`\nVerifies that MDX content compiles without errors:\n- Silent on success (no output means no errors)\n- Shows detailed error messages on failure\n- Uses the same preprocessing as the main build\n- Perfect for automated testing and debugging\n\n```bash\n# Verify content directly\ndory verify:content --content \"# Hello World\\n\\nThis is a test.\"\n\n# Verify content from file (recommended for complex content)\ndory verify:content --file content.mdx\n\n# Development repository usage:\npnpm exec tsx bin/dory.ts verify:content --file content.mdx\n```\n\n#### `dory help`\nShows CLI usage information:\n\n```bash\ndory help\n```\n\n\n## 🧑‍💻 Development Setup\n\nFollow these steps to set up and preview the documentation locally, as well as build a static site for deployment.\n\n### 1️⃣ Clone the Repository\n\nClone the repository to your local machine:\n\n```bash\ngit clone https://github.com/clidey/dory.git\ncd dory\n````\n\n\n### 2️⃣ Install Dependencies\n\nInstall all required dependencies using `pnpm`:\n\n```bash\npnpm install\n```\n\nMake sure you have `pnpm` installed. If not, you can install it via:\n\n```bash\nnpm install -g pnpm\n```\n\n---\n\n### 3️⃣ Copy Documentation Content\n\nCopy your existing documentation into the `./docs` directory:\n\n```bash\nrm -rf ./docs\ncp ../wherever-the-docs-are/. ./docs\n```\n\n\u003e Replace `../wherever-the-docs-are/` with the actual path to your documentation source files.\n\n---\n\n### 4️⃣ Start Development Server\n\nStart the development server to preview the documentation locally:\n\n```bash\npnpm run dev\n```\n\nThis will launch a local server (typically at `http://localhost:3000`) where you can preview and edit your documentation in real-time.\n\n---\n\n### 5️⃣ Build Static Site for Production\n\nTo generate a static version of the site for production deployment:\n\n```bash\npnpm run build\n```\n\nThis will create a `dist` directory containing the fully built static site, ready to be served.\n\n\n## 🐳 Docker Deployment (Optional)\n\nYou can use our official Docker image `clidey/dory` to create a static server. Simply create a Dockerfile inside the project and build the following Dockerfile:\n\n```dockerfile\nFROM clidey/dory\nWORKDIR /app\nCOPY . .\nRUN dory build\nCMD [\"dory\", \"preview\"]\n```\n\nYou can also build and run the static site inside a Docker container using Nginx:\n\n### Build Docker Image\n\n```bash\ndocker build -f k8s/Dockerfile --tag docs:1.0.0 .\n```\n\n### Run Docker Container\n\n```bash\ndocker run -it -p 8080:80 docs:1.0.0\n```\n\n\u003e The site will be available at `http://localhost:8080` inside your browser.\n\n## 📂 Notes\n\n* `pnpm run build` creates the static site inside the `dist` folder, which can be served using any static file server.\n* The Docker image uses Nginx to serve the contents of the `dist` folder.\n\n\n## 🔮 Roadmap\n\nWe’re actively improving Dory. Here’s what’s on deck:\n\n* [ ] 📚 **Full Documentation** — comprehensive guides, API docs, and examples\n* [ ] 🎨 **Themes** — full theming support with a flexible theme API\n* [ ] 🌐 **Multi-language Support** — internationalization (i18n) \u0026 localization (l10n)\n* [ ] 🚀 **GraphQL Client** — integrated GraphQL playground and client support\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclidey%2Fdory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclidey%2Fdory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclidey%2Fdory/lists"}