Restatic 项目启动与配置教程

1. 项目目录结构及介绍

restatic 是一个用于生成静态网站的工具。以下是项目的目录结构及各部分功能介绍：

restatic/
├── bin/              # 存放可执行文件
├── restatic/         # restatic 的核心代码目录
│   ├── __init__.py
│   ├── app.py        # restatic 应用的主要入口
│   ├── builder.py    # 网站构建相关逻辑
│   ├── compiler.py   # 编译器相关逻辑
│   ├── converter.py  # 转换器相关逻辑
│   ├── generator.py  # 生成器相关逻辑
│   ├── reader.py     # 读取器相关逻辑
│   ├── server.py     # 内置服务器相关逻辑
│   └── utils.py      # 工具类
├── tests/            # 测试代码目录
│   ├── __init__.py
│   └── test_app.py   # 应用测试
├── examples/         # 示例项目目录
├── setup.py          # 项目安装脚本
└── README.md         # 项目说明文档

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，名为 restatic。这是一个可执行文件，用于启动 restatic 应用。运行以下命令可以启动 restatic：

./bin/restatic

该命令会启动 restatic 的内置服务器，默认监听 http://localhost:8000 地址。

3. 项目的配置文件介绍

restatic 的配置文件通常是 config.py，它位于项目的根目录。以下是配置文件的基本结构和说明：

# config.py

# 基本配置
DEBUG = True
SECRET_KEY = 'your_secret_key'

# 数据源配置
SOURCES = {
    'markdown': {
        'path': 'content/',  # Markdown 文件存放路径
        'pattern': '**/*.md',  # 文件匹配模式
        'exclude': ['exclude/*'],  # 排除的目录或文件
    }
}

# 生成文件配置
OUTPUT = 'output/'  # 输出目录

# 服务器配置
HOST = 'localhost'
PORT = 8000

# 其他配置
# 这里可以添加其他需要的配置项

在配置文件中，你可以根据需要修改各种设置，例如调试模式、密钥、数据源路径、输出路径、服务器地址和端口等。修改完成后，确保将配置文件保存，以便 restatic 应用在启动时加载这些配置。