{"id":23621557,"url":"https://github.com/code-gio/svelte-docs-starter","last_synced_at":"2025-02-26T22:18:05.784Z","repository":{"id":269773128,"uuid":"900662063","full_name":"code-gio/svelte-docs-starter","owner":"code-gio","description":"A modern documentation template built with Svelte 5, MDSvex, and TailwindCSS. Create beautiful, accessible documentation with features like automatic navigation, dark mode, search, and more.","archived":false,"fork":false,"pushed_at":"2024-12-30T05:46:45.000Z","size":234,"stargazers_count":19,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-09T17:56:29.408Z","etag":null,"topics":["documentation-template","mdsvex","svelte","sveltekit"],"latest_commit_sha":null,"homepage":"https://svelte-docs.codegio.com/","language":"Svelte","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/code-gio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-12-09T08:36:41.000Z","updated_at":"2025-01-08T09:01:37.000Z","dependencies_parsed_at":"2024-12-26T04:21:33.440Z","dependency_job_id":"eed83d4c-9ebc-4d24-a24a-94a8e912fa20","html_url":"https://github.com/code-gio/svelte-docs-starter","commit_stats":null,"previous_names":["code-gio/svelte-docs-starter"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-gio%2Fsvelte-docs-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-gio%2Fsvelte-docs-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-gio%2Fsvelte-docs-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-gio%2Fsvelte-docs-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/code-gio","download_url":"https://codeload.github.com/code-gio/svelte-docs-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240941516,"owners_count":19882063,"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","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":["documentation-template","mdsvex","svelte","sveltekit"],"created_at":"2024-12-27T20:01:18.880Z","updated_at":"2025-02-26T22:18:05.760Z","avatar_url":"https://github.com/code-gio.png","language":"Svelte","funding_links":[],"categories":["Scaffold","Recently Updated"],"sub_categories":["Miscellaneous","[Dec 27, 2024](/content/2024/12/27/README.md)"],"readme":"# Documentation Template\n\nA modern documentation template built with Svelte 5, MDSvex, and Tailwind CSS.\n\n[Template Preview](https://svelte-docs.codegio.com/)\n\n## Overview\n\nCreate beautiful, modern documentation sites with minimal setup. This template combines the power of Svelte 5 with the flexibility of Markdown to deliver a superior documentation experience.\n\n## Features\n\n- **📚 MDSvex Integration** - Write documentation in Markdown with Svelte components\n- **🎨 Modern Design** - Built with Tailwind CSS and shadcn/ui components\n- **🌙 Dark Mode** - Automatic dark mode with system preference detection\n- **🔍 Search** - Built-in search functionality powered by FlexSearch\n- **📱 Responsive** - Mobile-first design that works on all devices\n- **📑 Auto-Navigation** - Automatic documentation structure generation\n- **📖 Table of Contents** - Dynamic table of contents for each page\n- **⚡ Fast** - Optimized for speed and performance\n- **🔒 Type Safe** - Full TypeScript support\n\n## Quick Start\n\n1. Click the green \"Use this template\" button\n2. Create a new repository\n3. Clone your repository:\n   ```bash\n   git clone https://github.com/yourusername/your-repo-name.git\n   ```\n4. Install dependencies:\n   ```bash\n   cd your-repo-name\n   npm install\n   ```\n5. Start the development server:\n   ```bash\n   npm run dev\n   ```\n\n## Project Structure\n\n```\nyour-project/\n├── src/\n│   ├── content/          # Documentation markdown files\n│   ├── lib/\n│   │   ├── components/   # Core components\n│   │   │   ├── document/ # Document-related components\n│   │   │   ├── home/     # Home page components\n│   │   │   └── ui/       # UI components\n│   │   ├── hooks/        # Custom hooks\n│   │   ├── types/        # TypeScript type definitions\n│   │   ├── config.ts     # Site configuration\n│   │   ├── index.ts      # Library exports\n│   │   └── utils.ts      # Utility functions\n│   ├── routes/           # SvelteKit routes\n│   ├── app.css          # Global styles\n│   ├── app.d.ts         # TypeScript declarations\n│   └── app.html         # HTML template\n└── static/              # Static assets\n```\n\n## Writing Documentation\n\nPlace your markdown files in the `src/content` directory. The folder structure will automatically generate the navigation.\n\n```markdown\n---\ntitle: Getting Started\ndescription: Learn how to use this template\n---\n\n# Getting Started\n\nWrite your documentation here...\n```\n\n## Customization\n\n### Themes\nModify the theme in `src/app.css` or use pre-built themes from [shadcn-svelte](https://next.shadcn-svelte.com/themes).\n\n### Components\nCustomize components in `src/lib/components` to match your brand.\n\n### Configuration\nUpdate site settings in `src/lib/config`:\n```typescript\nexport const siteConfig = {\n    title: 'Your Documentation',\n    description: 'Your site description',\n    // ...other settings\n};\n```\n\n## Development\n\n```bash\n# Start development server\nnpm run dev\n\n# Build for production\nnpm run build\n\n# Preview production build\nnpm run preview\n```\n\n## Deployment\n\nThis template can be deployed to any static hosting platform:\n\n- Vercel\n- Netlify\n- GitHub Pages\n- Cloudflare Pages\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nMIT License - use this template for any project.\n\n## Acknowledgments\n\n- [Svelte](https://svelte.dev)\n- [shadcn-svelte](https://next.shadcn-svelte.com)\n- [Tailwind CSS](https://tailwindcss.com)\n- [MDSvex](https://mdsvex.com)\n\n## Support\n\nNeed help with your documentation? [Contact us](mailto:info@codegio.com).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-gio%2Fsvelte-docs-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcode-gio%2Fsvelte-docs-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-gio%2Fsvelte-docs-starter/lists"}