文档站点生成工具

Starlight是一个基于Astro的文档站点生成工具,支持Markdown和MDX文件,适用于技术文档的快速构建和部署。

  • by fiberplane
  • CSS
  • 本地部署
  • 更新于
在 GitHub 查看 fiberplane/fp-docs

使用说明

星光入门套装:基础篇

pnpm create astro@latest -- --template starlight

🧑‍🚀 一个人穿着宇航服(或类似装备),可能表示太空探索、飞行或冒险的意象。 经验丰富的宇航员? 删除这个文件。祝玩得开心!

🚀 项目结构

在你的Astro + Starlight项目中,你会看到以下文件夹和文件:

.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   └── docs/
│   └── content.config.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

星光寻找 .md 或者 .mdx 文件在(某个位置/文件夹中) src/content/docs/ 目录。每个文件都根据其文件名暴露为一个路由。

可以添加图片到 src/assets/ 并以相对链接嵌入到Markdown中。

静态资源,如网站图标(favicon),可以放置在 public/ 目录。

🧞 命令

所有命令均需在项目根目录下通过终端运行:

命令 动作
pnpm install 安装依赖项
pnpm dev 在本地启动开发服务器 localhost:4321
pnpm build 构建您的生产环境以 ./dist/
pnpm preview 在部署前本地预览您的构建
pnpm astro ... 运行类似CLI命令 astro add, astro check
pnpm astro -- --help 获取使用 Astro CLI 的帮助

👀 想了解更多吗?

退房 Starlight的文档,阅读 Astro 的文档,或者跳入 Astro Discord服务器。