https://github.com/apiaryio/apiblueprint.org
API Blueprint Website
https://github.com/apiaryio/apiblueprint.org
Last synced: about 1 year ago
JSON representation
API Blueprint Website
- Host: GitHub
- URL: https://github.com/apiaryio/apiblueprint.org
- Owner: apiaryio
- License: mit
- Archived: true
- Created: 2015-12-21T12:47:56.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-01T19:31:55.000Z (over 2 years ago)
- Last Synced: 2025-05-30T00:07:36.130Z (about 1 year ago)
- Language: CSS
- Homepage: https://apiblueprint.org/
- Size: 524 KB
- Stars: 19
- Watchers: 10
- Forks: 41
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# API Blueprint Website
## Usage
To be able to build and view the website locally, you will first need to
install its dependencies:
```shell
$ bundle install
```
### Preview Website
Using middleman, you can run a development server which will live-build the API
Blueprint website.
```shell
$ bundle exec rake
```
### Adding a new tool
Open the file `data/tools.yaml` and add a new entry for your tool.
```shell
$ cat << 'EOF' >> data/tools.yaml
- name: Hyperdrive
summary: Hyperdrive allows you to build Swift applications that can evolve at run-time powered by API Blueprint.
url: https://github.com/the-hypermedia-project/Hyperdrive
tags:
- client
EOF
```
### Deployment
Circle CI will automatically deploy any changes made to master directly to
GitHub pages.