README

摘要

使用一个非常简单的JSON文件模式来定义您网站的架构，该项目使用该架构生成一个美观的、视觉HTML网站地图。最终的文档包含了所有图标和CSS，可以轻松与其他团队成员共享。主要的字体使用Google Fonts，需要网络访问，然而回退字体离线也能正常工作。

查看 example.json 了解定义文件的样式。

在浏览器中打开 example.html 查看示例视觉网站地图。

访问 https://aklump.github.io/visual_sitemap 获取完整文档。

快速入门

• 安装 vismap 后，创建一个新的数据文件，例如 vismap {FILENAME}.json -c
• 将文件的原始内容替换为实际内容。
• 在终端中输入 vismap {FILENAME}.json 编译网站地图。
• 在浏览器中打开 {FILENAME}.html。

要求

1. 您需要 Composer 来安装。
2. 您需要一个文本编辑器来编辑JSON文件。
3. 您需要一个命令行终端来生成地图。

贡献

如果您觉得这个项目很有用...请考虑 捐款。

安装

使用Composer全局安装

为了能够在CLI中的任何目录使用命令，您可能想全局安装它。

composer global require aklump/visual-sitemap

确保您的 PATH 中有composer bin目录。默认值是 ~/.composer/vendor/bin，但您可以通过运行 composer global config bin-dir --absolute 检查您需要使用的值。

为此，您必须打开 ~/.bash_profile（或 ~/.bashrc）；您正在寻找类似以下内容的行，如果您找不到，您可能需要添加它。

export PATH=~/.composer/vendor/bin:$PATH

使用Composer按项目安装

cd /your/project/folder
composer require aklump/visual-sitemap

测试安装

1. 通过在终端中输入 vismap 测试您的安装，您应该会看到

    Argument 1 must point to a configuration json file.
   

用法

1. 根据模式创建配置JSON文件。使用 example.json 和 quick_start.json 作为指南。如果您希望使用CLI来创建文件（它复制并重命名 quick_start.json），请执行以下操作

    cd /the/dir/to/contain/the/config
    vismap FILENAME.json -c
   

2. 您还可以参考 schema.json，它使用 JSON Schema 定义配置文件的格式。

3. 运行以下命令以生成HTML版本： vismap sitemap.json。将创建 sitemap.html。如果 sitemap.html 已经存在，您需要使用 -f 标志来覆盖它，例如 vismap sitemap.json -f。

4. 有一个文件监视命令可用。当您对JSON文件进行更改时，网站地图会自动重新生成。使用 vismapwatch sitemap.json 进行此操作。再次，如果HTML文件已经存在，请使用 -f 标志。

5. 使用--out={filepath}来控制输出位置，该位置相对于源文件是强制的。您也可以使用以/开头的绝对路径。

作为JSON格式

您可以使用--format=json将您的网站地图导出为JSON格式。注意：使用的扩展名将是.compiled.json

vismap example.json -f --format=json

作为文本列表

您可以使用--format=list导出章节和标题的列表。

最佳实践

1. 除非您打算更改与项目关联的章节编号，否则不要更改JSON文件中项目的顺序。也就是说，始终将新项目追加到章节数组的末尾。不遵循此点会导致您的章节编号重新分配给不同的章节。