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

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

path <- system.file("examples/mm", package = "mindr") mm2md(path = path)
#> mindr.md was generated!
#> [1] "Title: my title" #> [2] "# Introduction " #> [3] "## What is 'bookdown' " #> [4] "## [What is 'bookdownplus' ](https://github.com/pzhaonet/bookdownplus)" #> [5] "## Why 'bookdownplus' " #> [6] "## Giants' Shoulders " #> [7] "# Quick Start " #> [8] "## Preparation " #> [9] "## Installation of 'bookdownplus' " #> [10] "## How to use " #> [11] "## More output formats" #> [12] "## More templates" #> [13] "## A magic trick" #> [14] "## Recommendations" #> [15] "# Basic " #> [16] "## Markdown Syntax " #> [17] "### What is Markdown " #> [18] "### Basic syntax " #> [19] "### Chapters " #> [20] "### Figures and tables " #> [21] "### References " #> [22] "### Theorems, lemma, definitions, etc. " #> [23] "### Export Word document " #> [24] "### Equations numbering " #> [25] "## R, RStudio and bookdown " #> [26] "## LaTeX and Pandoc " #> [27] "## Workflow " #> [28] "# Simple " #> [29] "# Lifestyle " #> [30] "## Journal " #> [31] "## Poem book " #> [32] "## Music " #> [33] "# Office " #> [34] "## Mail " #> [35] "### Arguments for mail content" #> [36] "### Mail themes" #> [37] "## Calendar " #> [38] "# Academic " #> [39] "## Articles " #> [40] "## Thesis " #> [41] "## Poster " #> [42] "## Chemistry " #> [43] "# Advanced " #> [44] "## Chinese " #> [45] "## Mind Map " #> [46] "## Create Your Own Templates " #> [47] "# FAQ " #> [48] "# Bibliography "