HugoPhotoSwipe, 在Hugo中,命令行 工具易于PhotoSwipe库

分享于 

6分钟阅读

GitHub

  繁體 雙語
Python tool for creating PhotoSwipe galleries when using the Hugo static website generator
  • 源代码名称:HugoPhotoSwipe
  • 源代码网址:http://www.github.com/GjjvdBurg/HugoPhotoSwipe
  • HugoPhotoSwipe源代码文档
  • HugoPhotoSwipe源代码下载
  • Git URL:
    git://www.github.com/GjjvdBurg/HugoPhotoSwipe.git
    Git Clone代码到本地:
    git clone http://www.github.com/GjjvdBurg/HugoPhotoSwipe
    Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/GjjvdBurg/HugoPhotoSwipe
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
    HugoPhotoSwipe

    HugoPhotoSwipe是使用 Hugo/网站生成器时轻松创建和管理PhotoSwipe的命令行 应用程序。

    为什么?

    我使用Hugo创建了个人网站,所以所有源文档都创建为 Markdown 文件。 我想在网站上也有相册,使用PhotoSwipe查看器。 我也想容易地设置照片描述,快速更新相册,并且自动生成响应的图像大小和缩略图。 HugoPhotoSwipe使所有这些变得很容易。

    在这里查看我的博客帖子 ,了解更多关于我制作这个工具的动机。

    PhotoSwipe需要一些Javascript和特定的HTML格式,而Hugo通常使用 Markdown 文件。 这个程序为Hugo创建一个 Markdown 文件,以基于 Hugo 的shortcodes 工作。 然后使用这些代码来创建PhotoSwipe需要的HTML代码。 参见 docs 目录中的shortcodes。

    安装

    在PyPI上可以使用 HugoPhotoSwipe,你可以使用pip轻松安装它:

    pip install --process-dependency-links hugophotoswipe

    安装后,你应该有 hps 程序了。

    用法

    这是一个简单的概述。 请参见 Wiki 以获得完整的描述。

    为HugoPhotoSwipe和 switch 创建一个新目录。 举个例子:

    mkdir hugophotos
    cd hugophotos

    接下来,使用以下方法初始化HugoPhotoSwipe配置:

    hps init

    这将创建一个新的HugoPhotoSwipe配置文件,称为 hugophotoswipe.yml。 这是一个 YAML文件文件。 在这个配置文件中,你需要至少设置 markdown_diroutput_dir 变量。 这些分别是需要放置 Markdown的目录和处理照片需要放置的目录。 你可能还需要设置 url_prefix 变量,该变量添加到照片文件的路径之前。

    创建一个新相册使用:

    hps new

    HugoPhotoSwipe会问你新专辑的NAME,并为你创建一个带有 NAME的目录。 尽量保持姓名简短,它们不是专辑的final 标题。 NAME 中的空格将自动替换为下划线。 在新目录中,你将找到一个 album.yml 文件和一个空的photos 目录。

    此时,应该在 photos 目录中放置一些照片,并在 album.yml 文件中设置相册的标题字段。 你还可以设置相册日期。版权线和coverimage的文件名。 在 properties 行下放置的键值对将放置在 Markdown 文件的开头,因此你可以在Hugo布局中使用它们。 例如你可能想要添加国家域。相机详细信息等。

    在主目录(。hugophotoswipe.yml 文件的位置) 中,你现在可以运行:

    hps update

    要创建 Markdown 文件,调整大小的照片,并更新 album.yml 文件。 HugoPhotoSwipe创建大的和小的照片大小,以及使用 SmartCrop.py的缩略图。

    如果现在打开 album.yml 文件,你将注意到照片和散列的字段已经被扩展。 在 photos: 下,目录中的所有照片都将列出,每个照片都有 filenamealtcaption 字段。 最后三个字段可以由你编辑。 这样做对你的照片SEO很有用,但不需要。 album.yml 文件中的hashes 字段用于检测照片中的更改,不需要对它的进行编辑。

    最后,如果要重新生成所有 Markdown 和调整大小的照片,始终可以使用:

    hps clean

    清理所有东西这当然不会触及原始照片文件。

    注释

    我注意到缩略图与 SmartCrop.jsSmartCrop.py 略好一些。 因此,在 hugophotoswipe.yml 文件中,可以将选项 use_smartcrop_js 设置为 True,将 smartcrop_js_path 设置为 smartcrop-cli.js 命令行实用程序的路径。 这确保了使用 SmartCrop.js. 创建缩略图

    HugoPhotoSwipe是免费软件,可以使用GNU通用 public 许可以证,版本 3或者更高版本( GPLv3 )。 版权所有 G.J.。van den Burg,保留所有权利。

    如果你遇到任何问题,请在上打开一个问题。 你可以在这里与我联系: @GJJvandenBurg


    COM  tool  COMM  Comma  命令行  gal