pkg_help

Get help for a package topic as markdown

Description

Extracts help documentation and converts it to clean markdown.

Usage

1pkg_help(topic, package, format = c("md", "hugo"))

Arguments

  • topic: Character. The help topic name.
  • package: Character. Package name.
  • format: Character. Output format: "md" (default) for plain markdown, or "hugo" for Hugo-compatible markdown with YAML front matter.

Value

Character string of markdown help text.

Examples

1cat(pkg_help("md5sum", "tools"))