Clastic 项目启动与配置教程

1. 项目目录结构及介绍

Clastic 是一个轻量级的静态网站生成器，以下是其主要的目录结构介绍：

• clastic/：项目的主目录，包含了项目的所有源代码。
  • __init__.py：初始化Python模块，使clastic目录成为一个Python包。
  • app.py：项目的主要应用文件，包含了网站的逻辑。
  • commands.py：包含了一些用于构建和部署网站的命令。
  • filters.py：包含了用于处理内容的过滤器。
  • nodes.py：定义了用于构建网站的各种节点类型。
  • plugins/：包含了一些可以扩展Clastic功能的插件。
  • static/：用于存放静态文件，如CSS、JavaScript等。
  • templates/：包含了网站的HTML模板文件。
• tests/：包含了项目的单元测试代码。
• setup.py：用于安装Clastic的Python包。
• README.rst：项目的README文件，包含了项目的介绍和使用说明。
• requirements.txt：列出了项目依赖的Python包。

2. 项目的启动文件介绍

项目的启动文件是clastic/app.py。以下是该文件的主要组成部分：

• create_app函数：该函数用于创建和配置Clastic应用。
• site对象：这是一个NodeSite实例，它负责管理网站的节点和页面。
• run函数：该函数用于启动Clastic的服务器，默认情况下监听本地端口5000。

启动Clastic的典型命令是：

from clastic import run
from myapp import create_app

if __name__ == '__main__':
    app = create_app()
    run(app)

这里，myapp是指当前应用的包名，create_app是创建应用实例的函数。

3. 项目的配置文件介绍

Clastic的配置主要通过环境变量或直接在代码中设置。以下是一些常见的配置选项：

• CLASTIC_PORT：设置Clastic服务器监听的端口号，默认为5000。
• CLASTIC_DEBUG：是否开启调试模式，开启后可以实时看到代码的更改，默认为False。
• CLASTIC-site-root：设置网站的根目录，通常不需要更改。
• CLASTIC-static-url：设置静态文件的URL路径，默认为/static/。

在app.py中，可以通过以下方式设置配置：

import os

app = create_app(
    debug=os.getenv('CLASTIC_DEBUG', False),
    port=os.getenv('CLASTIC_PORT', 5000),
    # 其他配置...
)

确保在启动Clastic之前设置好这些环境变量，以便正确配置和运行项目。