README.md · 哈里/nn-to-markdown

# JSON 到 Markdown 树状图转换器

## 项目描述

这个 Python 脚本可以将特定格式的 JSON 文件转换为 Markdown 格式的树状图。主要用于将小说结构或其他层级数据可视化为易读的树状结构。

## 功能特点

- 将 JSON 文件转换为 Markdown 树状图
- 支持命令行参数输入
- 自动生成输出文件名（如果未指定）
- 保留节点间的层级关系
- 按 Y 坐标排序节点
- 包含创建时间和版本信息

## 使用方法

1. 确保您的系统已安装 Python 3。

2. 在命令行中运行脚本，格式如下：

```
   python n2m.py 输入文件路径 [-o 输出文件路径]
   ```

例如：

```
   python n2m.py 小说结构.nn
   ```

或者指定输出文件：

```
   python n2m.py 小说结构.nn -o 小说树状图.md
   ```

3. 脚本将生成 Markdown 文件，默认文件名为原文件名加上"_树状图.md"后缀。

## 输入文件格式

输入的 JSON 文件应包含以下结构：

- `nodes`: 节点数组，每个节点包含 `name`、`text` 和 `pos` 属性
- `links`: 链接数组，定义节点间的关系
- `version`: 版本信息

## 注意事项

- 确保输入文件存在且格式正确
- 输出文件将以 UTF-8 编码保存

## 贡献

欢迎提出问题、建议或贡献代码来改进这个项目。

## 许可证

本项目采用 MIT 许可证。详情请见 [LICENSE](LICENSE) 文件。

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

哈里/nn-to-markdown

简介

发行版

贡献者

近期动态

哈里/nn-to-markdown .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

哈里/nn-to-markdown