跳转到正文

开始写作 ​

你可以继续使用 Typora、VS Code 或其他 Markdown 编辑器。网站会把文件变成适合阅读的页面,并生成目录与搜索索引。

第一次在本地打开 ​

安装 Node.js 22 LTS 和 Git,把仓库下载到电脑。进入项目文件夹,首次执行:

sh
npm ci
npm run docs:dev

打开终端显示的本地地址。修改已有笔记并保存,页面会自动更新。结束预览时,在终端按 Ctrl+C。

新增一篇笔记 ​

在 docs/notes/ 内的学科文件夹中新建 .md 文件,例如 docs/notes/mathematics/eigenvalues.md。推荐使用简短的英文文件名,让链接易于分享;正文和标题可以使用中文。

md
---
description: 这篇笔记用一两句话说明了什么。
order: 2
---

# 特征值与特征向量

先写下希望解决的问题。

## 定义

如果 $A\mathbf{v}=\lambda\mathbf{v}$ 且 $\mathbf{v}\ne0$,
那么 $\lambda$ 是特征值,$\mathbf{v}$ 是对应的特征向量。

description 会出现在首页与笔记列表;order 越小,在同一目录中的位置越靠前,未填写时排在后面。文章的一级标题 # 标题 用作导航标题。

发布时,新文件会自动出现在章节目录、笔记列表和搜索中。本地新增、删除或重命名文件,以及修改标题、分类或顺序后,请重启 npm run docs:dev,让导航配置重新读取。 普通正文编辑无需重启。

新建一个学科分类 ​

在 docs/notes/ 内新建文件夹,并添加 index.md:

md
---
order: 2
---

# 物理

记录概念、实验与推导。

- [力学第一课](./mechanics)

接着在同一个文件夹放入笔记,例如 mechanics.md。网站会读取 index.md 的一级标题“物理”作为分类名;左侧章节导航和全部笔记列表自动生成。分类介绍页中的正文链接由你自由编写和维护。

书写数学公式 ​

行内公式使用一对美元符号,例如 $E=mc^2$,显示为 E=mc2。

独立公式放在两行 $$ 之间:

tex
$$
\int_0^1 x^2\,\mathrm{d}x = \frac{1}{3}
$$
∫01x2dx=13

矩阵用 bmatrix,多行等式用 aligned,参见示例笔记。这里支持的是数学公式语法,不是完整 LaTeX 文档;不需要 \documentclass 或 \begin{document}。

图片、链接与代码 ​

图片放在 docs/public/images/,正文这样引用:

md
![说明图片内容的文字](/images/vector.svg)

也可以把图片与文章放在同一个文件夹,使用 ![说明](./figure.png) 引用。发布前确保图片位于项目中,而不是指向电脑上的绝对路径。

站内链接示例:[线性代数](/notes/mathematics/linear-algebra)。代码块在三个反引号后注明语言,如 python,网站会自动高亮并提供复制按钮。

发布前确认 ​

  • 文章、图片和引用链接都可以正常打开。
  • 公式显示正确,标题层级清晰。
  • 已删除不准备公开的内容。docs/ 内的页面和图片都会发布;没有加入菜单也不等于私密。
  • 执行 npm run check,检查通过后按发布指南提交更新。

把知识连成线,把思考留在这里。