put_vignettes_in_sidebar: Insert the vignettes in sidebar

Description Usage Arguments Value

View source: R/transform_vignettes.R

Description

This function creates the section "Articles" (or with another name) and puts all vignettes in "docs/articles" as subsections.

Usage

1
put_vignettes_in_sidebar(section_name = "Articles", section_above = "Home")

Arguments

section_name

Name of the section containing the vignettes. Default is "Articles".

section_above

Section below which the section "Articles" (or the name given in section_name) will be placed. By default, it will be placed just under "Home".

Value

Modifies "_sidebar.md" to insert the section containing the vignettes. Each vignette is a subsection.


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