Compomics github website.
CSS HTML Ruby Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_includes
_layouts
_projects
_sass
colims/_posts
compomics-utilities/_posts
css
denovogui/_posts
fragmentation-analyzer/_posts
icelogoserver/_posts
images
jsparklines/_posts
jtraml/_posts
mascotdatfile/_posts
ms-lims/_posts
ols-dialog/_posts
omssa-parser/_posts
pepshell/_posts
peptide-shaker/_posts
pladipus/_posts
pride-asa-pipeline/_posts
reporter/_posts
searchgui/_posts
spectrum_similarity/_posts
thermo-msf-parser/_posts
xilmass/_posts
xtandem-parser/_posts
.gitignore
Gemfile
Gemfile.lock
Gemfile.lock.backup
README.md
_config.yml
about.md
favicon.ico
generate-docs.py
index.html

README.md

Compomics Documentation Website

This repository contains the compomics.github.io site, which collates documentation from all Compomics projects on Github. The site is built automatically as the result of a Jenkins build triggered by a Github webhook. This runs a Groovy postbuild script (see https://gist.github.com/iain8/d6cd41e4e2ef920c50af) which passes the project name and github url to the script generate-docs.py, which retrieves the readme and wiki files and adds the necessary front-matter for Jekyll to parse them. Links in wiki pages are automatically amended to still point to the correct place.

The site can be viewed locally using bundle exec jekyll serve (useful for troubleshooting). It is strongly advised to separate all elements in a markdown file with newlines, as the jekyll parser is a lot less forgiving than the one on github wiki pages.