Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 996 Bytes

README.md

File metadata and controls

44 lines (29 loc) · 996 Bytes
Raw

API Cookbook

Recipes for cooking complex API meals

Web app

https://octo-woapi.github.io/cookbook/

Status

In active development.

Stack

Development: VuePress, Vuetify
CI: Travis

How to add content?

TL;DR

  • Create a branch recipe-x
  • Add content
  • Open up a pull request

Done!

Longer story

This website uses VuePress to build .vue and .md files.
The addition of a page consists of several steps:

  • create a branch from master named recipe-x where x is the subject of your recipe
  • create a file recipes/<your-file>.md
  • add some content ; you can preview your changes using yarn serve
  • when you are done, push your changes to git and open a pull request
  • [if any] treat the review comments

Every pull request triggers a workflow that checks if the app is correctly built. When your pull request is accepted, the CI builds and checks if everything is ok. The changes are deployed onto gh-pages and available to readers after that.

Contributing