MDXTree

一个用于生成Astro的Starlight组件的MDX格式文件树结构的Rust命令行工具。

https://starlight.astro.build/guides/components/#file-tree

功能

• 从指定的目录生成文件树结构
• 输出到文件或stdout
• 可选包括Starlight的FileTree组件的导入语句
• 尊重.gitignore规则
• 处理隐藏文件和目录

安装

从crates.io安装

cargo install mdxtree

用法

mdxtree [OPTIONS] [PATH]


Arguments:

- `PATH`: Path to generate file tree from (default: current directory)

Options:

- `-o, --output <FILE>`: Output file path (default: stdout)
- `-i, --include-import`: Include import statement for FileTree component
- `-h, --help`: Print help information
- `-V, --version`: Print version information

示例

生成当前目录的文件树并将其输出到stdout

mdxtree .

<FileTree>
- Cargo.toml
- Cargo.lock
- readme.md
- .gitignore
- src/
  - main.rs
</FileTree>

许可证

MIT许可证