Getting Started with Zenodo Documentation

Prerequisites

Zenodo REST API documentation uses Slate. In order set things up locally you're going to need:

• Linux or OS X — Windows may work, but is unsupported.
• Ruby, version 2.2.5 or newer - Refer to the official Ruby installation guide.
• Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundlerin a terminal.

Getting Set Up

1. git clone [email protected]:zenodo/developers.zenodo.org.git
2. cd developers.zenodo.org
3. Initialize and start Slate. You can either do this locally, with Docker or with Vagrant:

# either run this to run locally
bundle install
bundle exec middleman server

# OR using Docker
docker-compose up

# OR run this to run with vagrant
vagrant up
# (you might need to try ``vagrant provision`` first if the service doesn't start)

You can now see the docs rendered at http://localhost:4567. Any modification you make on the Slate Markdown files will be automatically applied and visible after refreshing the webpage on the browser.

Now that Slate is all set up on your machine, you'll probably want to learn more about editing Slate Markdown.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Deployment

Zenodo REST API documentation is currently hosted on GitHub pages, and uses Travis-CI to be built and deployed.