❤️ 安装

• npm create astro@latest -- --template starlight
  • 这时候不要安装依赖
• 进入项目目录
• npm install
• npm run dev

[!hint] 更新 npx @astrojs/upgrade

❤️ 页面

💛 md 页面

在 src/content/docs/ 中创建 md 文件来添加新页面，使用子文件夹来组织文件

扩展 md 的代码块： https://starlight.astro.build/zh-cn/guides/authoring-content/#expressive-code-功能

自定义 md 语法 ： https://docs.astro.build/zh-cn/guides/markdown-content/#配置-markdown

frontmatter

• 每个文档的 frontmatter 都必须包含 title 属性，在网页上显示为标题

---
title: Hello, World!
---

---

不想要这个，怎么取消： https://starlight.astro.build/zh-cn/guides/authoring-content/#如何在-starlight-中组织页面内容

💛 自定义页面

https://starlight.astro.build/zh-cn/guides/pages/#自定义页面

❤️ 布局

设置又边栏大纲目录：

// astro.config.mjs
defineConfig({
  integrations: [
    starlight({
      // 开启1-4的标题链接
      tableOfContents: { minHeadingLevel: 1, maxHeadingLevel: 4 },
    }),
  ],
});

❤️ 插件

obsidian

• npm i starlight-obsidian
  • 如果 obsidian 中包含 mermaid ，还需要安装 npx playwright install --with-deps chromium
• 在 astro.config.mjs 中导入

// 其他
import starlightObsidian, { obsidianSidebarGroup } from 'starlight-obsidian'

export default defineConfig({
  integrations: [
    starlight({
      // 添加
      plugins: [
        starlightObsidian({
          vault: '../path/to/obsidian/vault',
        }),
      ],
      sidebar: [
        {
          label: 'Guides',
          items: [{ label: 'Example Guide', link: '/guides/example/' }],
        },
        // 再添加一个侧边栏
        obsidianSidebarGroup,
      ],
      title: 'My Docs',
    }),
  ],
})

❤️ 部署

https://docs.astro.build/zh-cn/guides/deploy/