| .astro | ||
| .kbot | ||
| docs | ||
| packages | ||
| public | ||
| scripts | ||
| src | ||
| systems | ||
| temp | ||
| tests | ||
| undefined/glossary/en | ||
| .env.dev | ||
| .env.prod | ||
| .gitignore | ||
| astro-imagetools.config.mjs | ||
| astro.config.mjs | ||
| frontmatter.json | ||
| lang_storeEntries.json | ||
| package-lock.json | ||
| package.json | ||
| playwright.config.ts | ||
| pnpm-lock.yaml | ||
| postcss.config.cjs | ||
| README.md | ||
| storeEntries.json | ||
| sync-deploy.json | ||
| sync-playground.json | ||
| tailwind.config.cjs | ||
| tsconfig.json | ||
Williamsburg
Template Integrations
- Tailwind CSS v4
- Astro SEO - Powered by @astrolib/seo
- Astro Sitemap - https://docs.astro.build/en/guides/integrations-guide/sitemap/
Template Structure
The template follows a typical Astro project structure. You'll find the following key directories and files:
/
├── public/
├── src/
│ └── pages/
│ └── index.astro
└── package.json
src/pages/: Contains.astroand.mdfiles. Each file becomes a route in your project based on its name.src/components/: Ideal for placing your Astro/React/Vue/Svelte/Preact components.public/: For static assets such as images that you want to serve directly.
Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:3000 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add, astro check |
npm run astro --help |
Get help using the Astro CLI |
Learn more - Explore more through Astro's official documentation.
Updated on 30th December 2024
This update includes:
-
Add Tailwind CSS v4 Beta On this version, Tailwind CSS is now beta version from Tailwind CSS V4, this means that there's no
tailwind.config.mjsfile anymore. From now on, all style will be added on thecssfile. You can find the styles on thesrc/styles/global.cssfile. -
Astro V5 This update includes Astro V5, which is a major update that includes several new features and improvements.
-
Astro SEO by @astrolib/seo This update includes the integration of the Astro SEO package by @astrolib/seo, is an integration that makes managing your SEO easier in Astro projects. It is fully based on the excellent Next SEO library
On the next update
-
Add Image component from Astro The Astro Image component is coming back to the themes
-
Reusable components This template now includes reusable components, such as the
Textcomponent: -
Text Component
A versatile and reusable component for handling text across your project, ensuring consistency and easy customization. -
HTML Tags: Easily change the HTML element (like
p,h1,span,a) using thetagprop, withpbeing the default. -
Variants: Pick from preset text styles (such as
displayXLortextBase) for a consistent look. -
Custom Classes: Add or adjust styles with the
classprop. -
Accessibility: Customize with additional props like
id,href,title, andstyle. -
Content Slot: Add any content inside the component, including optional left and right icons. Example usage:
<Text tag="h1" variant="displayXL" class="text-center">
Welcome to the new version!
</Text>
-
Button Component
A customizable button component with options to fit your design needs: -
Variants: Choose from predefined styles like
primary(dark background) andsecondary(lighter background), with support for dark mode. -
Sizes: Select
smallormediumfor different button heights and padding. -
Gaps: Control the spacing between content with the
gapSizeprop (eithersmallormedium). -
Custom Classes: Apply additional styles using the
classprop. -
Slots: Include icons or extra content with optional
left-iconandright-iconslots.
Example usage:
<Button size="small" variant="primary">Primary small</Button>
-
Wrapper Component
A flexible layout component that helps with consistent spacing and alignment. -
Variants: The default
standardvariant includes responsive widths, centered content, and padding. -
Custom Classes: Add or change styles with the
classprop. -
Content Slot: Easily add any child components or content inside.
<Wrapper variant="standard">
Your content goes here
</Wrapper>
Support
Documentation
Get your bundle
References
-PWA