示例指南
欢迎来到你的新文档页面!这是一个基于 Astro 和 Starlight 构建的示例页面。
你可以使用 Markdown 编写内容,也可以使用 Starlight 提供的内置组件来增强视觉体验。
操作步骤示例
Section titled “操作步骤示例”使用 <Steps> 组件可以清晰地展示流程:
-
修改配置: 在
astro.config.mjs中设置你的项目名称和侧边栏。 -
撰写内容: 在
src/content/docs/目录下创建.md或.mdx文件。 -
预览网站: 运行
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` 完全一致。
**你想看看如何在这个页面中插入一张图片,或者想了解如何配置文档的目录层级吗?**