dir2md

Display a directory hierarchical structure in Markdown syntax

Convert Markdown ('.md') or R Markdown ('.Rmd') texts, R scripts, directory structures, and other hierarchical structured documents into mind map widgets or 'Freemind' codes or 'Mermaid' mind map codes, and vice versa. 'Freemind' mind map ('.mm') files can be opened by or imported to common mind map software such as 'Freemind' (<https://freemind.sourceforge.io/wiki/index.php/Main_Page>). 'Mermaid' mind map codes (<https://mermaid.js.org/>) can be directly embedded in documents.

Peng Zhao

mindr

Generate Mind Maps

dir2md function

<dl><dt>from</dt>
<dd>Character. The source text of the (R) Markdown syntax text, the R code, the FreeMind mind map code, or the path to the directory.</dd>
<dt>dir_files</dt>
<dd>Logical. Whether to include files. If <code>FALSE</code>, only folders are included. If <code>TRUE</code>, folders and files are included.</dd>
<dt>dir_all</dt>
<dd>Logical. Whether to include all files in a directory. If <code>FALSE</code>, only the names of visible files are included (following Unix-style visibility, that is files whose name does not start with a dot). If <code>TRUE</code>, all file names will be included.</dd>
<dt>dir_excluded</dt>
<dd>Character. The directories which are not included in the output.</dd></dl>

Arguments

Display a directory hierarchical structure in Markdown syntax — dir2md

<dl>

<dt>from</dt>
<dd>Character. The source text of the (R) Markdown syntax text, the R code, the FreeMind mind map code, or the path to the directory.</dd>


<dt>dir_files</dt>
<dd>Logical. Whether to include files. If <code>FALSE</code>, only folders are included. If <code>TRUE</code>, folders and files are included.</dd>


<dt>dir_all</dt>
<dd>Logical. Whether to include all files in a directory. If <code>FALSE</code>, only the names of visible files are included (following Unix-style visibility, that is files whose name does not start with a dot). If <code>TRUE</code>, all file names will be included.</dd>


<dt>dir_excluded</dt>
<dd>Character. The directories which are not included in the output.</dd>

</dl>

dir2md: Display a directory hierarchical structure in Markdown syntax

Description

Usage

Value

Arguments