# honkit-demo

**Repository Path**: phk07083224/honkit-demo

## Basic Information

- **Project Name**: honkit-demo
- **Description**: 使用honkit制作电子书的一个demo工程
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-06
- **Last Updated**: 2023-11-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 搭建知识库的步骤

### 1. 环境准备

1. 安装nodejs，lts，版本>=10，我本地使用的是16
2. 安装honkit：命令：npm install -g honkit --save-dev

### 2. 修改SUMMARY.md中的条目

比如最终内容如下

注意点：Introduction条目需要有，否则也会自动生成一个空的Introduction

```
# Summary

* [Introduction](README.md)
* [章节1](docs/章节1.md)
    * [章节1.1](docs/章节1.1.md)
* [章节2](docs/章节2.md)
```

### 3. 创建每个条目对应的md文件

创建方式
1. 方式1：手工创建文件
2. 方式2：使用命令自动创建不存在的md文件，命令为：npx honkit init

### 4. 搭建在线知识库

1. 方式1-本地知识库：可以通过执行命令在本地启动服务，命令：npx honkit serve
2. 方式2-在rancher上部署知识库
   1. 修改docker/harbor/buildAndPush.sh，修改其中的镜像名
   2. 执行docker/harbor/buildAndPush.sh，完成打包&制作镜像&推送镜像到harbor
   3. 在rancher上进行部署：过程略

## 案例工程演示地址

TODO 待补充