markmv index
Generate index files for markdown documentation
Usage
markmv index [options] [directory]
Arguments
| Argument |
Description |
Default |
[directory] |
Directory to generate indexes for |
. |
Options
| Option |
Description |
Default |
-t, --type <type> |
Index type: links|import|embed|hybrid |
links |
-s, --strategy <strategy> |
Organization strategy: directory|metadata|manual |
directory |
-l, --location <location> |
Index placement: all|root|branch|existing |
root |
-n, --name <name> |
Index filename |
index.md |
--embed-style <style> |
Embed style for embed type: obsidian|markdown |
obsidian |
--template <file> |
Custom template file |
|
--max-depth <number> |
Maximum depth to traverse subdirectories |
|
--no-traverse-up |
Prevent traversing above the specified directory |
|
--boundary <path> |
Explicit boundary path to limit scanning scope |
|
--generate-toc |
Generate table of contents for each indexed file |
|
--toc-min-depth <number> |
Minimum heading level for TOC (1-6) |
1 |
--toc-max-depth <number> |
Maximum heading level for TOC (1-6) |
6 |
--toc-include-line-numbers |
Include line numbers in table of contents |
|
-d, --dry-run |
Show what would be generated without creating files |
|
-v, --verbose |
Show detailed output |
|
--json |
Output results in JSON format |
|