init_docsify: Create the structure to use docsify in an R package

In etiennebacher/docsifier: Generate the Structure to Use 'docsify.js' for Package Documentation

Description

Create the structure to use docsify in an R package

Usage

init_docsify(
  open = TRUE,
  readme_as_homepage = TRUE,
  add_vignettes = TRUE,
  add_reference = TRUE,
  include_internal = FALSE,
  add_news = TRUE,
  add_license = TRUE,
  add_code_of_conduct = TRUE
)

Arguments

open	Boolean indicating whether to open the HTML and Markdown files created. Default is TRUE.
readme_as_homepage	Put the README as homepage? Default is TRUE.
add_vignettes	Include vignettes as articles? Default is TRUE.
add_reference	Boolean indicating whether to add a Markdown file containing function references, i.e the list of functions (and their title and arguments) exported by the package. Default is TRUE.
include_internal	Boolean indicating if you want to include the documentation of internal (i.e non-exported functions). This requires add_reference to be TRUE. Default is FALSE See Details.
add_news	Put NEWS as Changelog? Default is TRUE.
add_license, add_code_of_conduct	Include License and Code of Conduct? Default is TRUE.

Details

TO FILL.

You can add a page containing the list of functions that your package provide, and their documentation. Internal functions (i.e functions that are not exported by the package) are included by default. If you don't want to include them, add "@keywords internal" in the roxygen block of the function concerned, and use include_internal = FALSE.

Value

Creates a folder "docs" (if does not exist yet) and creates necessary files for docsify.js in it.

Examples

## Not run: 

library(docsifier)

# Create a test folder and a test package for the example

test_folder <- tempdir()
setwd(test_folder)
devtools::create("dummy")
setwd("dummy")

# Generate the minimal documentation for docsify.js

init_docsify()

## End(Not run)

etiennebacher/docsifier documentation built on Feb. 21, 2022, 2:20 p.m.