showdoc 开源在线api&&技术文档管理工具

showdoc 是一个很不错的api 以及技术文档管理工具

环境准备

  • doker-copose 文件
version: "3"
services:
   doc:
     image: registry.docker-cn.com/star7th/showdoc
     volumes:
     - "./showdoc_data/html:/var/www/html/"
     ports:
     - "8080:80"

启动&&配置

  • 启动
docker-compose up  -d
  • 拷贝数据
docker-compose exec doc cp -fr /showdoc_data/html/ /var/www/

简单doc 项目

  • 创建项目
  • 添加信息
    简单api 文档

效果

说明

showdoc 的操作还是很简单,方便的,同时内置了一些模版还是很不错的,同时包含了分享、复制,历史版本的功能,以及
团度管理,项目转让,内容本身是基于markdown 编写还是很简单的。

参考资料

https://www.showdoc.cc/help?page_id=65610
https://github.com/star7th/showdoc
https://github.com/rongfengliang/showdoc-docker-compose

原文地址:https://www.cnblogs.com/rongfengliang/p/10387737.html

时间: 2024-10-14 19:33:25

showdoc 开源在线api&&技术文档管理工具的相关文章

Api接口文档管理工具,你知道哪些呢?

上周看到有人在我的Github开源项目中提了个issue,说是否考虑接入swagger.那今天我就用swagger与其他接口文档工具做对比,同时说说Api接口文档工具的那点事.如今,在前后端分离开发的这个年代,Api接口文档管理工具越来越显得重要.完整的Api接口文档能大大提升前后端开发协作的效率. image 目前市场有哪些比较优秀的接口文档管理工具呢?Swagger Api接口文档工具到底如何,我大致汇总一下吧! 一.Swagger 说到Swagger,他确实是为开发者发明的一款神器,他可以

API文档管理工具折射出的技术视野

# 什么是技术视野 网上看到不少关于如何提升技术视野的讨论,但却没有人给出定义,到底什么是技术视野? **所谓技术视野,就是看问题时所能切换的不同角(维)度.** 下面就以API管理工具(以下简称"管理工具")为例,来探讨背后隐藏的技术视野. # API管理工具 ## 零视角 曾经在一个小型创业公司用到过最简单的管理工具,就是一个开源的文档管理工具,界面功能类似wiki(维基百科). 这样的工具确实能满足核心需求--API在线文档化,并支持用户管理. 可是深想一层,对于管理工具的使用者

强烈推荐 在线接口文档管理工具 小幺鸡 小团队可以省掉测试了

在朋友那儿看到一个不错的在线文档管理工具 主要特点 : 在线接口测试 在线测试,方便前后端开发,降低错误率.支持:xml.json.txt.binary.websocket 可视化编辑与分享 可视化编辑器,完善的分享机制,多功能导出.让接口撰写变得十分简单 安全保障 基于阿里云服务器,提供安全备份系统.多家公司使用,安全证明. 代码开源 可离线安装到内网服务器仅供公司内部使用.接口在线测试,降低接口错误率 开放源码,支持任意修改 简洁明了的API 简单的维护更新 多种导出满足不同需求 自己搭建试

API文档管理工具-数据库表结构思考.

API文档管理工具-数据库表结构思考. PS: 管理工具只是为了方便自己记录API的一些基本信息,方便不同的开发人员 (App Developer, Restful API Developer)之间的工作协调,同时也是由于本人不擅长word文档编写,程序及设计简单,大牛勿喷! API基础信息表 CREATE TABLE API_Infor 2 ( 3 ApiID uniqueidentifier PRIMARY KEY 4 ,ApiCategory int 5 ,ApiSupport nvarc

GIT+云盘作 做 文档管理工具

GIT+云盘作 做 文档管理工具 在工作中, 会遇到公司的文档 和 自己家里的 文档进行同步的问题, 通常我们使用U盘作为传输节制, 但是不是非常好,文档的改动都不能发现, 导致回家同步的时候, 出各种问题. 这时候我们 就可以 考虑使用GIT了,  外加一个百度云盘 则就顺利的完成了 文档同步和历史文档管理 1.  下载必要的工具msysgit+git tortoise + 百度同步盘. 2.  安装三个工具, 并且在初次使用git tortoise 的时候需要指向msysgit的bin目录

.NET Core使用swagger进行API接口文档管理

一.问题背景 随着技术的发展,现在的开发模式已经更多的转向了前后端分离的模式,在前后端开发的过程中,联系的方式也变成了API接口,但是目前项目中对于API的管理很多时候还是通过手工编写文档,每次的需求变更只要涉及到接口的变更,文档都需要进行额外的维护,如果有哪个小伙伴忘记维护,很多时候就会造成一连续的问题,那如何可以更方便的解决API的沟通问题?Swagger给我们提供了一个方式,由于目前主要我是投入在.NET Core项目的开发中,所以以.NET Core作为示例 二.什么是Swagger S

docker安装知识文档管理工具TeaKKi

TeaKKi 介绍 TeaKKi专注知识知识协作, 让团队知识协作变得简单高效! 为团队构建强大的知识库! 这里也是IT开发的知识社区, 拥有大量的IT从业人员在TeaKKi上记录文档, 在这里你可以找到和记录你的开发文档 安装TeaKKi 拉取teakki镜像 docker pull registry.cn-hangzhou.aliyuncs.com/teakki/teakki:2.7 运行TeaKKi 以下命令, 请先切换到root用户因为docker里的teakki每次运行都会重置, 所以

ftp/sftp不使用webportal直接登录到目标系统设置文档-麒麟开源堡垒机技术文档之一

我测试的商业堡垒机,基本上如果使用FTP/SFTP必须从WEBPORTAL登录,这种方式说实话对于我这个技术老鸟老说感觉太麻烦了,无论怎么样,我还是喜欢直接启动运维工具,一步直接登录. 今天使用了的堡垒机有这个功能,我把设置步骤写上,以和大家共勉 1. 登录前台查看用户名,FTP用户名与telnet/ssh一样,为堡垒机用户名-FTP用户ID,可以登录到堡垒机前台进行查看,比如: 麒麟堡垒机FTP/SFTP直接登录不使用WEBPORTAL跳转方法 堡垒机帐号为test,希望使用上面第二个FTP服

Dokuwiki API接口文档管理中文支持更改

1.文件 \conf\local.php 增加$conf['fnencode'] = 'gbk';如果存就更改 2.文件 \inc\pageutils.php function utf8_encodeFN($file,$safe=true){ global $conf; if($conf['fnencode'] == 'utf-8') return $file; if($safe && preg_match('#^[a-zA-Z0-9/_\-\.%]+$#',$file)){ return