opencobra/cobrapy-website

Name: cobrapy-website

Owner: openCOBRA

Description: opencobra.github.io/cobrapy

Created: 2017-02-03 08:48:43.0

Updated: 2017-10-10 15:23:18.0

Pushed: 2017-12-18 20:32:05.0

Homepage: null

Size: 751

Language: HTML

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

The new Cobrapy website

This is a basic mockup for the new cobrapy website. It uses a lighter design follwoing the the Material Design spec and provides ther basic section:

• general info
• packages using cobrapy
• publications using cobrapy

Dev setup

The site itself is build with Hugo. Please see the Hugo Docs for a general introduction.

Installing Hugo

Hugo is a single binary that can be downloaded for a large set of platforms from the hugo releases page. On Mac you can also use homebrew via brew install hugo. For further instructions see the Hugo installation instruction.

Editing the site

After installing hugo clone the website source with

clone https://github.com/opencobra/cobrapy-website

You can start the live web server with

obrapy-website
 server

This will serve the website on http://localhost:1313/cobrapy and will rebuild the site automaticaly everytime you change any of the files.

The actual Markdown content can be found in the content folder. intro are the sections shown on the Homepage, packages are the software packages using cobrapy and pubs are the publications (automatically generated using the pubmed_to_hugo.py script from a Pubmed XML).

Templates and logic are contained in the layouts folder as detailed in the Hugo Docs.

Adding publications, packages or releases

For all of those sections the workflow is basically the same. To add an item to a section (section in ['pubs', 'releases', 'packages'])

• create a new markdown file in content/section (this can also be done by running hugo new section/myfile.md)
• fill in the required fields as in the templates in archetypes/section.md
• run hugo server to see if everything looks good
• commit your changes and open a PR to this repo

The articles.xml holds the XMl output from all recent pubmed publications citing cobrapy. You can ignore this file if adding publications by hand.