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
The site itself is build with Hugo. Please see the Hugo Docs for a general introduction.
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.
After installing hugo clone the website source with
git clone https://github.com/opencobra/cobrapy-websiteYou can start the live web server with
cd cobrapy-website
hugo 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.
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 runninghugo new section/myfile.md) - fill in the required fields as in the templates in
archetypes/section.md - run
hugo serverto 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.