sigven / pcgr

Personal Cancer Genome Reporter (PCGR)
https://sigven.github.io/pcgr
MIT License
251 stars 47 forks source link

Documentation with pkgdown #170

Closed pdiakumis closed 2 years ago

pdiakumis commented 2 years ago

Added a setup for pkgdown docs, including a GitHub Action to automatically deploy it upon e.g. version bump. Here's a sneak peek: https://umccr.github.io/pcgr/index.html

Basic idea is you put all the 'articles' you want to include in pcgrr/vignettes. The home page is in pcgrr/pkgdown/index.md. You then customise the look in the pcgrr/pkgdown/_pkgdown.yml config.