Skip to content

Commit

Permalink
docs(pkgdown): Add note that local rendering is unchanged
Browse files Browse the repository at this point in the history
  • Loading branch information
RasmusSkytte committed Oct 29, 2024
1 parent 38b669b commit 3dda1f3
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ Generates the `pkgdown` documentation for your package.
> Specifically, it adds auto-linking to R6 object
> - `?MyR6Class` is rendered without the `?` and links to `MyR6Class`.
> - `?MyR6Class$method()` is rendered as `method()` and links to the method of `MyR6Class`
> Notably, these changes are only done on Github.com.
> When rendering the documentation locally, the code blocks will not be changed.
#### Outcome
The output of `pkgdown` is stored as an artifact on github.
Expand Down

0 comments on commit 3dda1f3

Please sign in to comment.