repository·main·Indexed 23 days ago
https://github.com/withastro/docsThe source code and content for the official Astro documentation site (docs.astro.build). This repository includes the site configuration logic, custom Astro integrations, remark and rehype plugins, and comprehensive i18n guides and glossaries for translating documentation into languages such as Portuguese (PT-BR), Korean, and Japanese.
Astro's Content Loader API enables you to load data from any source—whether local or remote—and integrate it into Astro's content layer. This allows you to manage external data using the same workflows and features as content collections.
The API provides:
Astro Actions are type-safe server functions that allow you to define backend logic that can be called from anywhere (client-side components, <script> tags, or HTML forms). They provide built-in support for:
fetch() calls.ActionError object to provide consistent error handling with status codes.Astro provides two types of content collections to manage and render content:
astro:actions module provides all the necessary utilities to define, call, and handle errors for these actions. This feature ensures that the data sent to and received from your server-side logic is type-safe across the network boundary.The Dev toolbar includes several built-in applications:
astro info and copies the output to your clipboard.Astro uses an opinionated folder layout, though most directories are conventions rather than strict requirements. The core organization revolves around src/ for processed source code and public/ for unprocessed assets.
src/: Contains your project source code (components, pages, layouts, styles, images, etc.). Files here are processed, optimized, and bundled by Astro.public/: Contains non-code, unprocessed assets (fonts, icons, robots.txt, etc.). Files here are copied to the build folder untouched and are not optimized or bundled.package.json: Project manifest for managing dependencies and scripts (e.g., npm run dev).astro.config.mjs: The Astro configuration file used to specify integrations, build options, and server settings.tsconfig.json: TypeScript configuration file (recommended for editor support and type checking).The config/ directory contains the logic used to configure the documentation site via astro.config.ts. It is organized into several functional areas:
integrations/: Contains custom Astro integrations specifically designed for the docs site.plugins/: Contains plugins for remark (Markdown processing), rehype (HTML processing), or Starlight (the documentation framework).Astro supports importing most static assets with zero configuration using the ESM import statement. This works in Astro frontmatter, JavaScript, and TypeScript files. @import is also supported within CSS and <style> tags.
Out-of-the-box supported types:
.astro).md, .markdown, etc.).js, .mjs).ts).json).css).module.css).svg, .jpg, .png, etc.)Extensible support:
.mdx or .mdoc files via the Astro MDX or Astro Markdoc integrations.A renderer is a special type of Astro integration that enables support for new component syntaxes (like UI framework components) that Astro does not handle natively.
A renderer consists of two parts:
To add a renderer, create an integration and call addRenderer() within the astro:config:setup hook.
export default function createIntegration() {
return {
name: "@example/my-renderer",
hooks: {
"astro:config:setup": ({ addRenderer }) => {
addRenderer({
name: "@example/my-renderer",
clientEntrypoint: "@example/my-renderer/client.js",
serverEntrypoint: "@example/my-renderer/server.js",
});
},
},
};
}Astro uses Islands Architecture to keep websites fast by rendering the majority of a page as static HTML and only adding small, isolated "islands" of JavaScript where interactivity or personalization is required.
This approach, also known as partial or selective hydration, avoids the heavy monolithic JavaScript payloads typical of Single-Page Applications (SPAs). In Astro, islands run in isolation from one another, allowing you to mix multiple UI frameworks (like React, Svelte, or Vue) on a single page without them interfering with each other.
An adapter is a specialized type of integration that enables on-demand rendering (Server-Side Rendering/SSR) for specific cloud providers. It performs two primary roles:
The Astro Docs MCP (Model Context Protocol) server provides AI tools with real-time access to the latest Astro documentation. This helps prevent AI models from using outdated information and ensures they follow current best practices. The server is free, open-source, and runs remotely via HTTP, meaning no local installation is required.
https://mcp.docs.astro.build/mcp