Getting Started: R Markdown Websites

An R Markdown / Bookdown-based website template with a nav bar on top. Best choice if you have existing .Rmd files to build on. If you are starting fresh or already have .qmd files, use the Quarto website setup guide.

1. Create a repository from the template

On the landing page of the OTTR_Template_Website repository, locate the green Use this template button in the upper right corner. Click it, then select Create a new repository and follow the instructions.

2. Name your repository and fill in a short description

Enter a name in the Repository name field and provide a brief description in the Description box.

3. Ensure your repository is set to public

Make sure to set it to a public repository. The rendered pull request preview won’t work on private repositories.

4. Click Create repository from template to proceed

After creating your repository, issues with setup instructions will be automatically filed. Navigate to the Issues tab and follow the instructions there.

5. Check your GitHub Actions settings

Go to Settings > Actions > General. Make sure you have:

  1. Given Read and write permissions
  2. Checked Allow GitHub Actions to create and approve pull requests

Then click Save.

6. Set up your GitHub personal access token

Go to Settings > Secrets and variables > Actions > Repository secrets and click New repository secret.

If you encounter any problems, report an issue here.

7. Set up GitHub Pages

In your repository, go to Settings > Pages and configure:

  • Source: Deploy from a branch
  • Branch: main, folder /docs

Click Save, then check Enforce HTTPS at the bottom of the page.

Warning: If you visit your URL before pushing any file changes, you may see a 404 error. Check after filing your first pull request.



Your feedback is greatly appreciated! You can fill out this form
or file a GitHub issue.

Otter images by Jimin Hwang.