# shipyard

> shipyard is an Astro-based page builder for creating documentation sites, blogs, and content-focused websites with responsive design, i18n support, and modular components.

shipyard provides three packages: @levino/shipyard-base (core layouts and configuration), @levino/shipyard-docs (documentation features with sidebar and pagination), and @levino/shipyard-blog (blog functionality). It uses Tailwind CSS 4 with DaisyUI 5 for styling.

## Quick Start

Install packages:
```bash
npm install @levino/shipyard-base @levino/shipyard-docs tailwindcss daisyui @tailwindcss/typography @tailwindcss/vite
```

Configure astro.config.mjs:
```javascript
import shipyard from '@levino/shipyard-base'
import shipyardDocs from '@levino/shipyard-docs'
import tailwindcss from '@tailwindcss/vite'
import { defineConfig } from 'astro/config'

export default defineConfig({
  vite: {
    plugins: [tailwindcss()],
  },
  integrations: [
    shipyard({
      brand: 'My Site',
      title: 'My Site',
      tagline: 'Built with shipyard',
      navigation: {
        docs: { label: 'Docs', href: '/docs' },
      },
    }),
    shipyardDocs(),
  ],
})
```

Configure src/content.config.ts (Astro 5+):
```typescript
import { defineCollection } from 'astro:content'
import { createDocsCollection } from '@levino/shipyard-docs'

const docs = defineCollection(createDocsCollection('./docs'))
export const collections = { docs }
```

Example docs frontmatter (docs/index.md):
```yaml
---
title: Getting Started
sidebar:
  position: 1
description: Introduction to my project
---
```

## Key Documentation Pages

- [Getting Started](/en/docs/getting-started) - Full setup guide
- [Base Package](/en/docs/base-package) - Layouts, navigation, and configuration
- [Docs Package](/en/docs/docs-package) - Sidebar, pagination, and frontmatter options

## Documentation

- [Code Style Guide](https://shipyard.levinkeller.de/docs/_llms-txt/contributing/code-style.txt): Coding conventions for shipyard contributors
- [Comparison with Other Tools](https://shipyard.levinkeller.de/docs/_llms-txt/why-shipyard/comparison.txt)
- [Functional Programming](https://shipyard.levinkeller.de/docs/_llms-txt/contributing/code-style/functional-programming.txt): Functional programming conventions for shipyard
- [Getting Started](https://shipyard.levinkeller.de/docs/_llms-txt/getting-started.txt): Learn how to install and configure shipyard for your Astro project
- [The shipyard Philosophy](https://shipyard.levinkeller.de/docs/_llms-txt/why-shipyard/philosophy.txt)
- [@levino/shipyard-base](https://shipyard.levinkeller.de/docs/_llms-txt/base-package.txt): Core package providing layouts and configuration for shipyard
- [Naming Conventions](https://shipyard.levinkeller.de/docs/_llms-txt/contributing/code-style/naming-conventions.txt): Naming conventions for shipyard
- [Sustainability & Production Readiness](https://shipyard.levinkeller.de/docs/_llms-txt/why-shipyard/sustainability.txt)
- [@levino/shipyard-docs](https://shipyard.levinkeller.de/docs/_llms-txt/docs-package.txt): Documentation plugin for shipyard with automatic sidebar and pagination
- [Documentation Through Code](https://shipyard.levinkeller.de/docs/_llms-txt/contributing/code-style/documentation-through-code.txt): Let code document itself through clear names and types
- [@levino/shipyard-blog](https://shipyard.levinkeller.de/docs/_llms-txt/blog-package.txt): Blog plugin for shipyard with pagination and sidebar
- [Web Components and Native APIs](https://shipyard.levinkeller.de/docs/_llms-txt/contributing/code-style/web-components.txt): Use custom elements instead of frameworks for interactivity
- [Server Mode (SSR)](https://shipyard.levinkeller.de/docs/_llms-txt/server-mode.txt): Learn how to use shipyard with Astro's server-side rendering (SSR) mode
- [Docusaurus Feature Parity Roadmap](https://shipyard.levinkeller.de/docs/_llms-txt/roadmap.txt): Detailed roadmap showing Docusaurus features that shipyard supports or plans to support
- [Basic Versioning](https://shipyard.levinkeller.de/docs/_llms-txt/examples/basic-versioning.txt): Minimal setup for versioned documentation
- [Contributing](https://shipyard.levinkeller.de/docs/_llms-txt/contributing.txt)
- [Documentation Versioning](https://shipyard.levinkeller.de/docs/_llms-txt/guides/versioning.txt): Learn how to create versioned documentation with shipyard
- [Examples](https://shipyard.levinkeller.de/docs/_llms-txt/examples.txt): Copy-paste examples for common shipyard configurations
- [Guides](https://shipyard.levinkeller.de/docs/_llms-txt/guides.txt): In-depth guides for shipyard features
- [Migrating to Versioned Docs](https://shipyard.levinkeller.de/docs/_llms-txt/guides/migration-to-versioned.txt): Step-by-step guide for migrating existing documentation to versioned docs
- [shipyard Documentation](https://shipyard.levinkeller.de/docs/_llms-txt/en.txt)
- [Version Lifecycle](https://shipyard.levinkeller.de/docs/_llms-txt/examples/version-lifecycle.txt): Managing the complete lifecycle of documentation versions
- [Versioning with i18n](https://shipyard.levinkeller.de/docs/_llms-txt/examples/versioning-with-i18n.txt): Combine documentation versioning with internationalization
- [Why shipyard?](https://shipyard.levinkeller.de/docs/_llms-txt/why-shipyard.txt)