跳转到内容

示例指南

欢迎来到你的新文档页面!这是一个基于 AstroStarlight 构建的示例页面。

你可以使用 Markdown 编写内容,也可以使用 Starlight 提供的内置组件来增强视觉体验。

专为文档设计的排版,支持代码高亮和暗黑模式。 内置 Pagefind 搜索,快速找到你需要的资料。 轻松扩展到全球用户,支持完全的 i18n 配置。 通过 `astro.config.mjs` 深度定制你的侧边栏和样式。

使用 <Steps> 组件可以清晰地展示流程:

  1. 修改配置: 在 astro.config.mjs 中设置你的项目名称和侧边栏。

  2. 撰写内容: 在 src/content/docs/ 目录下创建 .md.mdx 文件。

  3. 预览网站: 运行 npm run dev 查看你的文档效果。

你可以直接插入代码块,Starlight 会自动处理语法高亮:

// 这是一个简单的 JavaScript 示例
function welcome(name) {
console.log(`欢迎来到 ${name} 的文档中心!`);
}
welcome('Starlight');
:::tip[小提示] 使用 :::tip 可以创建醒目的提示框帮助读者关注重要信息。 :::
:::danger[警告] 这是一个危险操作提示框用于提醒用户注意潜在风险。 :::
下一步
[ ] 替换此页面的内容
[ ] src/content/docs/reference/ 目录下添加 API 参考
[ ] 自定义你的网站 Logo
---
### 💡 提示
* **Frontmatter (`---` 之间的部分)**`title` 会显示在页面顶部和浏览器标签页
* **组件导入** Starlight 中使用高级组件 `Card` `Steps`),需要像上面那样使用 `import` 语句
* **文件名建议**确保文件名 `example.md`与你在 `astro.config.mjs` 中定义的 `slug` 完全一致
**你想看看如何在这个页面中插入一张图片或者想了解如何配置文档的目录层级吗**