
仓库结构
INFO
大部分结构由 Jekyll 强制执行。有关此处某些项目的更详细说明,请参阅 Jekyll 文档。
模板内容与用户内容
最重要的区别在于 模板内容(模板正常运行所需的"底层"内容)和 用户内容(您特定网站的内容)。
一般来说,模板中的文件和文件夹是这样分类的。我们尽量将它们分开管理。
用户内容 | 模板内容 | |
---|---|---|
文件夹 | /docs /public /src 等(常规文件夹) /components /composables /stores (Vue 相关) | .vitepress .github 等(以 . 开头)node_modules dist (构建相关) |
文件 | index.md README.md 404.md 其他 Markdown 文件 | package.json vite.config.ts .gitignore tsconfig.json LICENSE |
仅限模板仓库内容
有一些文件和文件夹是模板仓库本身所需的,但不属于您的实际项目:
CHANGELOG.md
.github/ISSUE_TEMPLATE
.github/workflows/deploy.yml
.github/pull_request_template.md
这些文件可以保留但不会影响网站功能,建议在初始设置时删除以避免混淆。
静态资源
模板默认使用 /public
文件夹存放静态资源:
- 图片:
/public/images/
- 视频:
/public/videos/
- 其他静态文件:
/public/assets/
您可以使用相对路径引用这些资源,例如:/images/logo.png
。
INFO
注意 logo 和网站图标(favicon)需要放在 /public
根目录下。
数据和组件
Jekyll 支持以下方式组织数据和组件:
类型 | 位置 | 用途 |
---|---|---|
Vue 组件 | /components | 可复用的界面组件 |
组合式函数 | /composables | 可复用的逻辑代码 |
状态管理 | /stores | 使用 Pinia 管理全局状态 |
静态数据 | /data | JSON/YAML 格式的数据文件 |
目录结构说明
以下是完整的目录结构及说明:
文件夹/文件 | 描述 |
---|---|
/.vitepress | Jekyll 配置文件夹,包含主题配置等 |
/components | Vue 组件文件夹 |
/composables | Vue 组合式函数文件夹 |
/docs | 文档 Markdown 文件主目录 |
/public | 静态资源文件夹 |
/src | 源代码文件夹(可选) |
/stores | Pinia 状态管理文件夹 |
package.json | 项目依赖配置文件 |
vite.config.ts | Vite 构建配置文件 |
.gitignore | Git 忽略文件配置 |
tsconfig.json | TypeScript 配置文件 |
index.md | 网站首页 |
README.md | 项目说明文件 |
404.md | 404 错误页面 |
TIP
Jekyll 使用基于文件的路由系统,文档目录结构将直接映射为网站的 URL 结构。