setup_github_actions: Create a Github Actions workflow
In altdoc: Package Documentation Websites with 'Quarto', 'Docsify', 'Docute', or 'MkDocs'
View source: R/setup_github_actions.R
setup_github_actions R Documentation
Create a Github Actions workflow
Description
This function creates a Github Actions workflow in
".github/workflows/altdoc.yaml". This workflow will automatically render the
website using the setup specified in the folder "altdoc" and will push the
output to the branch "gh-pages".
Usage
setup_github_actions(path = ".")
Arguments
path
Path to the package root directory.
Value
No value returned. Creates the file ".github/workflows/altdoc.yaml"
Examples
if (interactive()) {
setup_github_actions()
}
altdoc documentation built on April 3, 2025, 10:52 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/setup_github_actions.R
| setup_github_actions | R Documentation |
Create a Github Actions workflow
Description
This function creates a Github Actions workflow in ".github/workflows/altdoc.yaml". This workflow will automatically render the website using the setup specified in the folder "altdoc" and will push the output to the branch "gh-pages".
Usage
setup_github_actions(path = ".")
Arguments
path |
Path to the package root directory. |
Value
No value returned. Creates the file ".github/workflows/altdoc.yaml"
Examples
if (interactive()) {
setup_github_actions()
}
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.