{"id":31740421,"url":"https://github.com/minagishl/handbook","last_synced_at":"2026-05-09T03:31:22.663Z","repository":{"id":318481201,"uuid":"1071386460","full_name":"minagishl/handbook","owner":"minagishl","description":"A Simple Documentation Site Using Astro and Tailwind CSS","archived":false,"fork":false,"pushed_at":"2025-10-07T12:51:41.000Z","size":74,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-07T13:35:52.354Z","etag":null,"topics":["astro","documentation","tailwindcss"],"latest_commit_sha":null,"homepage":"https://handbook.minagishl.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/minagishl.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},"funding":{"custom":"https://minagishl.com/amazon-wishlist"}},"created_at":"2025-10-07T09:26:36.000Z","updated_at":"2025-10-07T12:59:17.000Z","dependencies_parsed_at":"2025-10-07T13:35:56.381Z","dependency_job_id":null,"html_url":"https://github.com/minagishl/handbook","commit_stats":null,"previous_names":["minagishl/handbook"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/minagishl/handbook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minagishl%2Fhandbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minagishl%2Fhandbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minagishl%2Fhandbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minagishl%2Fhandbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/minagishl","download_url":"https://codeload.github.com/minagishl/handbook/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minagishl%2Fhandbook/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001318,"owners_count":26083040,"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-09T02:00:07.460Z","response_time":59,"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":["astro","documentation","tailwindcss"],"created_at":"2025-10-09T10:18:43.669Z","updated_at":"2025-10-09T10:18:45.119Z","avatar_url":"https://github.com/minagishl.png","language":"TypeScript","funding_links":["https://minagishl.com/amazon-wishlist"],"categories":[],"sub_categories":[],"readme":"# Handbook\n\nA GitBook-inspired handbook site powered by [Astro 5](https://astro.build) and [Tailwind CSS v4](https://tailwindcss.com). Markdown content drives the navigation, while reusable Astro layouts deliver a polished authoring experience without maintaining a custom color system.\n\n## Quick start\n\n```bash\npnpm install\npnpm dev\n```\n\nThe dev server runs at `http://localhost:4321`. Press `/` from any page to focus the header search field. Build static assets for deployment with:\n\n```bash\npnpm build\n```\n\nThe production output lives in `./dist` and can be hosted on any static provider (GitHub Pages, Netlify, Vercel, Cloudflare Pages, or an internal CDN).\n\n## Project structure\n\n```\n/\n├── public/                      # Static assets served at the root URL\n├── src/\n│   ├── components/              # Layout shell pieces (header, sidebar, TOC, theme toggle)\n│   ├── content/\n│   │   ├── config.ts            # Zod schema for the `docs` collection\n│   │   └── docs/                # Markdown sources grouped by directory\n│   ├── layouts/\n│   │   └── DocsLayout.astro     # GitBook-style three-column layout with slots\n│   ├── pages/\n│   │   ├── docs/[...slug].astro # Dynamic renderer for every handbook article\n│   │   └── index.astro          # Redirects to the first available doc, or shows onboarding\n│   ├── styles/\n│   │   └── global.css           # Tailwind directives, typography plugin, custom utilities\n│   └── utils/\n│       └── navigation.ts        # Builds grouped sidebar data and next/previous links\n├── astro.config.mjs             # Adds the @tailwindcss/vite plugin to Vite\n├── package.json\n└── README.md\n```\n\n## Authoring content\n\n1. Add Markdown files under `src/content/docs`. Nested folders create nested slugs (e.g. `src/content/docs/overview/introduction.md` → `/docs/overview/introduction`).\n2. Include frontmatter fields:\n   - `title`: page heading and sidebar label\n   - `description`: optional summary in cards and meta tags\n   - `group`: sidebar section (e.g. `Overview`, `Content`, `Customization`)\n   - `order`: numeric ordering within the group\n3. Use standard Markdown, MDX shortcodes, or Astro components. The layout applies Tailwind's `prose` typography styles automatically.\n\n## Customization guide\n\n- **Tailwind tokens:** extend spacing, radius, or typography in `src/styles/global.css` using CSS variables (e.g., `@theme { ... }`). Tailwind v4 removes the need to maintain a manual color palette—lean on built-in palettes like `slate`, `sky`, and `emerald` for consistent theming.\n- **Layout tweaks:** adjust grid templates, card styling, or utility classes inside `src/styles/global.css`. The stylesheet defines `.docs-grid`, `.docs-sidebar`, `.docs-card`, and `.docs-toc` helpers for quick experimentation.\n- **Navigation logic:** update `src/utils/navigation.ts` if you need custom grouping or filtering rules. Hidden pages can set `sidebar.hidden: true` in frontmatter.\n- **Header links:** configure `src/config/site.ts` to add call-to-action links beside the search box. Provide `label`, `href`, and optional `external: true` to open in a new tab.\n- **Theme presets:** the header theme toggle stores preferences in `localStorage` and respects `prefers-color-scheme`. Add new schemes by extending the toggle script and creating additional `body[data-theme=\"*\"]` selectors.\n\n## Recommended workflows\n\n- Commit new docs alongside automated previews so stakeholders can review rendered content.\n- Schedule dependency updates monthly (`astro`, `tailwindcss`, `@tailwindcss/vite`, `@tailwindcss/typography`).\n- Add automated linting or visual regression tests as the component surface grows.\n\nEnjoy building a highly customizable handbook without sacrificing maintainability.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminagishl%2Fhandbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminagishl%2Fhandbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminagishl%2Fhandbook/lists"}