{"id":40255615,"url":"https://github.com/nexlabstudio/stardust","last_synced_at":"2026-01-31T12:03:06.715Z","repository":{"id":333285048,"uuid":"1136545097","full_name":"nexlabstudio/stardust","owner":"nexlabstudio","description":"The Dart-native documentation framework. Beautiful docs, zero config.","archived":false,"fork":false,"pushed_at":"2026-01-23T13:52:03.000Z","size":344,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"dev","last_synced_at":"2026-01-24T13:57:53.689Z","etag":null,"topics":["docs","docs-generator","docusaurus","gitbook","hugo","mintlify","starlight-astro","vitepress"],"latest_commit_sha":null,"homepage":"https://stardust.nexlab.studio/","language":"Dart","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/nexlabstudio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"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":"2026-01-17T22:05:45.000Z","updated_at":"2026-01-23T13:52:01.000Z","dependencies_parsed_at":"2026-01-24T05:00:35.985Z","dependency_job_id":null,"html_url":"https://github.com/nexlabstudio/stardust","commit_stats":null,"previous_names":["nexlabstudio/stardust"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/nexlabstudio/stardust","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nexlabstudio%2Fstardust","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nexlabstudio%2Fstardust/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nexlabstudio%2Fstardust/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nexlabstudio%2Fstardust/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nexlabstudio","download_url":"https://codeload.github.com/nexlabstudio/stardust/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nexlabstudio%2Fstardust/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28941925,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T11:39:38.044Z","status":"ssl_error","status_checked_at":"2026-01-31T11:39:27.765Z","response_time":128,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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-generator","docusaurus","gitbook","hugo","mintlify","starlight-astro","vitepress"],"created_at":"2026-01-20T01:39:04.026Z","updated_at":"2026-01-31T12:03:06.706Z","avatar_url":"https://github.com/nexlabstudio.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Stardust\n\n**A Dart-native documentation generator. Beautiful docs, zero config.**\n\n[![CI](https://github.com/nexlabstudio/stardust/actions/workflows/ci.yml/badge.svg)](https://github.com/nexlabstudio/stardust/actions/workflows/ci.yml)\n[![codecov](https://codecov.io/gh/nexlabstudio/stardust/branch/dev/graph/badge.svg?token=XoNeoaL5pi)](https://codecov.io/gh/nexlabstudio/stardust)\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n---\n\n## Why Stardust?\n\nBuilding documentation shouldn't require a JavaScript toolchain. Stardust is a **fast, native documentation generator** built entirely in Dart — no Node.js, no npm, no webpack. Just beautiful docs.\n\n- **Zero Configuration** — Sensible defaults out of the box. Start writing immediately.\n- **Blazing Fast** — Native Dart binary. Builds in milliseconds, not minutes.\n- **Beautiful by Default** — Clean, modern design with automatic dark mode.\n- **Rich Components** — Callouts, tabs, code groups, API docs, and 30+ components.\n- **Full-Text Search** — Powered by Pagefind. No external services required.\n- **SEO Optimized** — Automatic sitemap, robots.txt, Open Graph, and Twitter Cards.\n- **OpenAPI Import** — Generate API documentation from your Swagger/OpenAPI specs.\n\n---\n\n## Installation\n\n### macOS\n\n**Homebrew** (recommended)\n\n```bash\nbrew tap nexlabstudio/tap\nbrew install stardust\n```\n\n**curl**\n\n```bash\ncurl -sSL https://raw.githubusercontent.com/nexlabstudio/stardust/dev/install.sh | bash\n```\n\n### Linux\n\n**curl** (recommended)\n\n```bash\ncurl -sSL https://raw.githubusercontent.com/nexlabstudio/stardust/dev/install.sh | bash\n```\n\n**Snap**\n\n```bash\nsnap install stardust\n```\n\n### Windows\n\n**Scoop** (recommended)\n\n```powershell\nscoop install https://raw.githubusercontent.com/nexlabstudio/stardust/dev/scoop/stardust.json\n```\n\n**Chocolatey**\n\n```powershell\nchoco install stardust\n```\n\n### Dart/Flutter Developers\n\nIf you already have Dart installed:\n\n```bash\ndart pub global activate stardust\n```\n\n### Manual Download\n\nDownload pre-built binaries from the [Releases](https://github.com/nexlabstudio/stardust/releases) page.\n\n| Platform | Architecture | Download |\n|----------|--------------|----------|\n| macOS | Apple Silicon | `stardust-darwin-arm64.tar.gz` |\n| macOS | Intel | `stardust-darwin-x64.tar.gz` |\n| Linux | x64 | `stardust-linux-x64.tar.gz` |\n| Linux | ARM64 | `stardust-linux-arm64.tar.gz` |\n| Windows | x64 | `stardust-windows-x64.zip` |\n\n---\n\n## Quick Start\n\n**1. Create a new project**\n\n```bash\nstardust init my-docs\ncd my-docs\n```\n\n**2. Start the dev server**\n\n```bash\nstardust dev\n```\n\nOpen [http://localhost:4000](http://localhost:4000) to see your docs with live reload.\n\n**3. Build for production**\n\n```bash\nstardust build\n```\n\nYour static site is ready in `dist/`. Deploy anywhere.\n\n---\n\n## Project Structure\n\n```\nmy-docs/\n├── docs/              # Your markdown files\n│   ├── index.md       # Home page\n│   └── guide.md       # Additional pages\n├── public/            # Static assets (images, etc.)\n├── stardust.yaml      # Configuration\n└── dist/              # Build output (generated)\n```\n\n---\n\n## Features\n\n### Rich Component Library\n\nWrite expressive documentation with JSX-style components:\n\n```markdown\n\u003cInfo\u003eThis is an informational callout.\u003c/Info\u003e\n\n\u003cTabs\u003e\n  \u003cTab name=\"npm\"\u003enpm install package\u003c/Tab\u003e\n  \u003cTab name=\"yarn\"\u003eyarn add package\u003c/Tab\u003e\n\u003c/Tabs\u003e\n\n\u003cSteps\u003e\n  \u003cStep title=\"Install\"\u003eRun the installer\u003c/Step\u003e\n  \u003cStep title=\"Configure\"\u003eEdit the config file\u003c/Step\u003e\n  \u003cStep title=\"Deploy\"\u003ePush to production\u003c/Step\u003e\n\u003c/Steps\u003e\n```\n\n**30+ built-in components:** Callouts, Tabs, Accordions, Cards, Steps, Code Groups, API docs, YouTube/Vimeo embeds, Mermaid diagrams, and more.\n\n### API Documentation\n\nDocument your APIs beautifully:\n\n```markdown\n\u003cApi method=\"GET\" path=\"/users/{id}\"\u003e\n  \u003cParamField name=\"id\" type=\"string\" required\u003eUser ID\u003c/ParamField\u003e\n  \u003cResponseField name=\"email\" type=\"string\"\u003eUser's email\u003c/ResponseField\u003e\n\u003c/Api\u003e\n```\n\nOr import directly from OpenAPI/Swagger:\n\n```bash\nstardust openapi openapi.yaml -o docs/api\n```\n\n### Full-Text Search\n\nSearch is built-in and works offline. Powered by [Pagefind](https://pagefind.app/).\n\n- Press `/` or `Cmd+K` to search\n- No external services or API keys required\n- Works entirely client-side\n\n### Dark Mode\n\nAutomatic dark mode that respects system preferences. Or let users toggle manually.\n\n### SEO Ready\n\n- Automatic `sitemap.xml` generation\n- Configurable `robots.txt`\n- Open Graph and Twitter Card meta tags\n- Clean, semantic HTML output\n\n---\n\n## Configuration\n\nCreate a `stardust.yaml` in your project root:\n\n```yaml\nname: My Project\ndescription: Documentation for My Project\nurl: https://docs.myproject.com\n\nnav:\n  - label: Guide\n    href: /\n  - label: API\n    href: /api\n  - label: GitHub\n    href: https://github.com/myorg/myproject\n    external: true\n\nsidebar:\n  - group: Getting Started\n    pages:\n      - index\n      - installation\n      - quickstart\n\ntheme:\n  colors:\n    primary: \"#6366f1\"\n  darkMode:\n    enabled: true\n    default: system\n\nsearch:\n  enabled: true\n  placeholder: \"Search docs...\"\n  hotkey: \"/\"\n```\n\n---\n\n## Commands\n\n| Command | Description |\n|---------|-------------|\n| `stardust init [dir]` | Create a new documentation project |\n| `stardust dev` | Start dev server with hot reload |\n| `stardust build` | Build static site for production |\n| `stardust openapi \u003cspec\u003e` | Generate docs from OpenAPI spec |\n\n---\n\n## Deployment\n\nStardust generates a static site in `dist/`. Deploy anywhere static files are served.\n\n### GitHub Pages (recommended)\n\nUse GitHub Actions to build and deploy automatically:\n\n```yaml\n# .github/workflows/deploy.yml\n- run: curl -sSL https://raw.githubusercontent.com/nexlabstudio/stardust/dev/install.sh | bash\n- run: stardust build\n- uses: peaceiris/actions-gh-pages@v3\n  with:\n    github_token: ${{ secrets.GITHUB_TOKEN }}\n    publish_dir: ./dist\n```\n\n### Vercel / Netlify / Cloudflare Pages\n\nThese platforms don't have Stardust pre-installed. Two options:\n\n**Option 1: Build with GitHub Actions, deploy output**\n\nBuild in CI, then deploy the `dist/` folder. Set your platform to serve from the build output.\n\n**Option 2: Install during build**\n\n```bash\n# Build command (Vercel/Netlify/Cloudflare)\ncurl -sSL https://raw.githubusercontent.com/nexlabstudio/stardust/dev/install.sh | bash \u0026\u0026 stardust build\n\n# Output directory\ndist\n```\n\n### Any Static Host\n\nJust upload the `dist/` folder to any web server, CDN, or object storage (S3, GCS, etc.).\n\n---\n\n## Comparison\n\n| Feature | Stardust | docs.page | Mintlify | Starlight | Docusaurus | VitePress | GitBook |\n|---------|----------|-----------|----------|-----------|------------|-----------|---------|\n| No Node.js required | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ |\n| Zero config | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ |\n| Self-hosted | ✅ | ❌ | ❌ | ✅ | ✅ | ✅ | ❌ |\n| Free \u0026 open source | ✅ | ✅ | ❌ | ✅ | ✅ | ✅ | Freemium |\n| JSX-style components | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |\n| Built-in search | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |\n| OpenAPI/Swagger import | ✅ | ❌ | ✅ | Plugin | Plugin | Plugin | ✅ |\n| Dark mode | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |\n| SEO (sitemap, meta tags) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |\n| Edit on GitHub | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |\n| i18n / Multi-language | 🚧 | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |\n| Versioning | 🚧 | ❌ | ✅ | ❌ | ✅ | ❌ | ✅ |\n| API documentation | ✅ | ✅ | ✅ | Plugin | Plugin | Plugin | ✅ |\n| LLM-friendly output | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| Mermaid diagrams | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |\n| Dart/Flutter focus | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |\n\n✅ = Built-in | 🚧 = Coming soon | Plugin = Requires plugin/addon | ❌ = Not available\n\n---\n\n## Contributing\n\nContributions are welcome! Please read our contributing guidelines before submitting a PR.\n\n```bash\n# Clone the repo\ngit clone https://github.com/nexlabstudio/stardust.git\ncd stardust\n\n# Install dependencies\ndart pub get\n\n# Run tests\ndart test\n\n# Run locally\ndart run bin/stardust.dart --help\n```\n\n---\n\n## License\n\nApache-2.0 — See [LICENSE](LICENSE) for details.\n\n---\n\n\u003cp align=\"center\"\u003e\n  Built with Dart. Made for developers who value simplicity.\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnexlabstudio%2Fstardust","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnexlabstudio%2Fstardust","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnexlabstudio%2Fstardust/lists"}