2 Star 3 Fork 1

JRebelX/GitBook-RealityDemo

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

GitBook 的开箱即用版Demo Or 入门到生产级帮助手册

1.GitBook 环境搭建

GitBook 是一个基于 Node.js 的命令行工具,可使用 Github/GitMarkdown 来制作精美的电子书,GitBook 并非关于 Git 的教程。

只是举例-Max.png

GitBook支持输出多种文档格式:

  • 静态站点(H5):GitBook默认输出该种格式,经过编译后生成的静态页面可直接放到服务器上;

  • PDF:需要安装gitbook-pdf依赖;

  • eBook:需要安装ebook-convert;

  • HTML网页:支持将内容输出为单页的HTML,不过一般用在将电子书格式转换为PDF或eBook的中间过程;

  • JSON:一般用于电子书的调试或元数据提取。


1.1 安装 Node.js

Node.js官网 下载 msi 版, (我的版本 v8.12.0)直接安装即可(安装msi 软件需关闭安全软件: 360,腾讯管家等)

安装完进入CMD 命令行用 node -v 检查当前版本号 ;

1.2 安装 使用npm 安装 GitBook组件

npmNode.js 的默认包管理工具 , 因为是 npm源 在国外,用npm下载插件时比较慢,推荐 淘宝维护的镜像cnpm用法是一样的,实时同步 npm源;

(cnpm安装命令: npm install -g cnpm --registry=https://registry.npm.taobao.org)

cnpm install -g gitbook-cli  # gitbook 脚手架安装命令  
gitbook -V            		 # 查看版本命令,校验是否安装成功
CLI version: 2.3.2
GitBook version: 3.2.3

2.如何创建一个GitBook HTML手册 ?

2.1 使用GitBook init 初始化

init

2.2 生成的两个文件:README.md和SUMMARY.md

两个文件

编译gitbook build后锚点树效果图

Tree.png

2.3 GitBook help 查看要使用什么命令

gitbook help.png

2.4 GitBook install 根据 book.json 加载依赖插件

book_json.png

gitbook install 加载book.json上的依赖插件

gitbook install.png

2.5 GitBook build 根据 SUMMARY.md 编辑.md生成静态页面

![Gitbook build.png

2.6 GitBook serve 运行静态网页

gitbook serve.png

http://localhost:4000 查看最终效果

run.png

3.如何维护 GitBook-RealityDemo 帮助手册 (请先完成第一章的环境搭建) ?

3.1 将 项目中依赖的 node-npm 库解压并删除原7z包 (为了开箱即用考虑 ,跳过了 gitbook install 加载插件环节)

nodenpm.png

3.2 使用AntRun 重写 Maven生命周期

AntRun.png

3.3. 修改GitBook 中的.md文件 可用被重写后的mvn 命令来进行编译打包

(编译完成后用tomcat运行即可,切记当前只重写 package和clean 命令)

mvn package: 即在将 webapp\doc 目录删除

mvn_clean.png

*mvn package: 即在cmd命令行进入 node目录 gitbook build 后将 _book 目录拷贝到 webapp\doc 并过滤所有的 .md (如果改变了一些md文件就mvn package重新编译后运行)

mvn_package.png

3.4. 配置Web容器运行 War包 (项目中 target 下已有 War可直接运行)

war.png

3.5. 注意事项 (node_modes, _book , .idea 请不要提交SVN)

ignore.png

4.GitBook 帮助手册使用的插件 (book.json 文件)

{
  "title": "某米帮助手册",
  "description": "某米帮助手册",
  "language": "zh-hans",
  "plugins": [
    "-highlight",				# 移除高亮插件
    "-sharing",					# 移除社交分享插件
    "-search",					# 移除原生搜索插件
    "-lunr",					# 移除搜索后端
    "expandable-chapters-small",# 添加标题折叠插件 
    "search-pro",				# 添加pro-中英文站内搜索插件
    "prism",					# 添加代码样式风格插件
    "splitter",					# 添加使侧边栏的宽度可以自由调节插件
    "fontsettings",				# 添加调节默认字体插件
    "navigator"					# 添加锚点插件
  ],
  "styles": {
    "website": "stylehttps://upload-images.jianshu.io/upload_images/9600360-e99c88e7debf2831.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240   "size": 14
    },
    "search-pro": {				# 中英文站内搜索插件配置
      "cutWordLib": "nodejieba",
      "defineWord": [
        "Gitbook Use"
      ]
    },
    "expandable-chapters-small": {} # 标题折叠插件配置(可为空) 
  },
  "pdf": {
  "pageNumbers": false,
  "fontFamily": "Arial",
  "fontSize": 12,
  "paperSize": "a4",
  "margin": {
    "right": 62,
    "left": 62,
    "top": 56,
    "bottom": 56
  }
 }
}

4.1 GitBook转PDF参考

输出为PDF等其他格式
http://calibre-ebook.com/download下载calibre,安装版和便携版都可以。 解压或者安装 calibre,在安装/解压目录中找到包含ebook-convert.exe的文件夹,将此文件夹添加到PATH变量中 运行如下命令生成pdf 或者epub 文件

cmd 命令行 切到GitBook根目录执行 gitbook pdf

4.2 当前book.json集成后最终效果

Max.png

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2019 HDMBS Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

Maven 管理 GitBook 的开箱即用版Demo and 入门到生产级帮助手册 展开 收起
JavaScript
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
JavaScript
1
https://gitee.com/HDMBS/GitBook-RealityDemo.git
git@gitee.com:HDMBS/GitBook-RealityDemo.git
HDMBS
GitBook-RealityDemo
GitBook-RealityDemo
master

搜索帮助