前言近期使用Typora编写文档的时候，写一些篇章比较短的文章还好。但是当篇章过长，标题目录过多的时候，那样就会导致阅读效果很差
原创
2022-07-22 22:09:53
265阅读
目录搭建Gitbook+Gitee电子书管理工具1.安装使用gitbook2.搭建Gitee仓库进行版本管理 搭建Gitbook+Gitee电子书管理工具Gitbook 是一个基于node.js命令的电子书制作工具。其支持Markdown等语法格式进行编辑，可生成HTML与PDF等格式的电子书。关于Gitbook的具体介绍可以参考博文：Gitbook 从懵逼到入门。常搭配版本管理平台为Githu
转载
2023-10-29 07:16:06
122阅读
## 使用 GitBook 创建 Java 项目的文档
在开发 Java 项目时，编写详细的文档是非常重要的。GitBook 是一个流行的文档生成工具，能够帮助你快速创建美观的文档。本文将向你介绍如何使用 GitBook 为你的 Java 项目创建文档。我们将从整体流程开始，再深入到各个具体步骤中，并提供示例代码和注释。
### 整体流程
我们可以将使用 GitBook 创建文档的流程分为以
编写API接口文档是软件开发中至关重要的一环，它可以帮助开发者更好地理解和使用API接口，提高开发效率和降低沟通成本。在Kubernetes（K8S）中，编写API接口文档也是必不可少的工作之一。下面我将为你介绍如何在Kubernetes中编写API接口文档。
整体流程：
下面是编写API接口文档的整体流程，我们将按照以下步骤进行操作：
| 步骤 | 操作
原创
2024-05-21 10:33:36
67阅读
# 使用 Docker 部署 GitBook 文档的步骤指南
在现代软件开发中，GitBook 是一个生成文档的优秀工具，而 Docker 则可以帮助我们以可移植的方式来运行 GitBook。接下来，我将指导你如何使用 Docker 来构建 GitBook 文档。这个流程大致可以分为以下几个步骤：
| 步骤 | 描述 |
|------|------|
| 1 | 安装 Docker |
原创
2024-09-01 03:42:06
57阅读
# 使用 Flask 编写 API 文档的完整指南
在构建 RESTful API 的过程中，编写详细且易于理解的 API 文档是非常重要的。本文将向您介绍如何使用 Python 的 Flask 框架来实现 API 文档的生成。我们将通过以下步骤来完成这一任务。
## 步骤概览
以下是我们需要遵循的主要步骤：
| 步骤 | 描述 |
原创
2024-09-05 05:08:08
234阅读
以下操作皆在root用户下, 话不多说, 直接开干 第一步: 备份原gitlab进入gitlab目录下, 我这边是: /home/git/gitlab执行命令: sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production备份完成后会在: /home/git/gitlab
转载
2024-02-23 11:21:47
8阅读
SwaggerEditor：如何编写RESTful API文档2019.12.17一、概述Swagger/OpenAPI规范的目标是为RESTful API的开发定义
原创
2023-04-21 21:17:56
258阅读
想象一下，你刚买了一个新的家庭影院系统，然后你去设置它。你先做什么？ 谢天谢地，你有一本指导说明的手册来帮助你。你只需要按照手册中详述的步骤进行操作，瞧！你的家庭影院系统已准备好播放你最喜爱的歌曲。 就像指导手册如何指导你完成设置和安装一样，API 文档可以帮助指导你配置 API。 什么是 API 文档？ 在
转载
2023-12-13 16:48:35
29阅读
[API]使用Blueprint来高雅的编写接口文档 前后端api文档，移动端api文档
转载
2017-01-07 10:26:00
138阅读
2评论
一.安装Gitbook 1>.安装nodejs 较新版本的gitboot关于左侧导航栏使用了ajax技术，导致使用gitboot必须得基于协议，它不像旧版本默认支持本地文件访问，即不能双击打开Markdown文件，因此本篇博客安装的nodejs版本偏低。 nodejs下载地址： https:
转载
2021-07-02 16:49:00
530阅读
条件：nodejs 安装 node一定要安装10.X版本，否则报如下错误
原创
2022-05-30 19:41:55
1551阅读
个人信息 模块的开发本章主题关键词登录装饰器用户上传头像存储方案文件存储解决方案七牛云平台密钥管理上传文件示例代码用户上传头像接口设计请求方式请求参数：表单参数响应结果用户上传头像接口定义修改用户名修改用户名接口设计请求方式请求参数：表单参数响应结果修改用户名接口定义总结小便条 本章主题 关键词 登录装饰器def login_required(view_func):
@
转载
2023-10-25 18:53:12
151阅读
原文链接：https://document360.com/blog/api-documentation/
当你购买一件新产品时，它会附带一本说明书，指导你如何使用。你不会希望把新买的游戏机带回家开箱后发现没有一本关于设置、使用和维护的手册。如果客户不知道如何使用产品，他们就不太可能被公司的产品吸引或在未来购买其他产品。
API 也不例外。当开发人员在学习如何使用 API 时，他们需要一套说明书
原创
2024-05-07 08:55:50
57阅读
`gitbook` 基于 `node.js` 开发环境,因此首先要安装好 [nodejs](https://nodejs.org/en/) 环境,其次再使用 `node.js` 提供的 `npm` 包管理工具来安装 `gitbook`.
只需运行 `sudo npm install -g gitbook-cli` 即可安装,接着运行 `gitbook -V`
转载
2024-04-25 15:13:41
76阅读
可是大多数时候，人们却总是想抄抄捷径，这样做的结果往往非常令人遗憾的，
原创
2023-08-01 10:10:38
141阅读
在前端与后端分离开发的场景下、在外部需要提供的接口场景下，以及其他需要进行业务数据对接交互的场景下时，需要提供明确的接口功能说明及相关参数说明，此文档在分离开发下时，是必不可少的，现在通过编写.Mackdown
原创
2017-10-13 15:04:13
9595阅读
### 学习阶段 优先看[刘伟的教程](https://sphard.com/ebooks/gitbook/) 他的教程没有讲git，建议学习一下git 配置环境阶段gitbook配置环境也比较麻烦npm installbug 0 :gitbook -V一直卡在installing Gitbook 3.2.3注意，正常情况是要卡20分钟才可以安装好的，换了淘宝源基本上就没有问
原创
2022-10-10 19:52:08
155阅读
