Building Your Team-Docsify专属Wiki环境搭建

黎明鸟飞去

已于 2023-12-25 12:47:10 修改

阅读量891

点赞数 17

分类专栏： Building Your Team-协作开发文章标签： devops 团队开发 docker

于 2023-12-24 15:39:54 首次发布

本文链接：https://blog.csdn.net/m0_46523582/article/details/135182493

版权

Building Your Team-协作开发专栏收录该内容

9 篇文章 1 订阅

订阅专栏

工欲善其事，必先利其器。

本文主要总结团队协助中，Docsify专属Wiki环境搭建。

下文将分docker环境以及单机环境分别说明。

简介

Docsify是一个轻量级的文档生成工具，用于创建漂亮、响应式的文档网站。它基于Markdown文件，允许用户使用简单的Markdown语法编写文档，并将其转换为一个可交互的文档网站。Docsify的主要特点包括：

基于Markdown：使用Markdown语法编写文档，简单易懂，使得文档编写更加高效。
轻量级：Docsify本身非常轻量级，只需一个HTML文件和一些配置即可创建整个文档网站，无需复杂的安装过程。
响应式设计：生成的文档网站具有响应式设计，能够适应各种设备和屏幕尺寸，提供良好的用户体验。
多种功能插件：支持丰富的插件和主题，可以通过插件扩展功能，包括搜索、导航、代码高亮等。
动态加载：Docsify可以动态加载Markdown文件，使得在文档页面上切换时能够实现平滑的过渡效果，提高了用户体验。
自定义配置：提供了丰富的配置选项，允许用户根据需求自定义文档网站的外观和功能。

Docsify适用于那些希望快速创建并分享文档的个人、团队或项目。它简单易用的特性使得文档编写和管理变得更加高效，同时生成的文档网站视觉上也很吸引人。

Docker版安装

环境准备

Docker 环境安装

在Linux服务器上安装Docker环境，具体可以参考：https://docs.docker.com/engine/install/ubuntu/

开放端口号

#开放9001端口号 
firewall-cmd --zone=public --add-port=9001/tcp --permanent 
#重载防火墙规则 sudo firewall-cmd --reload

jenkins工作目录

/data/platform/05_docsify/workspace

安装配置

Docker环境下安装docksify

参考https://docsify.js.org/#/deploy?id=docker

Dockerfile

FROM node:latest
  LABEL description="Avit RD.T Dockerfile for build Docsify."
  WORKDIR /docs
  RUN npm install -g docsify-cli@latest
  EXPOSE 3000/tcp
  ENTRYPOINT docsify serve .

编译

docker build -f Dockerfile -t docsify/avit-rd-t .

运行

docker run \
   --name docsify \
   -d \
   --restart=always \
   -v /data/platform/05_docsify/workspace:/docs \
   -p 9001:3000 \
   docsify/avit-rd-t

访问docsify容器

docker exec -it docksify bash

查看日志

docker logs -f docksify

查看镜像与容器信息

docker images  # 查看镜像
docker ps -a  # 查看所有容器服务的状态
docker port docksify  # 查看端口映射
docker inspect docksify #查看容器的具体信息

登录及基础配置

登录Docsify

Docker运行docsify成功后，访问地址：http://ip:port

单机版安装

安装

docsify是一个Node.js插件，所以需要提前安装Node.js。安装完毕后，通过下面命令全局安装docsify：

npm i docsify-cli -g

初始化项目

如果想在项目的 ./docs 目录里写文档，直接通过 init 初始化项目。

ocsify init ./docs

开始写文档

初始化成功后，可以看到 ./docs 目录下创建的几个文件

index.html 入口文件
README.md 会做为主页内容渲染
.nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件

直接编辑 docs/README.md 就能更新文档内容，当然也可以添加更多页面。

本地预览

通过运行 docsify serve 启动一个本地服务器，可以方便地实时预览效果。默认访问地址 http://localhost:3000 。

docsify serve docs

参考

https://docsify.js.org/#/zh-cn/