astro README

The project's README from github.com/withastro/astro. As one markdown file: README.md.

Build the web you want


Astro is a website build tool for the modern web —
powerful developer experience meets lightweight output.

main License npm version

Install

The recommended way to install the latest version of Astro is by running the command below:

npm create astro@latest

You can also install Astro manually by running this command instead:

npm install astro

Looking for help? Start with our Getting Started guide.

Looking for quick examples? Open a starter project right in your browser.

Documentation

Visit our official documentation.

Support

Having trouble? Get help in the official Astro Discord or via GitHub discussions.

Contributing

New contributors welcome! Check out our Contributors Guide for help getting started.

Join us on Discord to meet other maintainers. We'll help you get your first contribution in no time!

Directory

Package Release Notes
astro astro version
create-astro create-astro version
@astrojs/react @astrojs/react version
@astrojs/preact @astrojs/preact version
@astrojs/solid-js @astrojs/solid version
@astrojs/svelte @astrojs/svelte version
@astrojs/vue @astrojs/vue version
@astrojs/node @astrojs/node version
@astrojs/vercel @astrojs/vercel version
@astrojs/cloudflare @astrojs/cloudflare version
@astrojs/partytown @astrojs/partytown version
@astrojs/sitemap @astrojs/sitemap version
@astrojs/alpinejs @astrojs/alpinejs version
@astrojs/mdx @astrojs/mdx version
@astrojs/rss @astrojs/rss version
@astrojs/netlify @astrojs/netlify version
@astrojs/check astro-check version
@astrojs/language-server @astrojs/language-server version
@astrojs/ts-plugin @astrojs/ts-plugin version
astro-vscode astro-vscode version

CII Best Practices

Several official projects are maintained outside of this repo:

Project Repository
@astrojs/compiler withastro/compiler
Starlight withastro/starlight

Sponsors

Astro is free, open source software made possible by these wonderful sponsors.

❤️ Sponsor Astro! ❤️

Sponsor logos including the current Astro Sponsors, Gold Sponsors, and Exclusive Partner Sponsors: Netlify, Sentry, and Project IDX.

astro (withastro/astro)

Searching Database…

63.3K ·GitHub
这是什么?Astro 是一个免费开源的 Web 框架,用于搭建以内容为主的网站,比如博客和其他内容量大的站点,开发体验很好,生成的页面也很轻量。
它是一个我直接运行的软件,还是用来建网站的工具?它是用来建站的:Astro 以一组 npm 包的形式发布——包括 astro 核心、create-astro 项目脚手架以及官方集成,而不是一个开箱即用的应用程序。
我该怎么用它新建一个网站?用 create-astro 创建一个新项目(这是 README 推荐的安装方式),或者把 Astro 手动添加到现有项目里,然后按照入门指南操作即可。
使用之前我需要先安装什么?需要 Node.js:仓库的 engines 字段要求 Node 22.12.0 或更新版本。这个仓库本身用 pnpm 和 Turbo 构建,但只有在你参与开发 Astro 源代码时才需要关心这些。
我用什么操作系统有影响吗?基本没影响——Astro 是一个 Node.js 命令行工具,在 Windows、macOS 和 Linux 上都能运行,它生成的是普通网站,任何网站托管服务都能部署。
它可以搭配哪些 UI 框架?官方集成支持 React、Preact、Svelte、Solid、Vue 和 Alpine.js,另外还有用于 MDX 内容、RSS 订阅和站点地图的插件。
做好的网站可以部署到哪里?官方适配器支持 Node、Vercel、Cloudflare 和 Netlify,同一个项目既可以作为静态网站发布,也可以作为服务端渲染的应用发布。
安装之前我能先试用一下吗?可以——README 里提供了一些快速示例,直接在浏览器里就能作为入门项目打开,不需要在本地做任何配置。
Creator
withastro
Size
234.7 MB
Stars
63.3K
Age
5y
Commits · 90 Days