actions-marketplace-validations/R pkgdown Multi Version docs
Generates multisite R documentation created with pkgdown.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| path | Path to package's root | no | . |
| default-landing-page | The default branch or tag on gh-pages that corresponds to the landing page. For instance, if your root index page on gh-pages is built using the 'main' branch, then the root page of the site will correspond to this page. If 'latest-tag' is selected, then the latest version will become the default. | no | main |
| branches-or-tags-to-list | Which branches or tags should be listed under the 'Versions' dropdown menu on the landing page? This input should be a regular expression in R. | no | ^main$|^devel$|^prerelease$|^latest-tag$|^release-candidate$|^develop$|^v([0-9]+\\.)?([0-9]+\\.)?([0-9]+)|^v([0-9]+\\.)?([0-9]+\\.)?([0-9]+)(-rc[0-9]+)$ |
| refs-order | The order in which refs should appear in the drop-down list. Versions not in the vector will appear below refs listed here. If docs have never been generated for the ref, the ref will not appear in the drop-down. Similarly, if docs have been generated for the ref, but the ref is not listed in the vector, it will not appear in the drop-down. Example (the refs on the list should be separated by space): main devel prerelease latest-tag | no | main devel prerelease latest-tag |
| latest-tag-alt-name | An alternate name for the 'latest-tag' item | no | "" |
| release-candidate-alt-name | An alternate name for the 'release-candidate' item | no | "" |
Outputs
no outputs