aius/documents

AIUS/Documents镜像概述

该镜像提供AIUS文档管理工具，用于处理各类文档（如会议记录、报告、通用文档等），支持文档构建、清理、索引等操作，并生成HTML索引页和JSON元数据文件。

核心功能

• 列出仓库内所有文档文件
• 批量或单个构建文档
• 清理生成的文档及元数据
• 检测文档源文件的潜在缺陷
• 生成文档元数据JSON文件与HTML索引页

前提条件

使用工具需安装以下依赖：

• moonscript（版本≥0.5.0）
• luafilesystem
• lyaml
• pandoc（建议使用非过时版本）

通过Luarocks安装依赖：

bash
luarocks install luafilesystem
luarocks install lyaml
luarocks install moonscript

使用场景

• 管理AIUS组织的各类文档（会议记录、报告等）
• 生成文档索引以快速检索
• 批量构建或清理文档资源

使用说明

工具基本命令格式：

bash
./helper [-d] [-h] <command> ...

选项：

• -d, --debug：启用详细调试输出
• -h, --help：显示帮助信息

主要命令：

• list（或l）：列出仓库文件（-c选项可彩色显示）
• build（或b）：构建全部/指定文档（如./helper build file.md）
• clean（或c）：清理生成的文档及元数据（可指定源文件）
• status（或s）：检测文档源文件缺陷（可指定源文件）
• index（或i）：生成元数据JSON与HTML索引页

每个命令可通过./helper <command> --help查看详细帮助。

文档结构

仓库文档按目录分类存储：

• doc/：存放通用文档
• pv/：存放会议记录或协会大会报告
• cr/：存放会议记录或AIUS参与事件的笔记
• pv/comite/：存放AIUS委员会会议记录
• other/：存放其他类别文档

目录用于生成索引页的分类（显示为彩色方块）。