make.readme.toc: Number the Sections in a README.md File and Create a Table of...
In thomasWeise/literatureAndResultsGen: A code/data generator package that can be used to build and validate code and data for R packages for presenting literature and results
Description
Usage
Arguments
Value
View source: R/make_readme_toc.R
Description
The sections in a README.md file are automatically numbered
hierarchically. Then, the line containing the string "toc" is replaced
with a table of contents.
Usage
1
make.readme.toc(text, min.level = 2L)
Arguments
text
multiple lines of text of a README.md file
min.level
the minimum section nesting level included in the table of
contents. This is set to 2, meaning that there should be at most one "#"
level with the overall title, while levels starting with "##" are included
into the table of contents.
Value
the text with sections numbered and a table of contents included
thomasWeise/literatureAndResultsGen documentation built on Nov. 5, 2019, 10:07 a.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.
Description Usage Arguments Value
View source: R/make_readme_toc.R
Description
The sections in a README.md file are automatically numbered hierarchically. Then, the line containing the string "toc" is replaced with a table of contents.
Usage
1 | make.readme.toc(text, min.level = 2L)
|
Arguments
text |
multiple lines of text of a README.md file |
min.level |
the minimum section nesting level included in the table of contents. This is set to 2, meaning that there should be at most one "#" level with the overall title, while levels starting with "##" are included into the table of contents. |
Value
the text with sections numbered and a table of contents included
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.