Skip to content
This repository has been archived by the owner on Apr 23, 2023. It is now read-only.

EXP-Docs/exp-blog

Repository files navigation

EXP-BLOG(Gitbook)

此 Repo 已停止维护,新 Repo 请移步至 hexo-matery-template


简介

此博客是利用 GitBook 搭建的,同时兼容在 Github Pages本地(线下) 运行。

博客数据存储在 gitbook 目录下,编辑前需要先搭建本地 GitBook 环境
关于 本地 环境的搭建可见 gitbook-server-docker 的说明


目录说明

exp-blog
|-- .gitignore  ..............  [Git 过滤配置]
|-- Dockerfile  ..............  [构建 GitBook 本地服务器的 Docker 脚本]
|-- build.ps1  ...............  [重新编译博客变更内容,并使其适用于 Github Pages(Windows 脚本)]
|-- build.sh  ................  [重新编译博客变更内容,并使其适用于 Github Pages(Linux 脚本)]
|-- index.html  ..............  [Github Pages 首页(会自动跳转到博客首页)]
|-- gitbook  .................  [GitBook 的工作目录,存储博客数据]
|   |-- _book  ...............  [用 GitBook 编译生成的静态网站数据,用于本地测试(因含下划线不被 Github Pages 支持)]
|   |-- book  ................  [用 build.ps1/sh 脚本所复制 _book 目录的镜像,用于 Github Pages 发布]
|   |-- res  .................  [存储博客资源的目录]
|   |-- markdown  ............  [存储博客文章的目录(只有 *.md 文件)]
|   |-- README.md  ...........  [博客介绍文档(固定文件)]
|   |-- SUMMARY.md  ..........  [博客目录索引(固定文件)]
|   |-- node_modules  ........  [GitBook 的插件目录]
|   |-- book.json  ...........  [GitBook 的插件配置]
|   └-- package-lock.json  ...  [nodojs 插件依赖关系文件(安装插件时会自动更新)]
|-- LICENSE  .................  [版权说明]
└-- README.md  ...............  [此仓库的说明文档]

发布流程

  • 按需修改 ./gitbook 下的博客数据(编辑文章在 markdown 下操作 *.md ,语法参考这里;若编辑插件则参考这里
  • 编辑完成后执行发布脚本 build.ps1build.sh (该脚本会通过 Docker 执行 gitbook build 命令)
  • 若发布成功,会生成 ./gitbook/_book./gitbook/book 目录(前者用于本地调试,后者用于 Github Pages)
  • 执行 start.ps1start.sh 脚本可启动本地服务
  • 本地预览编辑效果: http://127.0.0.1:4000/
  • 手动提交全部变更内容到 Github 即可 (./gitbook/_book 已通过 .gitignore 过滤)

版权声明

 Copyright (C) EXP,2016 License: GPL v3