Skip to content

Repository files navigation

拾星阁

知识在此汇成高塔。

这里是拾星阁,一个用 VitePress 搭建的学习笔记站点。我们把大学课程里学到的知识整理成文,力所能及地讲清楚每一个概念、每一处推导。如果你在这里解决了一个小疑惑,或者被点燃了一点学习的兴趣,那这些笔记就多了一分意义。

可以访问 拾星阁 随时浏览本站点。

这里有什么

目前,已经有了这些学科及其课程资料:

  • 数学:概率论与数理统计、计算方法(数值分析)
  • 计算机科学:数据结构、计算机操作系统、计算机组成原理、计算机网络、数据库原理及应用、软件工程导论、面向对象设计与 Java 编程
  • 物理:大学物理
  • 其他:经济学

每门学科的首页都会标注更新状态——「已完结」的笔记内容基本定型,「未完结」的仍在持续补充,也会不断更新其他课程,欢迎常回来看看。

站点的一些小心思

除了 VitePress 自带的能力,站点还做了不少细节上的改进:

  • 导航全自动:新增一篇笔记不需要动任何配置,侧边栏按目录结构自动生成,中文标题按拼音排序,文章名直接取自一级标题。
  • 字数与阅读时间:每篇文章开头会标注字数和预计阅读时间,首页底部则统计全站总字数。
  • 文章导航跟随:右侧的文章导航会随阅读进度高亮,并自动滚动到当前小节,不用手动找位置。
  • 折叠块体验:提示、警告等自定义容器的标题滚动时吸顶;折叠的详情块带展开动画,从链接跳转进入时会自动展开对应内容,在搜索结果里也会预先展开。
  • 搜索增强:本地全文搜索,采用详细列表模式,界面文案已完整汉化。
  • 字体回退:本机没装时自动加载网页字体,保证不同设备上的排版观感。
  • 一个小彩蛋:如果某篇文章的最后更新时间落在凌晨,把鼠标移上去试试看~ QAQ

本地运行

需要 Node.js(建议 20 及以上)和 pnpm。

pnpm install
pnpm dev

常用命令:

命令 说明
pnpm dev 启动开发服务器(默认带 --host,同一局域网的其他设备也能访问)
pnpm build 构建静态站点,产物输出到 .vitepress/dist
pnpm preview 本地预览构建产物

仓库结构

.
├── .vitepress/
│   ├── config.mts        # 站点配置:导航、搜索、Markdown 插件等
│   ├── theme/            # 自定义主题:组件、行为脚本、样式
│   ├── utils/            # 构建期工具:字数统计
│   └── theme-config.ts   # 主题配置的类型声明
├── 数学/                 # 各学科笔记,目录结构即侧边栏结构
├── 计算机科学/
├── 物理/
├── 其他/
├── public/               # 静态资源(robots.txt 等)
└── index.md              # 首页

写一篇新笔记

在对应学科目录下新建 .md 文件即可,侧边栏会自动出现新条目。几点约定:

  • 请遵守项目已有 Markdown 格式标准,可以使用 Prettier 等格式化工具
  • 用一级标题(# 标题)作为文章名,它会直接显示在侧边栏和导航中
  • 数学公式用 KaTeX 语法(行内 $...$,块级 $$...$$),流程图、结构图可以用 Mermaid 绘制
  • 字数与阅读时间在构建时自动统计,不必手动填写

部署

推送到 main 分支后,GitHub Actions 会自动构建并部署至 Azure Static Web Apps(工作流见 .github/workflows/azure-static-web-apps.yml,构建输出目录为 .vitepress/dist)。Pull Request 会生成独立的预览环境,合并或关闭后自动清理。

反馈与贡献

站点难免有疏漏,发现错误或想补充内容,欢迎到 Issues 反馈,也欢迎直接提交 PR。每篇文章的页脚都有直达 Issues 的入口。

仓库开启了 GPG 签名验证,如果要贡献代码或文章,请确保每一次提交都有 GPG 签名。

如果你愿意一起整理某个学科,欢迎联系我们。每一份贡献都会被认真署名——站点首页和相应学科的首页会记录下一起拾星的人。


愿小站不断成长,内容日益丰明。

About

拾星阁 | 一个记录学习点滴、分享知识心得的笔记站点

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Used by

Contributors

Languages