Skip to content
NJUPT-NAVI

快速上手

NJUPT-Survival-Guide

Section titled “NJUPT-Survival-Guide”

这是文档存放仓库本体，采用的技术栈是Astro的starlight，文档可以使用Markdown和MDX两种格式编写。

TODO 介绍或者重构文件夹架构
Section titled “TODO 介绍或者重构文件夹架构”

njupt-navi.github.io

Section titled “njupt-navi.github.io”

这是部署网站的仓库，使用GitHub Pages进行部署。两个仓库之间依靠GitHub Actions进行联动。

如何创建一个页面

Section titled “如何创建一个页面”

非常简单的教程，请参考starlight的文档

如果你仍然觉得复杂，拿你直接照猫画虎，复制已有的.mdx文件，修改其中的内容即可。

关于路径别名

Section titled “关于路径别名”

根目录下的tsconfig.json中配置了路径别名@assets，指向src/assets，和@components，指向src/components。在编写文档时可以直接使用别名进行引用。参考Astro 导入别名。

如何修改侧边栏目录

Section titled “如何修改侧边栏目录”

请参考starlight的文档。

如何编写一个自定义组件

Section titled “如何编写一个自定义组件”

本项目自定义的组件均放在src/components目录下:

  • astro.config.mjs
  • package.json
  • Directorysrc
    • assets
    • Directorycomponents
      • ThemedImage.astro
      • …
    • content

关于如何编写组件，你可以参考：