在 Astro + Starlight 项目中,将看到以下文件夹和文件:
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ └── content.config.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
Starlight 在 src/content/docs/ 目录中查找 .md 和 .mdx 文件。
每个文件都基于其文件名显示为一条路径。
图片可以添加到 src/assets/ 并通过相对链接嵌入到 Markdown 中。
静态资产, 例如图标,都可以放在 public/ 目录中。
所有命令都是从项目根目录的终端运行的:
由于 Starlight 是 beta 软件,所以会经常更新和改进。
请务必定期更新 Starlight!
| 命令 | 运行 |
|---|---|
pnpm install |
安装依赖项 |
pnpm dlx @astrojs/upgrade |
更新 Starlight |
pnpm dev |
在 localhost:4321 上启动本地开发服务器 |
pnpm build |
构建站点到 ./dist/ 目录 |
pnpm preview |
在部署之前在本地预览构建 |
pnpm astro ... |
运行CLI命令 如 astro add, astro check |
pnpm astro -- --help |
获取使用 Astro CLI 的帮助 |
查看 Starlight’s docs,阅读 the Astro documentation,或者跳转到 Astro Discord server服务器。