Skip to content

项目结构说明

txt
E:\Source\vitepress-theme-teek-one-ysundy-pnpm/
├── docs/
│   ├── .vitepress/
│   │   ├── cache/                     # VitePress 构建缓存目录
│   │   │   └── deps/                  # 第三方依赖缓存
│   │   ├── config/
│   │   │   └── theme.ts               # 主题颜色配置
│   │   ├── ConfigHyde/                # Hyde 风格主题配置
│   │   │   ├── icon/                  # 图标组件
│   │   │   │   ├── NavIcon.ts         # 导航栏图标配置
│   │   │   │   └── Svgicon.ts         # SVG 图标生成器
│   │   │   ├── Comment.ts             # 评论系统配置
│   │   │   ├── FooterInfo.ts          # 页脚信息配置
│   │   │   ├── FriendLink.ts          # 友情链接配置
│   │   │   ├── Head.ts                # 全局头部配置
│   │   │   ├── HitokotoDate.ts        # 每日一言配置
│   │   │   ├── Nav.ts                 # 导航栏配置
│   │   │   ├── SocialDate.ts          # 社交媒体数据
│   │   │   ├── SocialLinks.ts         # 社交媒体链接
│   │   │   └── Wallaper.ts            # 壁纸切换配置
│   │   ├── theme/                     # 主题核心代码
│   │   │   ├── components/            # 全局组件
│   │   │   │   ├── 404.vue            # 404页面组件
│   │   │   │   ├── BannerImgArrow.vue # 横幅箭头指示器
│   │   │   │   ├── ConfigSwitch.vue   # 配置切换开关
│   │   │   │   ├── ContributeChart.vue # 贡献日历组件
│   │   │   │   ├── GlobalGreet.vue    # 全局问候语组件
│   │   │   │   ├── NoticeContent.vue  # 公告内容组件
│   │   │   │   ├── ScrollProgressBar.vue # 阅读进度条
│   │   │   │   ├── TeekLayoutProvider.vue # 布局提供器
│   │   │   │   └── TitleChange.vue    # 动态标题组件
│   │   │   ├── composables/           # 组合式函数
│   │   │   │   ├── useRibbon.ts       # 彩带背景效果
│   │   │   │   └── useRuntime.ts      # 运行时工具函数
│   │   │   ├── config/                # 主题配置
│   │   │   │   └── teekConfig.ts      # Teek主题特有配置
│   │   │   ├── style/                 # 样式文件
│   │   │   │   ├── Container/         # 容器样式
│   │   │   │   │   ├── container-bg.scss       # 背景容器样式
│   │   │   │   │   ├── container-border-left.scss # 左侧边框样式
│   │   │   │   │   ├── container-border.scss   # 通用边框样式
│   │   │   │   │   └── container-hyde.scss     # Hyde风格容器
│   │   │   │   ├── blockquote-one.scss # 特殊引用样式
│   │   │   │   ├── font.scss          # 字体配置
│   │   │   │   ├── hidden.scss        # 隐藏元素工具类
│   │   │   │   ├── hyde-banner-desc-gradient.scss # 横幅渐变效果
│   │   │   │   ├── index.scss         # 主样式文件
│   │   │   │   ├── nav.scss           # 导航栏样式
│   │   │   │   ├── ScrollBar.scss     # 滚动条美化
│   │   │   │   ├── text-card-hover.scss # 文字卡片悬停效果
│   │   │   │   ├── var.scss           # CSS变量定义
│   │   │   │   └── vp-*.scss          # Vitepress原生组件样式覆盖
│   │   │   ├── styles/                # 补充样式
│   │   │   │   ├── code-bg.scss       # 代码块背景样式
│   │   │   │   └── iframe.scss        # 内嵌框架样式
│   │   │   ├── svg/                   # SVG相关
│   │   │   │   └── arrow.ts           # 箭头图标生成器
│   │   │   └── index.ts               # 主题入口文件
│   │   ├── config.mts                 # VitePress配置(ESM)
│   │   └── config.ts                  # VitePress配置(TS)
│   ├── @pages/                        # 系统功能页面
│   │   ├── archivesPage.md            # 归档页
│   │   ├── articleOverviewPage.md     # 文章概览页
│   │   ├── categoriesPage.md          # 分类页
│   │   ├── loginPage.md               # 登录页
│   │   ├── riskLinkPage.md            # 外链风险提示页
│   │   └── tagsPage.md                # 标签页
│   ├── posts/                         # 博客文章
│   │   ├── 2023-01-01-example.md      # 示例文章
│   │   ├── draft/                     # 草稿目录
│   │   │   └── unpublished.md         # 未发布文章
│   │   └── (其他文章)
│   ├── public/                        # 静态资源
│   │   ├── blog/                      # 博客相关图片
│   │   │   ├── bg1.webp               # 背景图1
│   │   │   ├── bg2.webp               # 背景图2
│   │   │   ├── bg3.webp               # 背景图3
│   │   │   └── bg4.webp               # 背景图4
│   │   ├── fonts/                     # 字体文件
│   │   │   ├── 筑紫A丸/               # 日文字体
│   │   │   │   ├── TsukuARdGothicStd-Regular.ttf
│   │   │   │   └── TsukuARdGothicStd-Regular.woff2
│   │   │   ├── 阿里普惠体/            # 阿里巴巴字体
│   │   │   │   └── Alibaba_PuHuiTi_2.0_55_Regular_55_Regular.ttf
│   │   │   └── 霞鹜文楷/              # 中文字体
│   │   │       └── 霞鹜文楷.ttf
│   │   ├── img/                       # 图片资源
│   │   │   ├── alipay/                # 支付相关图片
│   │   │   │   ├── 1.png              # 支付宝二维码1
│   │   │   │   ├── 2.png              # 支付宝二维码2
│   │   │   │   ├── One-wechat.jpg     # 微信收款码
│   │   │   │   └── One-zhifubao.jpg   # 支付宝收款码
│   │   │   ├── bg/                    # 背景图片
│   │   │   │   ├── 1.webp             # 背景1
│   │   │   │   ├── 2.webp             # 背景2
│   │   │   │   └── (...更多背景图)
│   │   │   ├── blog/                  # 博客特色图片
│   │   │   │   ├── banner-bg1.webp    # 横幅背景1
│   │   │   │   └── banner-bg2.webp    # 横幅背景2
│   │   │   ├── login/                 # 登录页图片
│   │   │   │   └── loginBg.png        # 登录背景
│   │   │   ├── nav/                   # 导航图标
│   │   │   │   ├── 编程.svg           # 编程分类图标
│   │   │   │   ├── 博客.svg           # 博客分类图标
│   │   │   │   └── (...更多导航图标)
│   │   │   ├── website/               # 网站截图
│   │   │   │   ├── 7288992783581396992.png # 示例网站1
│   │   │   │   ├── 从01开始.jpg       # 示例网站2
│   │   │   │   └── (...更多网站截图)
│   │   │   ├── wechat/                # 微信相关
│   │   │   │   └── wechat.png         # 微信公众号二维码
│   │   │   ├── favicon.ico            # 网站图标
│   │   │   ├── logo.png               # 主logo
│   │   │   └── (...其他图片)
│   │   ├── login/                     # 登录页资源
│   │   │   └── bg-1.png               # 登录背景图
│   │   ├── mouse/                     # 鼠标效果
│   │   │   ├── canvas-ribbon.min.js   # 彩带背景脚本
│   │   │   ├── default.cur            # 默认鼠标指针
│   │   │   ├── pointer.cur            # 特殊指针
│   │   │   └── ribbon.js              # 彩带效果增强
│   │   ├── 404.png                    # 404错误页图片
│   │   ├── favicon-teek.ico           # Teek主题favicon
│   │   ├── favicon.ico                # 默认favicon
│   │   ├── teek-logo-large.png        # 大尺寸logo
│   │   ├── teek-logo-mini.png         # 小尺寸logo
│   │   └── teek-logo-mini.svg         # SVG格式logo
│   └── (...其他文档目录)
├── scripts/                           # 项目脚本
│   ├── init-main.ps1                  # 主初始化脚本
│   ├── init-steps.ps1                 # 分步初始化脚本
│   └── shared.ps1                     # 共享函数脚本
├── .editorconfig                      # 编辑器配置
├── .gitignore                         # Git忽略规则
├── .prettierignore                    # Prettier忽略规则
├── .prettierrc.cjs                    # Prettier配置
├── biome.jsonc                        # Biome格式化配置
├── Init-VitePressProject2.ps1         # VitePress初始化脚本
├── package.json                       # 项目配置
├── pnpm-lock.yaml                     # pnpm锁文件
├── README.md                          # 项目说明
└── tsconfig.json                      # TypeScript配置

文件夹结构说明

  • docs/:存放文档内容,包括Markdown文件和图片资源。
  • scripts/:存放项目脚本,用于初始化和配置项目。
  • public/:存放静态资源,如图片、favicon等。
  • src/:存放源代码,包括组件、页面和样式。
  • theme/:存放主题相关的文件,如布局、样式和组件。
  • config/:存放配置文件,如主题配置、插件配置等。
  • node_modules/:存放项目依赖的第三方库。
  • .gitignore:指定Git忽略的文件和目录。
  • package.json:项目的依赖和脚本配置。
  • pnpm-lock.yaml:pnpm的锁文件,用于锁定依赖版本。
  • README.md:项目的说明文档。
  • tsconfig.json:TypeScript的配置文件。

文件说明

  • docs/index.md:文档的入口文件,用于展示文档的首页。
  • scripts/init-steps.ps1:初始化脚本的分步执行。
  • scripts/shared.ps1:共享函数脚本,用于在多个脚本中复用函数。
  • Init-VitePressProject2.ps1:VitePress项目的初始化脚本。
  • package.json:项目的依赖和脚本配置。
  • pnpm-lock.yaml:pnpm的锁文件,用于锁定依赖版本。
  • README.md:项目的说明文档。
  • tsconfig.json:TypeScript的配置文件。

使用说明

  1. 克隆项目到本地。
  2. 在项目根目录下运行 pnpm install 安装依赖。
  3. 运行 pnpm run dev 启动开发服务器。
  4. 访问 http://localhost:3000 查看文档。

注意事项

  • 请确保在运行脚本之前已经安装了PowerShell 7.1或更高版本。
  • 请确保在运行脚本之前已经安装了pnpm。
  • 请确保在运行脚本之前已经安装了Node.js和npm。

贡献

如果您有任何建议或改进意见,请随时提交Pull Request或创建Issue。

许可

本项目遵循MIT许可证。请查看LICENSE文件了解更多信息。

最近更新