HTMY 项目使用教程

1. 项目目录结构及介绍

HTMY 是一个基于 Python 的异步服务器端渲染引擎。项目的目录结构如下：

• ./htmy: 包含 HTMY 库的主要代码。
• ./docs: 存放项目文档的 markdown 文件。
• ./examples: 包含使用 HTMY 的示例代码。
• ./tests: 包含项目的单元测试。
• ./.github: 包含 GitHub 工作流的配置文件。
• ./.gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文件。
• mkdocs.yaml: MkDocs 文档生成器的配置文件。
• pyproject.toml: 包含项目元数据和构建系统配置。

2. 项目的启动文件介绍

HTMY 项目的启动通常涉及运行一个 Python 脚本，该脚本会使用 HTMY 库来渲染页面。以下是启动的基本步骤：

• 确保已经安装了 Python 环境和 HTMY 库。
• 在项目根目录下运行 Python 脚本，例如 main.py。

# main.py 示例
from htmy import html, Renderer

async def main():
    # 创建根组件
    root_component = html.html(html.body(html.h1("Hello World!")))
    # 创建渲染器并渲染组件
    renderer = Renderer()
    rendered_content = await renderer.render(root_component)
    print(rendered_content)

if __name__ == "__main__":
    import asyncio
    asyncio.run(main())

3. 项目的配置文件介绍

HTMY 项目的配置主要通过代码中的参数设置来实现，并没有单独的配置文件。但是，可以在项目根目录下的 pyproject.toml 文件中找到一些基本的配置，如项目名称、版本、描述等。以下是一个 pyproject.toml 文件的示例：

[build-system]
requires = ["setuptools", "wheel"]

[tool.setuptools]
name = "htmy"
version = "0.1.0"
description = "Async, pure-Python server-side rendering engine."
long_description = "..."
author = "Your Name"
author_email = "[e-mail]"
url = "https://github.com/volfpeter/htmy"
packages = find:
python_requires = ">=3.7"

在开发过程中，您可能需要根据项目需求修改这些配置。例如，添加依赖项、修改项目描述或版本号等。

以上是 HTMY 项目的简单使用教程，希望对您有所帮助。