#hugo #json #static-site #command-line-tool #lunr

bin+lib hugo_to_json

一个用于生成 Hugo 站点 JSON 表示的库和命令行工具

5 个版本

0.3.9 2021 年 4 月 3 日
0.3.4 2019 年 8 月 22 日
0.3.2 2019 年 3 月 30 日
0.3.1 2019 年 3 月 2 日
0.3.0 2019 年 3 月 2 日

#2406 in 命令行工具

MIT 许可证

48KB
1K SLoC

HugoToJSON

CircleCI Crate

HugoToJSON 是一个工具,用于生成 Hugo 文档的关键前导内容和内容的 JSON 表示。其主要目的是生成用于 Lunr(以及类似 Lunr 的包)的 JSON,以支持静态 Hugo 站点的搜索。它被设计为一个快速且现代的替代品,现在不再受支持的 hugo_lunr Node 工具

欢迎提交拉取请求。待办事项和要完成的工作列表可在 ToDo.txt 中找到。

它目前支持 .md 文件以及 YAML 和 TOML 前导内容。

使用

hugo_to_jsonHUGO_CONTENT_DIRECTORY -oOUTPUT_LOCATION

以下示例展示了用法:hugo_to_json example/blog/content -o example/blog/static/index.json

默认内容目录为 ./content,索引输出为 stdout。

获取最新版本

如果您想将此工具的最新版本作为 CI 构建流程的一部分使用,以下脚本应该可以工作。

#!/usr/bin/env bash
set -e

# Based on
#https://blog.markvincze.com/download-artifacts-from-a-latest-github-release-in-sh-and-powershell/

LATEST_RELEASE=$(curl -L -s -H 'Accept: application/json' https://github.com/arranf/HugoToJSON/releases/latest)
# The releases are returned in the format {"id":3622206,"tag_name":"hello-1.0.0.11",...}, we have to extract the tag_name.
LATEST_VERSION=$(echo $LATEST_RELEASE | sed -e 's/.*"tag_name":"\([^"]*\)".*/\1/')
ARTIFACT_URL="https://github.com/arranf/HugoToJSON/releases/download/$LATEST_VERSION/hugo_to_json"
INSTALL_DIRECTORY="."
INSTALL_NAME="hugo_to_json"
DOWNLOAD_FILE="$INSTALL_DIRECTORY/$INSTALL_NAME"

 echo "Fetching $ARTIFACT_URL.."
if test -x "$(command -v curl)"; then
    code=$(curl -s -w '%{http_code}' -L "$ARTIFACT_URL" -o "$DOWNLOAD_FILE")
elif test -x "$(command -v wget)"; then
    code=$(wget -q -O "$DOWNLOAD_FILE" --server-response "$ARTIFACT_URL" 2>&1 | awk '/^  HTTP/{print $2}' | tail -1)
else
    echo "Neither curl nor wget was available to perform http requests."
    exit 1
fi

if [ "$code" != 200 ]; then
    echo "Request failed with code $code"
    exit 1
fi

chmod +x "$DOWNLOAD_FILE"

依赖关系

~6–16MB
~191K SLoC