preview_docsify: Preview the documentation in a webpage or in viewer

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

Description

This runs a preview of the site generated by docsify.js in RStudio viewer. This function must be called after having created the essential files with init_docsify().

Usage

preview_docsify()

Value

Runs a preview of the site generated by docsify.js in RStudio viewer.

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

# Run the preview

preview_docsify()

## End(Not run)

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