Cloud-Link's blog Cloud-Link's blog
首页
  • 开发资源
  • 人员动态
  • 新人训练
  • 奖惩通报
  • 通讯录
项目资产
  • 快速指南
  • 后端框架
  • 前端框架
  • 业务模块
  • 基础理论
    • 前端
    • 后端
    • 数据库
    • 工具类
  • 常用
  • 网站
  • 资源
  • Vue资源
  • 分类
  • 标签
  • 归档
关于
首页
  • 开发资源
  • 人员动态
  • 新人训练
  • 奖惩通报
  • 通讯录
项目资产
  • 快速指南
  • 后端框架
  • 前端框架
  • 业务模块
  • 基础理论
    • 前端
    • 后端
    • 数据库
    • 工具类
  • 常用
  • 网站
  • 资源
  • Vue资源
  • 分类
  • 标签
  • 归档
关于
  • 前端

  • 后端

  • 数据库

  • 工具类

    • Vepress

      • 介绍
      • 快速上手
      • 目录结构
      • 核心配置和约定
      • 文档编写和一级标题
      • 自动生成front matter
      • 批量操作front matter工具
      • Markdown 容器
      • Markdown使用教程
      • Markdown 中使用组件
      • 提高文档表现力
    • Git

    • npm

  • Vue

  • TypeScript

  • React

  • 知识库
  • 工具类
  • Vepress
2021-06-18

目录结构

.
├── .github   (可选,GitHub Actions所需文件)
│   ├── workflows
│   │   ├── baiduPush.yml (可选,百度定时自动推送)
│   │   └── ci.yml (可选,自动部署)
├── docs (必须,不要修改文件夹名称)
│   ├── .vuepress (同官方,查看:https://vuepress.vuejs.org/zh/guide/directory-structure.html#目录结构)
│   ├── @pages (可选,自动生成的文件夹,存放分类页、标签页、归档页)
│   ├── _posts (可选,专门存放碎片化博客文章的文件夹)
│   ├── <结构化目录>
│   └── index.md (首页)
├── theme-trx (可选,本地的trx主题)
├── utils  (可选,trx主题使用的node工具)
│   ├── modules
│   ├── config.yml (可选,批量操作front matter配置)
│   ├── editFrontmatter.js (可选,批量操作front matter工具)
├── baiduPush.sh (可选,百度推送命令脚本)
├── deploy.sh (可选,部署命令脚本)
│
└── package.json

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  • docs 文件夹名称请不要修改

  • docs/.vuepress 用于存放全局的配置、样式、静态资源等,同官方,查看 详情 (opens new window)

  • docs/@pages 此文件夹是自动生成的,存放分类页、标签页、归档页对应的.md文件,一般不需要改动

  • docs/_posts 专门用于存放碎片化博客文章,里面的.md文件不需要遵循命名约定,不会生成结构化侧边栏和目录页。

  • docs/<结构化目录> 请查看《构建结构化站点的核心配置和约定》。

  • docs/index.md 首页

  • theme-trx 存放在本地的trx主题文件,如果你想深度的修改主题,首先要在docs/.vuepress/config.js中配置使用的主题指向这个文件。

    // config.js
     module.exports = {
       // theme: 'trx', // npm主题依赖包
        theme: require.resolve('../../theme-trx'), // 使用本地主题包
     }
    
    1
    2
    3
    4
    5

快速上手
核心配置和约定

← 快速上手 核心配置和约定→

Copyright © 2021-2022 用技术改变世界 | Tungray Cloud-Link
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式
×