Skip to content

Latest commit

 

History

History
24 lines (18 loc) · 1.65 KB

README.md

File metadata and controls

24 lines (18 loc) · 1.65 KB
Raw

WikiPathways Website

Jekyll-powered GitHub Pages for wikipathways-database repo contents

Visit site at: https://www.wikipathways.org/

Issues

The issue tracker here should only be used by the dev team for website-specific bugs and features. All user issues should go to wikipathways-help for triage.

Content

Pathway content can be added as .md files to the _pathways directory. The top portion of the .md file is the Jekyll Front Matter, which defines metadata used to generate the site, organize content and generate search metadata optimized for search engines.

Development

In order to rebuild the site locally, e.g. for testing, you'll need to:

  1. clone the repo
  2. install Ruby, Jekyll and Bundler (guide)
  • Try to match these versions where possible in order to get the same behavior locally as via GitHub. Pay attention to Jekyll and Ruby versions in particular.
  1. run bundle install
  2. run bundle exec jekyll serve <-- run this each time you want to restart the local server
  3. goto http://127.0.0.1:4000

Update Protocol

We rely on GiHut Pages to build and deploy the Jekyll site. This means that the versions of Jekyll and related dependencies are automatically updated by GitHub. Developers just need to keep their local setups up-to-date with whatever GitHub is running so that our local testing accurately reflects the live site.

  • Update local Jekyll dependencies: bundle update github-pages