mdVignettes: mdVignettes

In duckmayr/mdVignettes: Create Markdown Vignettes for R Packages

Description

mdVignettes provides a vignette engine for markdown vignettes.

Details

To use the vignette engine, add

    Suggests: mdVignettes
    VignetteBuilder: mdVignettes

to your DESCRIPTION file, and add YAML front matter:

    ---
    title: "<Your Vignette Title Here>"
    author: "<Your Name Here>"
    date: "<Date Here>"
    output: html_document
    vignette: >
      %\VignetteIndexEntry{<Your Vignette Title Here>}
      %\VignetteEngine{mdVignettes::md}
      %\VignetteEncoding{UTF-8}
    ---

If you would prefer to include your own custom CSS stylesheet (rather than use the default stylesheet from the markdown package), you can do the following:

    ---
    title: "<Your Vignette Title Here>"
    author: "<Your Name Here>"
    date: "<Date Here>"
    output:
      html_document:
        css: <Your stylesheet filename here>
    vignette: >
      %\VignetteIndexEntry{<Your Vignette Title Here>}
      %\VignetteEngine{mdVignettes::md}
      %\VignetteEncoding{UTF-8}
    ---

Author(s)

JB Duck-Mayr

duckmayr/mdVignettes documentation built on May 26, 2019, 2:31 p.m.