A generator for go-ipfs API endpoints documentation.
Table of Contents
In order to build this project, you need to first install Go, clone this repo, and finally run
> git clone https://github.com/ipfs/http-api-docs "$(go env GOPATH)/src/github.com/ipfs/http-api-docs" > cd "$(go env GOPATH)/src/github.com/ipfs/http-api-docs" > make install
After installing you can run:
This should spit out a Markdown document. This is exactly the api.md documentation at https://github.com/ipfs/docs/blob/master/content/reference/api/http.md, so you can redirect the output to just overwrite that file.
This project is captained by @hsanjuan.
Small note: If editing the README, please conform to the standard-readme specification.
MIT © Hector Sanjuan