build_news: Build news section

In Laurae2/pkgdown: Make Static HTML Documentation for a Package

Description

Your NEWS.md is parsed in to sections based on your use of headings. Each minor version (i.e. the combination of first and second components) gets on one page, with all patch versions (i.e. the third component) on a single page. News items for development versions (by convention those versions with a fourth component) are displayed on an an "unreleased" page.

Usage

build_news(pkg = ".", path = "docs/news", one_page = TRUE, depth = 1L)

Arguments

pkg	Path to source package. If R working directory is not set to the source directory, then pkg must be a fully qualified path to the source directory (not a relative path).
path	Output path. Relative paths are taken relative to the pkg directory.
one_page	If TRUE, writes all news to a single file. If FALSE, writes one file per major version.
depth	Depth of path relative to root of documentation. Used to adjust relative links in the navbar.

Details

The NEWS.md file should be formatted somewhat like this:

# pkgdown 0.1.0.9000

## Major changes

- Fresh approach based on the staticdocs package. Site configuration now based on YAML files.

...

Commonly used subsection headers include 'Major changes', 'Bug fixes', 'Minor changes'.

YAML config

There are currently no configuration options.

Laurae2/pkgdown documentation built on May 27, 2019, 12:17 p.m.