add: Create a Markdown (or R Markdown) file to populate your...

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

Description

Create a Markdown (or R Markdown) file to populate your documentation.

Usage

add_md(name, open = TRUE)

add_rmd(name, open = TRUE)

Arguments

name	Name of the .md (or .Rmd) file to create. If the file already exists, it will return an error.
open	Open or not the files created. Default is TRUE.

Value

Creates a Markdown file in "docs".

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()

# Create a new .md in "/docs"

add_md("test")

# Will output an error because "test.md" already exists

add_md("test")

## End(Not run)

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