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.
build_news(pkg = ".", path = "docs/news", one_page = TRUE, depth = 1L, preview = TRUE)
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).
Output path. Relative paths are taken relative to the
Depth of path relative to root of documentation. Used to adjust relative links in the navbar.
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'.
Issues and contributors mentioned in news items are automatically linked to
github if a
URL entry linking to github.com is provided in the package
## Major changes - Lots of bug fixes (@hadley, #100)
There are currently no configuration options.