Skip to content

amy-kurtzman/elife-api-documentation

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Background.

This is the documentation repo for the eLifesciences developer resources. The documentation is based on the excellent github api documentation and it uses nanocinanoc to build the documentation pages. The api is built by parsing our [article XML] and pushing it into fi. You can inspect the eLife article objects in Fluidinfo directly.

Deploying updates to the documentation.

API documentation is stored in content/, we are currently working on v1 of the namespace, and so the current documentation is in content/v1. To update or extend the documentation just add to this repo, and then rake publish. This will place the appropriate changes into a gh-pages branch, and deploy them to github. They will be available shortly thereafter at http://dev.elifesciences.org/.

Nanoc basics.

If you wish to iterate on the documentation locally you can compile your changes with: nanoc compile

You can view your changes locally with: nanoc view

There is far more information on using nanoc at the nanoc site.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published