Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cansavvy authored Mar 1, 2024
1 parent 02d1166 commit d88e4c0
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# OTTR Template for Websites
# OTTR for Websites!

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.
Get started by going to [ottrproject.org](https://www.ottrproject.org/getting_started.html)!

Websites will be checked for:
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.

- 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
- Automatic rendering of the website for previewing before merges
- Automatic rendering of the website upon merging to main
- Docker images that can be customized.

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

0 comments on commit d88e4c0

Please sign in to comment.