orcid-api-tutorial

MkDocs version of ORCID API tutorial materials

Pre-requisites

Python 2.6 or higher
pip
MkDocs

Start development environment

Clone project

 cd ~/git
 git clone [email protected]:ORCID/orcid-api-tutorial.git

Start local server
```
 cd orcid-api-tutorial
 mkdocs serve
```
View local site at http://127.0.0.1:8000
Add/edit pages per http://www.mkdocs.org/user-guide/writing-your-docs (mkdocs server will reload changes automatically)

Deploy code to Github pages

Pushes code to gh-pages branch per http://www.mkdocs.org/user-guide/deploying-your-docs/#github-pages

cd to local project directory
```
 cd ~/git/orcid-api-tutorial
```
Make sure you're on the master branch
```
 git checkout master
```
Deploy code to Github pages
```
 mkdocs gh-deploy
```
View live site at https://orcid.github.io/orcid-api-tutorial