WongMinHo / Api Doc
📗基于Markdown编写的接口文档。
Stars: ✭ 47
Projects that are alternatives of or similar to Api Doc
Swagger2markup
A Swagger to AsciiDoc or Markdown converter to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation.
Stars: ✭ 2,330 (+4857.45%)
Mutual labels: api, markdown
Verb
HEADS UP! Verb is going though a major transition, we've completely refactored everything from the ground up. If you're interested, please see the dev branch.
Stars: ✭ 442 (+840.43%)
Mutual labels: api, markdown
Gotenberg
A Docker-powered stateless API for PDF files.
Stars: ✭ 3,272 (+6861.7%)
Mutual labels: api, markdown
Parse Google Docs Json
Authenticates with Google API and parse Google Docs to JSON or Markdown
Stars: ✭ 100 (+112.77%)
Mutual labels: api, markdown
Blog Content
Different articles related to software and/or electronics hacking - Published at http://gbraad.nl/blog/
Stars: ✭ 7 (-85.11%)
Mutual labels: markdown, gitbook
Wizard
Wizard是一款开源的文档管理工具，支持Markdown/Swagger/Table类型的文档。
Stars: ✭ 1,733 (+3587.23%)
Mutual labels: api, markdown
Docma
A powerful tool to easily generate beautiful HTML documentation from JavaScript (JSDoc), Markdown and HTML files.
Stars: ✭ 287 (+510.64%)
Mutual labels: api, markdown
Parvula
An extremely simple & flexible CMS generated from flat files with a complete RESTful API —
Stars: ✭ 76 (+61.7%)
Mutual labels: api, markdown
Gatsby Gitbook Starter
Generate GitBook style modern docs/tutorial websites using Gatsby + MDX
Stars: ✭ 700 (+1389.36%)
Mutual labels: markdown, gitbook
Bluedoc
An open-source document management tool for enterprise self host.
Stars: ✭ 579 (+1131.91%)
Mutual labels: markdown, gitbook
Gotenberg Go Client
Go client for the Gotenberg API
Stars: ✭ 35 (-25.53%)
Mutual labels: api, markdown
Usaspending Api
Server application to serve U.S. federal spending data via a RESTful API
Stars: ✭ 166 (+253.19%)
Mutual labels: api, markdown
Gotenberg Php Client
PHP client for the Gotenberg API
Stars: ✭ 80 (+70.21%)
Mutual labels: api, markdown
Docfx
Tools for building and publishing API documentation for .NET projects
Stars: ✭ 2,873 (+6012.77%)
Mutual labels: api, markdown
Honkit
📖 HonKit is building beautiful books using Markdown - Fork of GitBook
Stars: ✭ 1,901 (+3944.68%)
Mutual labels: markdown, gitbook
Bookstack
BookStack，基于MinDoc，使用Beego开发的在线文档管理系统，功能类似Gitbook和看云。
Stars: ✭ 2,547 (+5319.15%)
Mutual labels: markdown, gitbook
Beibq
基于flask开发类似gitbook的知识管理网站。 http://demo.beibq.cn
Stars: ✭ 480 (+921.28%)
Mutual labels: markdown, gitbook
Hint
重构到 ---> https://github.com/hustcc/lint-md
Stars: ✭ 30 (-36.17%)
Mutual labels: markdown, gitbook
文档概述
📗基于 Markdown 编写的接口文档；文档中列出几个案例供参考。
环境部署/安装
本文档在 gitbook 下运行的，安装步骤如下：
1. 克隆源代码
> git clone https://github.com/WongMinHo/api-doc.git
2. 配置本地运行环境
1). 安装npm 从官网下载源码，解压，执行如下命令安装：
./configure
make
make install
2). 安装gitbook
npm install gitbook-cli -g
如果安装太慢，可以设置淘宝代理镜像，执行命令：
npm config set registry https://registry.npm.taobao.or
查看gitbook是否安装成功：
gitbook -V
使用
进入api-doc目录，执行命令：
gitbook serve
浏览器打开：http://localhost:4000/ 即可访问文档。
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].