diff --git a/docs/formats.html b/docs/formats.html index 0134966e7..a3ee332be 100644 --- a/docs/formats.html +++ b/docs/formats.html @@ -23,8 +23,8 @@ - - + + @@ -46,10 +46,12 @@ } @@ -353,22 +355,16 @@

Tutorial Format

The learnr package includes a learnr::tutorial R Markdown format which which provides some default layout and behavior (including progress tracking) which you’ll likely want to use in many of your tutorials.

The format also includes features for progressively revealing sections and allowing users to optionally skip exercises they are having trouble with (both of these features are described below).

You can create a new learnr::tutorial document from a template via the New R Markdown dialog in RStudio:

-
- - -
+

The benefits of using the learnr::tutorial format include:

  1. More appropriate defaults are provided for various things including figure sizes and data frame printing.

  2. A floating table of contents for easy navigation between sections is provided by default.

  3. Visual adornments are added to the table of contents indicating which parts of the tutorial have been completed.

  4. -
  5. A “Start Over” button is added to the table of contents regsion to allow users to clear previous work within the tutorial.

  6. +
  7. A “Start Over” button is added to the table of contents region to allow users to clear previous work within the tutorial.

Here’s what a learnr::tutorial document looks like by default:

-
- - -
+

Custom Formats

diff --git a/docs/index.html b/docs/index.html index eed289478..60d266c1f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -23,8 +23,8 @@ - - + + @@ -46,10 +46,12 @@ } @@ -403,10 +405,7 @@

Creating a Tutorial

Tutorial Format

While you can use tutorial elements many different R Markdown formats (see the article on Tutorial Formats for details), the learnr package also includes a custom learnr::tutorial format which provides some default layout and behavior (including progress tracking) which you’ll likely want to use in many of your tutorials.

You can create a new learnr::tutorial document from a template via the New R Markdown dialog in RStudio:

-
- - -
+

This is what the YAML metadata looks like for an Rmd file that uses the tutorial format:

@@ -490,7 +489,7 @@

Shiny Components

External Resources

-

You may wish to include external resources (images, videos, CSS, etc.) within your tutorial documents. Since the tutorial will be deployed as a Shiny applications, you need to ensure that these resources are placed within one of several directories which are reachable by the Shiny web server:

+

You may wish to include external resources (images, videos, CSS, etc.) within your tutorial documents. Since the tutorial will be deployed as a Shiny application, you need to ensure that these resources are placed within one of several directories which are reachable by the Shiny web server: