generated from jhudsl/OTTR_Template_Website
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
2 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,4 @@ | ||
# OTTR Template for Websites | ||
# Immuno Workflow Course | ||
|
||
This is a template for creating websites from Rmd files hosted on GitHub with three helpful automations following a pull request to the repository: spelling check, broken link check, and website rendering. | ||
This course is an introduction to the [immuno workflow](https://github.com/wustl-oncology/analysis-wdls). Automation from ab [OTTR](https://www.ottrproject.org/) template generates [these github pages](https://griffithlab.github.io/Immuno_Workflow_Course) based on the documentation. | ||
|
||
Websites will be checked for: | ||
|
||
- Check for spelling errors more intensively than RStudio and allow you to add words to the dictionary | ||
- Check for broken links - you will be warned about broken links | ||
|
||
Website files will also be automatically rendered remotely. This will be triggered when a pull request is merged with a change to files that might influence the contents of your website. | ||
|
||
To learn more about how this site is created see [here](https://bookdown.org/yihui/rmarkdown/rmarkdown-site.html) and [here](https://garrettgman.github.io/rmarkdown/rmarkdown_websites.html). |