dir2md: Display a directory hierarchical structure in Markdown syntax

View source: R/individual.R

dir2mdR Documentation

Display a directory hierarchical structure in Markdown syntax

Description

Display a directory hierarchical structure in Markdown syntax

Usage

dir2md(from = ".", dir_files = TRUE, dir_all = TRUE, dir_excluded = NA)

Arguments

from

Character. The source text of the (R) Markdown syntax text, the R code, the FreeMind mind map code, or the path to the directory.

dir_files

Logical. Whether to include files. If FALSE, only folders are included. If TRUE, folders and files are included.

dir_all

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

dir_excluded

Character. The directories which are not included in the output.

Value

Character, in Markdown syntax.


mindr documentation built on Dec. 20, 2025, 1:06 a.m.

Related to dir2md in mindr...