multi-indexer

用于创建本地或远程目录的模板索引集合的实用工具。

这是做什么的？

multi-indexer 创建一个由mustache模板指定的类似Apache HTTPd索引的页面。此模板在此处提供，位于directory-index-template.html。

如果提供AWS S3存储桶上的远程位置，它将为远程目录/文件创建索引。（它不会上传任何索引文件。）

本地索引是递归的 - 它将为提供的路径相对于的子文件夹创建索引。

远程索引不是递归的 - 它只为提供的路径创建单个索引。

安装

使用pip安装

pip install multi-indexer

使用方法

从命令行作为python -m multi_indexer运行。

参数

该软件包可以导入为multi_indexer，尽管main()函数提供了大部分功能。

默认情况下，除非传递multi-indexer的-x/--execute标志，否则不会写入或上传任何文件。

您可以在项目仓库中找到示例HTML模板。

https://github.com/Knowledge-Graph-Hub/multi-indexer/blob/main/directory-index-template.html

如果没有提供模板，多索引器将使用此模板。

本地索引示例，仅用于本地测试

这假定 directory-index-template.html 文件位于您的当前工作目录中。

mkdir -p /tmp/foo/bar/bib/bab && mkdir -p /tmp/foo/bar/fish && mkdir -p /tmp/foo/bar/foul
touch /tmp/foo/top.md && touch /tmp/foo/bar/bib/bab/bottom.txt && touch /tmp/foo/bar/fish/trout.f && touch /tmp/foo/bar/fish/bass.f
multi_indexer -v --inject ./directory-index-template.html --directory /tmp/foo --prefix file:///tmp/foo -x

本地索引示例，假定索引将被上传

multi_indexer -v --inject ./directory-index-template.html --directory $WORKSPACE/mnt --prefix https://soyouhave.afancy.website/$PROJECTDIR/ -x'

远程索引示例

multi_indexer -v --inject ./directory-index-template.html --prefix https://soyouhave.afancy.website/$PROJECTDIR/ -b a-bucket-name -r $PROJECTDIR -x'

致谢

改编自 Eric Douglass、Seth Carbon 和 Justin Reese 的 directory_indexer.py，最初位于 https://github.com/Knowledge-Graph-Hub/go-site/blob/master/scripts/multi_indexer.py