静态WordPress项目教程

静态WordPress项目教程

static-wordpress Python Library for Static WordPress (Autmated Crawling, Post-Processing and Hosting) 项目地址: https://gitcode.com/gh_mirrors/st/static-wordpress

1. 项目目录结构及介绍

静态WordPress项目是一个Python库，用于将WordPress安装转换为静态网站。以下是项目的目录结构及其简要介绍：

static-wordpress/
├── .github/              # 存放GitHub工作流文件
├── docs/                 # 项目文档
├── src/                  # 源代码目录
│   └── staticwordpress/   # 静态WordPress库代码
├── tests/                # 测试代码
├── .gitignore            # Git忽略文件
├── LICENSE               # 许可证文件
├── MANIFEST.in           # 打包配置文件
├── README.md             # 项目说明文件
├── mkdocs.yml            # MkDocs配置文件
├── netlify.toml          # Netlify配置文件
├── pyproject.toml        # Python项目配置文件
├── requirements.txt      # 项目依赖文件
├── setup.cfg             # 设置配置文件
├── setup.py              # 设置安装脚本
└── ss_script.py          # 静态网站部署脚本

2. 项目的启动文件介绍

项目的启动文件是ss_script.py。这个脚本负责初始化和运行静态WordPress转换过程。以下是启动文件的基本使用方法：

import sys
from staticwordpress.core.workflow import Workflow

# 配置日志
logging.basicConfig(
    format="%(asctime)s - %(levelname)s - %(message)s",
    level=logging.DEBUG,
    stream=sys.stdout,
)

# 创建工作流实例
swp = Workflow()

# 设置项目参数，如用户名、API令牌等
swp.create_project(
    project_name="simply-static-zip-deploy",
    wp_user="your_wordpress_username",
    wp_api_token="your_wordpress_api_token",
    src_url="your_wordpress_hosted_url",
    dst_url="your_static_site_hosted_url",
    output_folder="output_folder_path",
    src_type=SOURCE.ZIP,
    host_type=HOST.NETLIFY,
)

# 执行转换过程
swp.download_zip_file()
swp.setup_zip_folders()
swp.add_404_page()
swp.add_robots_txt()
swp.add_redirects()
swp.add_search()

3. 项目的配置文件介绍

项目的配置文件包括以下几个：

• pyproject.toml：定义了项目的元数据和依赖关系。
• requirements.txt：列出了项目运行所需的Python库。
• mkdocs.yml：配置了MkDocs文档生成工具的参数，用于生成项目的文档。
• netlify.toml：配置了Netlify部署的参数，用于在Netlify上部署静态网站。

这些配置文件为项目的开发、文档生成和部署提供了必要的设置。开发者需要根据实际情况调整这些文件中的参数，以满足项目的需求。

static-wordpress Python Library for Static WordPress (Autmated Crawling, Post-Processing and Hosting) 项目地址: https://gitcode.com/gh_mirrors/st/static-wordpress