https://github.com/zenodo/developers.zenodo.org
Zenodo Developers Site
https://github.com/zenodo/developers.zenodo.org
Last synced: 6 months ago
JSON representation
Zenodo Developers Site
- Host: GitHub
- URL: https://github.com/zenodo/developers.zenodo.org
- Owner: zenodo
- License: other
- Created: 2017-01-16T11:28:30.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-09-25T12:35:25.000Z (10 months ago)
- Last Synced: 2025-09-25T14:40:31.168Z (10 months ago)
- Language: JavaScript
- Homepage: https://developers.zenodo.org
- Size: 478 KB
- Stars: 14
- Watchers: 8
- Forks: 16
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Getting Started with Zenodo Documentation
-----------------------------------------
### Prerequisites
Zenodo REST API documentation uses [Slate](https://github.com/lord/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](https://www.ruby-lang.org/en/documentation/installation/).
- **Bundler** — If Ruby is already installed, but the `bundle` command doesn't
work, just run `gem install bundler`in a terminal.
### Getting Set Up
1. `git clone git@github.com:zenodo/developers.zenodo.org.git`
2. `cd developers.zenodo.org`
3. Initialize and start Slate. You can either do this locally or with Docker:
```shell
# either run this to run locally
bundle install
bundle exec middleman server
# OR using Docker
docker-compose up
```
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](https://github.com/lord/slate/wiki/Markdown-Syntax).
### 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.