The home of figshare's API documentation.
HTML JavaScript CSS Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
APIv2
docs
swagger_documentation
.gitignore
LICENSE
Makefile
README.md
mkdocs.yml

README.md

figshare User Documentation

The home of figshare's user documentation.

Development

To build the docs for publishing you need to use mkdocs which is a python tool.

make configure will install everything you need to build and publish

make server will start up a local server with autoreload and everything needed for development.

Contributing

In order to contribute you need to send a pull request.

  • fork the repo
  • create a branch
  • make your changes
  • push the branch
  • open a pull request for your branch
  • feel proud