首页
/ Sigal - 简单静态图库生成器技术文档

Sigal - 简单静态图库生成器技术文档

2024-12-24 18:46:12作者:钟日瑜

1. 安装指南

环境要求

  • Python 3.9 或更高版本

安装步骤

  1. 使用 pip 安装

    pip install sigal
    
  2. 从源码安装

    • 克隆项目仓库:
      git clone https://github.com/saimn/sigal.git
      
    • 进入项目目录:
      cd sigal
      
    • 安装依赖:
      pip install -r requirements.txt
      
    • 安装 Sigal:
      python setup.py install
      

2. 项目使用说明

基本用法

  1. 创建图库

    • 在项目目录下创建一个包含图片的文件夹。
    • 运行以下命令生成图库:
      sigal build <图片文件夹路径> -o <输出目录>
      
  2. 使用主题

    • Sigal 提供了三种主题:colorboxgalleriaphotoswipe
    • 在生成图库时,可以通过 --theme 参数指定主题:
      sigal build <图片文件夹路径> -o <输出目录> --theme galleria
      

配置文件

  • Sigal 支持通过配置文件进行自定义设置。可以在项目目录下创建一个 sigal.conf.py 文件,并在其中定义配置项。
  • 示例配置文件:
    # sigal.conf.py
    source = 'path/to/your/images'
    destination = 'output/directory'
    theme = 'galleria'
    

3. 项目API使用文档

主要API

  • sigal.init(config): 初始化 Sigal 配置。
  • sigal.build(source, destination, theme): 生成图库。
    • source: 图片文件夹路径。
    • destination: 输出目录。
    • theme: 主题名称。

示例

from sigal import init, build

config = {
    'source': 'path/to/your/images',
    'destination': 'output/directory',
    'theme': 'galleria'
}

init(config)
build(config['source'], config['destination'], config['theme'])

4. 项目安装方式

通过 pip 安装

pip install sigal

从源码安装

  1. 克隆项目仓库:
    git clone https://github.com/saimn/sigal.git
    
  2. 进入项目目录:
    cd sigal
    
  3. 安装依赖:
    pip install -r requirements.txt
    
  4. 安装 Sigal:
    python setup.py install
    

通过以上步骤,您可以成功安装并使用 Sigal 生成静态图库。

登录后查看全文
热门项目推荐
相关项目推荐