Skip to content

快速开始

如何编写、预览和扩展个人文档网站。

Updated View as Markdown

这个网站使用 Astro + Nimbus 搭建,主张内容优先、结构清晰、可长期维护。

添加一篇文档

  1. 在 src/content/docs/ 下创建 .md 或 .mdx 文件。
  2. 在文件顶部写好标题和描述。
  3. 将文档加入 astro.config.ts 中 nimbus() 配置的 sidebar.items。
  4. 本地运行 npm run dev 预览。

例如:

---
title: 我的第一篇文档
description: 这篇文章介绍我的学习过程。
---

# 开始记录

用 Markdown 编写正文。

使用交互组件

  • .md:普通 Markdown 文档。
  • .mdx:使用 Nimbus 组件(Aside、Tabs、Card 等无需 import)。
  • public/demos/*.html:完整 HTML 页面,使用 sandbox iframe 嵌入。

查看 Nimbus 组件演示或独立 HTML 交互示例。

搜索与目录

Nimbus 内置 Pagefind 全文搜索(生产构建时生成索引),左侧浏览分类,右侧定位章节。

部署

npm run build 生成 dist/ 目录,后续通过 Cloudflare Workers Static Assets 部署。

Navigation

Type to search…

↑↓ navigate↵ selectEsc close