OurBook

created by vuepress

how to run

npm install
npm run dev

visit localhost:8080

how to deploy

npm run build
zsh deploy.sh

如果电脑没有安装zsh，那么请自行修改脚本为bash或是别的shell工具

how to write

这里主要讲一些页面配置的东西。

首先关于vuepress的使用，大部分内容可以在其官网上进行查看https://vuepress.vuejs.org/zh/

关于本页面的编写，需要同步进行配置几个地方。

基于遵守vuepress的路径解析原理，该项目中所有文件路径都写成/dir/，头部和尾部都需要带上/符号

地区配置

需要在/docs/university/目录中增加城市的markdown文件，例如beijing.md，然后需要在/docs/.vuepress/area.js/增加城市信息，现有的城市信息已经配置完善不需要再配置。

var area = [
  {
    title: '华北地区',
    collapsable: false,
    children: [
      'beijing'
    ]
  }
];

学校配置

结构的约定（可以跳过）

每一个学校以学校英文简称在/docs/下创建一个文件夹，例如/docs/pku/；如果存在重名则需要写成有区别的名字，我们约定重复的简称后面加_{数字}，例如北京大学为/docs/pku/，假设存在北京没有英文名大学简称也是pku，那么路径为/docs/pku_2/，并且一定要有一篇README.md作为根路由。

同时学校的的目录结构也需要在/docs/.vuepress/sidebar.js中进行配置，例如：

var sidebar = {
  '/pku/': [{
    title: '北京大学',
    collapsable: false,
    children: [
      '',
      'article'
    ]
  }],
};

这样做的目的是为了将各个学校的每一篇文章都拆成一个markdown文件，以便进行更为颗粒化的管理，可以在本地运行后，点击http://localhost:8080/OurBook/pku/查看侧边栏配置的修改。

生成器

首先在/docs/.vuepress/univ.js中配置所需要添加的大学的名字与简称；

然后可以在script文件夹中找到genFile.js，使用以下命令可以自行生成默认文件结构。

node genFile.js

现已经更改为脚本自动扫文件目录生成，无需再进行配置

文章结构

这里约定每一篇文章都是单独的markdown文件，每篇文章需要有一级标题，作者使用>符号包起来，其余具体的可以看看markdown的语法

备份计划

关于过去的已经有的文章，但是太过久远已经失效的，在每所学校路径下都有一个备份文件夹，写做/docs/pku/backup/，里面存放该项目所涉及的所有的失去时效性的文章以作参考。

自定义页面

由于本项目使用vuepress构建，所以每个md文件都会被编译为.vue文件，所以可以在markdown当中直接书写页面，具体的使用方式可以参照vuepress自定义页面来进行书写

自定义主题

在路径/docs/.vuepress/theme文件夹下放置了整个网站的主题，包括样式与功能，修改自@default-theme，修改范畴：

• search logic
• wechat img
• disqus/laibili
• share with copyright

排版指南

中文markdown排版指南