mindr (version 1.2.3)

mm2md: Convert a mind map (.mm) into markdown headers.

Description

Convert a mind map (.mm) into markdown headers.

Usage

mm2md(
  pattern = "*.mm$",
  path = ".",
  savefile = TRUE,
  savefilename = "mindr.md",
  backup = TRUE
)

Arguments

pattern

an optional regular expression for filtering the input files. See help(dir).

path

character. The path of the folder which contains the input file(s).

savefile

logical. Whether to save the output as a markdown file.

savefilename

character. Valid when savefile == TRUE.

backup

logical. Whether the existing target file, if any, should be saved as backups.

Value

a vector of strings showing outline of a markdown document or book.

Examples

# NOT RUN {
path <- system.file("examples/mm", package = "mindr")
# mm2md(path = path)
# }