{"_id":"@ardesh1r/astro-docs-minimal","_rev":"5-69fad49508e00382b475cb7213b11f50","name":"@ardesh1r/astro-docs-minimal","dist-tags":{"latest":"1.0.5"},"versions":{"1.0.0":{"name":"@ardesh1r/astro-docs-minimal","version":"1.0.0","keywords":["astro","astro-theme","documentation","docs","minimal","clean","responsive","withastro"],"author":{"name":"Ardeshir Shojaei"},"license":"MIT","_id":"@ardesh1r/astro-docs-minimal@1.0.0","maintainers":[{"name":"ardesh1r","email":"ardeshir.shojaei@gmail.com"}],"homepage":"https://ardeshirshojaei.com","bugs":{"url":"https://github.com/Ardesh1r/astro-docs-minimal/issues"},"dist":{"shasum":"defab416f4a8dee6c9a739f171049e55b6de82be","tarball":"https://registry.npmjs.org/@ardesh1r/astro-docs-minimal/-/astro-docs-minimal-1.0.0.tgz","fileCount":20,"integrity":"sha512-3Pw5qJBnPj+xNl3ETGfkKrPyLT4mpuD1oFWj5s6OLuIuRtiEGdl9IzHFCulwZzsD5pmc8zlZHNxkKoqG8NbBlw==","signatures":[{"sig":"MEUCIGTr6AT/yBvczJNobs/ReHKPnhS71E+PxnHeuu/6peYIAiEA5FFDwPK6ePeuZFNzo1BNCaleHEQxBwwxOvadHAdie+w=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":26775},"type":"module","gitHead":"0281b27dcda8aa8f6afa2fa3af6eaca51fb2b4cf","scripts":{"dev":"astro dev","astro":"astro","build":"astro build","preview":"astro preview"},"_npmUser":{"name":"ardesh1r","email":"ardeshir.shojaei@gmail.com"},"repository":{"url":"git+https://github.com/Ardesh1r/astro-docs-minimal.git","type":"git"},"_npmVersion":"11.9.0","description":"A minimal, clean documentation theme for Astro. Perfect for technical documentation, API docs, and knowledge bases.","directories":{},"_nodeVersion":"24.14.0","dependencies":{"astro":"^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tailwindcss":"^3.3.0","@astrojs/tailwind":"^5.0.0","@tailwindcss/typography":"^0.5.10"},"_npmOperationalInternal":{"tmp":"tmp/astro-docs-minimal_1.0.0_1775508465248_0.31077422162697554","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@ardesh1r/astro-docs-minimal","version":"1.0.2","keywords":["astro","astro-theme","documentation","docs","minimal","clean","responsive","withastro","api-documentation","knowledge-base","technical-docs","dark-mode","tailwind-css","markdown","static-site-generator","jamstack","fast","performance","accessible"],"author":{"name":"Ardeshir Shojaei"},"license":"MIT","_id":"@ardesh1r/astro-docs-minimal@1.0.2","maintainers":[{"name":"ardesh1r","email":"ardeshir.shojaei@gmail.com"}],"homepage":"https://ardeshirshojaei.com","bugs":{"url":"https://github.com/Ardesh1r/astro-docs-minimal/issues"},"dist":{"shasum":"f489487f54cb682357eb05dd157954b12a8a7a20","tarball":"https://registry.npmjs.org/@ardesh1r/astro-docs-minimal/-/astro-docs-minimal-1.0.2.tgz","fileCount":23,"integrity":"sha512-3Fkz23WaV5ldm93+CSubfE9MmggcWKwKmci4kLQVpaQwIo1SwGbWj/M2mgXvG4BRnxsYdDQE1em+gRoIvqyn2Q==","signatures":[{"sig":"MEUCICbUEckBd51MOTI6zYgQe/QT5Uh2iA1ZEEYOgK+DkaM1AiEAq2Sp33xWLJUmQ3UXUaYmSccXebEOXpTlLvBSqgbh2Dg=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":44492},"type":"module","gitHead":"ac4f736c9d02cb305c8f214dbe8410cfc47b2b06","scripts":{"dev":"astro dev","astro":"astro","build":"astro build","preview":"astro preview"},"_npmUser":{"name":"ardesh1r","email":"ardeshir.shojaei@gmail.com"},"repository":{"url":"git+https://github.com/Ardesh1r/astro-docs-minimal.git","type":"git"},"_npmVersion":"11.9.0","description":"Minimal, fast documentation theme for Astro. Build beautiful technical docs, API documentation, and knowledge bases with dark mode, responsive design, and zero configuration.","directories":{},"_nodeVersion":"24.14.0","dependencies":{"astro":"^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tailwindcss":"^3.3.0","@astrojs/tailwind":"^5.0.0","@tailwindcss/typography":"^0.5.10"},"_npmOperationalInternal":{"tmp":"tmp/astro-docs-minimal_1.0.2_1775509205656_0.466929824360093","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"name":"@ardesh1r/astro-docs-minimal","version":"1.0.3","keywords":["astro","astro-theme","documentation","docs","minimal","clean","responsive","withastro","api-documentation","knowledge-base","technical-docs","dark-mode","tailwind-css","markdown","static-site-generator","jamstack","fast","performance","accessible"],"author":{"name":"Ardeshir Shojaei"},"license":"MIT","_id":"@ardesh1r/astro-docs-minimal@1.0.3","maintainers":[{"name":"ardesh1r","email":"ardeshir.shojaei@gmail.com"}],"homepage":"https://ardeshirshojaei.com","bugs":{"url":"https://github.com/Ardesh1r/astro-docs-minimal/issues"},"dist":{"shasum":"ace0cf926611a506f05f2530eb52683995de9c23","tarball":"https://registry.npmjs.org/@ardesh1r/astro-docs-minimal/-/astro-docs-minimal-1.0.3.tgz","fileCount":25,"integrity":"sha512-czl3SSsI4k22iNCWj4qpgYDTazNGZqO2js3lEmpw+6YyIT/76If4X77kkfwkvNbh6H/hVP+MzA8dUClrzL6CHg==","signatures":[{"sig":"MEQCICqqrR5sRN95ZlnyVIpg2/QAJkzKKtYerpdBRIwYdg4dAiBLB3/Oljg5KLF6E8fKrF6/7rvjtgt0ianltJ88qQ4Acg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":68913},"type":"module","gitHead":"ba805fada1c3bb18754ea85bff1d247866f56714","scripts":{"dev":"astro dev","astro":"astro","build":"astro build","preview":"astro preview"},"_npmUser":{"name":"ardesh1r","email":"ardeshir.shojaei@gmail.com"},"repository":{"url":"git+https://github.com/Ardesh1r/astro-docs-minimal.git","type":"git"},"_npmVersion":"11.9.0","description":"Minimal, fast documentation theme for Astro. Build beautiful technical docs, API documentation, and knowledge bases with dark mode, responsive design, and zero configuration.","directories":{},"_nodeVersion":"24.14.0","dependencies":{"astro":"^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tailwindcss":"^3.3.0","@astrojs/tailwind":"^5.0.0","@tailwindcss/typography":"^0.5.10"},"_npmOperationalInternal":{"tmp":"tmp/astro-docs-minimal_1.0.3_1775509718054_0.7035085955680911","host":"s3://npm-registry-packages-npm-production"}},"1.0.4":{"name":"@ardesh1r/astro-docs-minimal","version":"1.0.4","keywords":["astro","astro-theme","documentation","docs","minimal","clean","responsive","withastro","api-documentation","knowledge-base","technical-docs","dark-mode","tailwind-css","markdown","static-site-generator","jamstack","fast","performance","accessible"],"author":{"name":"Ardeshir Shojaei"},"license":"MIT","_id":"@ardesh1r/astro-docs-minimal@1.0.4","maintainers":[{"name":"ardesh1r","email":"ardeshir.shojaei@gmail.com"}],"homepage":"https://ardeshirshojaei.com","bugs":{"url":"https://github.com/Ardesh1r/astro-docs-minimal/issues"},"dist":{"shasum":"8af04337ded807a521d13d96a9667da1b7c609c1","tarball":"https://registry.npmjs.org/@ardesh1r/astro-docs-minimal/-/astro-docs-minimal-1.0.4.tgz","fileCount":26,"integrity":"sha512-S8wdEvdO95qBL9238oqoKcAIVCOXAi0ZI2pL/832PIq/jynKLrQEQbqGuVzStdDCzpvCR7hdagmQhh0MgTtFIA==","signatures":[{"sig":"MEUCIAWRkQSI0keZyJjvtxB57801ct/8MSBa2IBdF4hXNrX1AiEAki7EIBS1O+ewWE6t/BCPp8GSlEnbOUj5qIpisDrqsNM=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":89815},"type":"module","gitHead":"d5d1a35c0980702787f2d61299c06da9c9892f65","scripts":{"dev":"astro dev","astro":"astro","build":"astro build","preview":"astro preview"},"_npmUser":{"name":"ardesh1r","email":"ardeshir.shojaei@gmail.com"},"repository":{"url":"git+https://github.com/Ardesh1r/astro-docs-minimal.git","type":"git"},"_npmVersion":"11.9.0","description":"Minimal, fast documentation theme for Astro. Build beautiful technical docs, API documentation, and knowledge bases with dark mode, responsive design, and zero configuration.","directories":{},"_nodeVersion":"24.14.0","dependencies":{"astro":"^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tailwindcss":"^3.3.0","@astrojs/tailwind":"^5.0.0","@tailwindcss/typography":"^0.5.10"},"_npmOperationalInternal":{"tmp":"tmp/astro-docs-minimal_1.0.4_1775512181875_0.042465463722004326","host":"s3://npm-registry-packages-npm-production"}},"1.0.5":{"name":"@ardesh1r/astro-docs-minimal","version":"1.0.5","description":"Minimal, fast documentation theme for Astro. Build beautiful technical docs, API documentation, and knowledge bases with dark mode, responsive design, and zero configuration.","type":"module","scripts":{"dev":"astro dev","build":"astro build","preview":"astro preview","astro":"astro"},"keywords":["astro","astro-theme","documentation","docs","minimal","clean","responsive","withastro","api-documentation","knowledge-base","technical-docs","dark-mode","tailwind-css","markdown","static-site-generator","jamstack","fast","performance","accessible"],"homepage":"https://ardeshirshojaei.com","repository":{"type":"git","url":"git+https://github.com/Ardesh1r/astro-docs-minimal.git"},"bugs":{"url":"https://github.com/Ardesh1r/astro-docs-minimal/issues"},"author":{"name":"Ardeshir Shojaei"},"license":"MIT","dependencies":{"astro":"^4.0.0"},"devDependencies":{"@astrojs/tailwind":"^5.0.0","tailwindcss":"^3.3.0","@tailwindcss/typography":"^0.5.10"},"gitHead":"938132b2338350ffe9fb71ecf0a629552682dca8","_id":"@ardesh1r/astro-docs-minimal@1.0.5","_nodeVersion":"24.14.0","_npmVersion":"11.9.0","dist":{"integrity":"sha512-zeKb3JvHgUlUp47S/U+FkBSUK7948gohxTMHzyOw7yezhJVVpNx/wJfsym4M99oWxpNs1CgYuy7El3MqW2j5bw==","shasum":"114218cc281720e90a3406cc01136fcfb67df49d","tarball":"https://registry.npmjs.org/@ardesh1r/astro-docs-minimal/-/astro-docs-minimal-1.0.5.tgz","fileCount":27,"unpackedSize":96237,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQD/M4nOLNdmNpaD/0s+oavE5uInZl7fbLQIYrgdOYfclgIgO0I+rMyaEYB4JyM3rRK8vyvMgO/+ac5PmRZWbVBqaK8="}]},"_npmUser":{"name":"ardesh1r","email":"ardeshir.shojaei@gmail.com"},"directories":{},"maintainers":[{"name":"ardesh1r","email":"ardeshir.shojaei@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/astro-docs-minimal_1.0.5_1775512614682_0.5620189584149462"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-06T20:47:45.129Z","modified":"2026-04-06T21:56:54.957Z","1.0.0":"2026-04-06T20:47:45.399Z","1.0.2":"2026-04-06T21:00:05.821Z","1.0.3":"2026-04-06T21:08:38.244Z","1.0.4":"2026-04-06T21:49:42.060Z","1.0.5":"2026-04-06T21:56:54.832Z"},"bugs":{"url":"https://github.com/Ardesh1r/astro-docs-minimal/issues"},"author":{"name":"Ardeshir Shojaei"},"license":"MIT","homepage":"https://ardeshirshojaei.com","keywords":["astro","astro-theme","documentation","docs","minimal","clean","responsive","withastro","api-documentation","knowledge-base","technical-docs","dark-mode","tailwind-css","markdown","static-site-generator","jamstack","fast","performance","accessible"],"repository":{"type":"git","url":"git+https://github.com/Ardesh1r/astro-docs-minimal.git"},"description":"Minimal, fast documentation theme for Astro. Build beautiful technical docs, API documentation, and knowledge bases with dark mode, responsive design, and zero configuration.","maintainers":[{"name":"ardesh1r","email":"ardeshir.shojaei@gmail.com"}],"readme":"# astro-docs-minimal\n\nA minimal, fast, and beautiful documentation theme for Astro. Build stunning technical documentation, API docs, and knowledge bases with zero configuration.\n\n[![npm version](https://img.shields.io/npm/v/@ardesh1r/astro-docs-minimal.svg)](https://www.npmjs.com/package/@ardesh1r/astro-docs-minimal)\n[![npm downloads](https://img.shields.io/npm/dw/@ardesh1r/astro-docs-minimal.svg)](https://www.npmjs.com/package/@ardesh1r/astro-docs-minimal)\n\n## What is astro-docs-minimal?\n\nA production-ready documentation theme designed for developers, technical writers, and open-source maintainers. Built with Astro for lightning-fast performance and Tailwind CSS for beautiful, customizable styling.\n\n## Target Audience\n\n- **Developers** building API documentation and technical guides\n- **Open-source maintainers** documenting projects and libraries\n- **Technical writers** creating knowledge bases and tutorials\n- **SaaS companies** building product documentation\n- **Educators** creating course materials and learning resources\n- **Teams** needing fast, maintainable documentation sites\n\n## What to Expect\n\n### Performance\n- **Instant page loads** with Astro's static site generation\n- **Optimized bundle size** (~8.2 KB gzipped)\n- **Zero JavaScript** by default (100% Lighthouse score possible)\n- **Fast build times** even with hundreds of pages\n\n### Developer Experience\n- **Zero configuration** - works out of the box\n- **Markdown-based** - write docs in familiar Markdown\n- **Easy customization** - Tailwind CSS for styling\n- **Component-based** - reusable Astro components\n- **Type-safe** - full TypeScript support\n\n### User Experience\n- **Dark/light mode** with automatic system detection\n- **Responsive design** - mobile, tablet, desktop\n- **Accessible** - WCAG compliant components\n- **Fast navigation** - instant sidebar and search\n- **Beautiful typography** - optimized for reading\n\n## Features\n\n- āœØ Clean, minimal design focused on content\n- šŸŒ™ Dark/light mode with automatic system preference detection\n- šŸ“± Responsive sidebar navigation with mobile hamburger menu\n- šŸŽØ Beautiful syntax highlighting for code blocks\n- šŸ“‘ Auto-generated table of contents from headings\n- āš” Lightning-fast performance with Astro\n- šŸŽÆ Easy to customize with Tailwind CSS\n- šŸ” SEO-friendly with proper meta tags and structured data\n- ā™æ Accessible components following WCAG guidelines\n- šŸ“¦ Zero dependencies beyond Astro and Tailwind CSS\n\n## Quick Start\n\n### Option 1: Use as Astro Theme Template\n\n```bash\nnpm create astro@latest -- --template Ardesh1r/astro-docs-minimal\ncd my-docs\nnpm run dev\n```\n\n### Option 2: Clone the Repository\n\n```bash\ngit clone https://github.com/Ardesh1r/astro-docs-minimal.git\ncd astro-docs-minimal\nnpm install\nnpm run dev\n```\n\nThe site will be available at `http://localhost:3000`.\n\n### Option 3: Install as npm Package\n\n```bash\nnpm install @ardesh1r/astro-docs-minimal\n```\n\nThen use it in your Astro project.\n\n## Project Structure\n\n```\nastro-docs-minimal/\nā”œā”€ā”€ src/\nā”‚ ā”œā”€ā”€ components/ # Reusable components\nā”‚ ā”œā”€ā”€ layouts/ # Page layouts\nā”‚ ā”œā”€ā”€ pages/ # Page routes\nā”‚ ā”‚ ā””ā”€ā”€ docs/ # Documentation pages\nā”‚ ā”œā”€ā”€ styles/ # Global styles\nā”‚ ā””ā”€ā”€ utils/ # Utility functions\nā”œā”€ā”€ public/ # Static assets\nā”œā”€ā”€ astro.config.mjs # Astro configuration\nā”œā”€ā”€ tailwind.config.mjs # Tailwind configuration\nā””ā”€ā”€ package.json\n```\n\n## Usage\n\n### Creating Documentation Pages\n\nCreate new markdown files in `src/pages/docs/`:\n\n```markdown\n---\nlayout: ../../layouts/DocsLayout.astro\ntitle: Page Title\ndescription: Page description\n---\n\n# Your Content\n\nYour markdown content here...\n```\n\n### Customizing Navigation\n\nEdit the `navigation` array in `src/components/Sidebar.astro`:\n\n```javascript\nconst navigation = [\n { label: 'Getting Started', href: '/docs/getting-started' },\n { label: 'Your Page', href: '/docs/your-page' },\n]\n```\n\n### Customizing Colors\n\nEdit `tailwind.config.mjs`:\n\n```javascript\ncolors: {\n primary: '#3b82f6',\n dark: '#1f2937',\n}\n```\n\n## Building for Production\n\n```bash\nnpm run build\n```\n\nThe built site will be in the `dist/` directory.\n\n## Deployment\n\nDeploy the `dist/` folder to your hosting provider:\n\n- [Netlify](https://netlify.com)\n- [Vercel](https://vercel.com)\n- [GitHub Pages](https://pages.github.com)\n- [Cloudflare Pages](https://pages.cloudflare.com)\n\n## Components\n\n- **Header** - Top navigation with theme toggle\n- **Sidebar** - Left navigation menu\n- **TableOfContents** - Right sidebar with page headings\n- **Footer** - Footer with links\n- **ThemeToggle** - Dark/light mode toggle\n- **MobileMenu** - Mobile navigation toggle\n\n## Layouts\n\n- **BaseLayout** - Base layout for all pages\n- **DocsLayout** - Layout for documentation pages with sidebar and TOC\n\n## License\n\nMIT - Feel free to use this theme for personal and commercial projects.\n\n## Support\n\nFor issues, questions, or suggestions, please open an issue on GitHub.\n\n## Credits\n\nBuilt with [Astro](https://astro.build) and [Tailwind CSS](https://tailwindcss.com).\n","readmeFilename":"README.md"}