Giter VIP home page Giter VIP logo

cobrapy-website's Introduction

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

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

You 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.

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.

cobrapy-website's People

Contributors

cdiener avatar hredestig avatar midnighter avatar mmundy42 avatar phantomas1234 avatar pstjohn avatar traviscibot avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.