Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign updocument frontmatter in help page #41
Merged
Conversation
| #' options, or any of the following options (which are shown in alphabetical order) in the | ||
| #' document metadata: | ||
| #' | ||
| #' \describe{ |
coatless
Oct 25, 2017
Collaborator
Have you tried roxygen2 with Markdown enabled yet?
https://cran.r-project.org/web/packages/roxygen2/vignettes/markdown.html#lists
Support exists for both enumerate and itemize lists. I manually recreate the describe list format by modifying the itemize list to mimic it using embedded segments. e.g.
#' - `code`
#' - description
Have you tried roxygen2 with Markdown enabled yet?
https://cran.r-project.org/web/packages/roxygen2/vignettes/markdown.html#lists
Support exists for both enumerate and itemize lists. I manually recreate the describe list format by modifying the itemize list to mimic it using embedded segments. e.g.
#' - `code`
#' - description
eddelbuettel
Oct 25, 2017
Author
Owner
I happen to dislike what it requires in DESCRIPTION.
I happen to dislike what it requires in DESCRIPTION.
coatless
Oct 25, 2017
Collaborator
Aye, 'tis not a pretty sight; but, we can manually enable it on a per-chunk basis via:
#' @md
Aye, 'tis not a pretty sight; but, we can manually enable it on a per-chunk basis via:
#' @md
coatless
Oct 25, 2017
Collaborator
With that being said, I'm fine with using the traditional latex markup.
With that being said, I'm fine with using the traditional latex markup.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
In linl we added documentation for the frontmatter in the Rd which seems like a good idea. So ditto here.
Minor cleanup to skeleton.Rd as well.