Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
/ api-doc Public
forked from WongMinHo/api-doc

📗基于Markdown编写的接口文档。

Notifications You must be signed in to change notification settings

Tphper/api-doc

Open more actions menu
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

markdown-api

文档概述

📗基于 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/ 即可访问文档。

About

📗基于Markdown编写的接口文档。

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
Morty Proxy This is a proxified and sanitized view of the page, visit original site.