使用gitbook搭建简单的wiki系统

程序猿 2022-01-12 浏览(144 评论(0

Ubuntu 安装 Gitbook 步骤和使用方法详解

 市面上wiki系统众多,用过收费的,也配置过复杂的。用哪种wiki,主要还是看需求吧
 这里使用一个简单粗暴的wiki系统,使用场景为公司运维内部专用wiki系统,仅仅一个展示页面。这里简单记录下,以便同行使用。

一、安装 nodejs 和 npm

Ubuntu安装方法如下,Windows安装方法详见《node.js教程》

打开终端,输入以下命令即可安装;
sudo apt-get install nodejs
sudo apt-get install npm
升级 nodejs 和 npm 版本;
sudo npm install n -g
sudo n stable
npm i -g npm
配置 npm 镜像源为淘宝源;
npm config set registry http://registry.npm.taobao.org/

二、安装 gitbook

  • 先安装 gitbook-cli,执行以下命令

      sudo npm install -g gitbook-cli
    
  • 查看版本并安装 gitbook 输入命令gitbook -V会自动帮我们安装 gitbook,需要注意这一步会很慢,执行 Installing GitBook 3.2.3 大概需要20分钟左右,请耐心等待;

  • 验证是否安装成功 安装成功后,输入gitbook -V再次查看版本看是否安装成功,如图所示,显示版本号即表示安装成功;

  • GitBook 插件 当遇到「左侧的目录折叠」这种需求的时候,就用到 GitBook 插件了。 官方获取插件地址: https://plugins.gitbook.com/

  • 安装 GitBook 插件方法如下: 安装插件只需要在书籍目录下增加 book.json 文件,例如增加 折叠目录 的插件,需要在 book.json 内增加下面代码:

        "plugins": ["expandable-chapters-small"],
        "pluginsConfig": {
            "expandable-chapters-small":{}
        }
    

    然后终端执行命令 gitbook install 来安装插件即可。

    
    

三、使用 gitbook 创作

  • 新建目录

    mkdir gitbook
    
  • 初始化目录

    cd gitbook
    gitbook init
    
  • ls -la

    —— README.md		# 书籍的介绍写在这个文件里
    —— SUMMARY.md		# 书籍的目录结构在这里配置
    
  • 编译博客项目

    gitbook init	# 生成摘要中定义的markdown文件
    gitbook build	# 生成_book文件夹及html网页
    

四、在浏览器浏览我们写的文章

  • 在本地启动 gitbook 服务

    gitbook serve
      
    用浏览器打开 http://localhost:4000/,即可查看我们创作的内容
    

打赏

如果此文对你有所帮助,请随意打赏鼓励作者^_^

黄信强博客

加个好友,学习交流

黄信强博客

微信公众号

黄信强博客

微信