Letterpress 博客系统安装与使用指南

1. 项目目录结构及介绍

Letterpress 是一个基于 Markdown 的轻量级博客框架，完全由 Python 编写。以下是项目的基本目录结构及其简介：

Letterpress/
├── code/
│   ├── letterpress.py  # 核心运行脚本，负责监控Markdown文件并生成静态HTML页面
│   └── markdown2/      # 包含markdown处理库markdown2的源代码，用于转换Markdown到HTML
├── press/              # 存放博客文章的目录（示例或初始设置时需要手动创建）
│   ├── sample_post.md  # 示例文章，展示了文章的基本结构
│   └── ...             # 其他文章文件
├── templates/          # 包含模板文件，如主页、文章布局等，Letterpress据此构建网站的样式
├── press Folder        # 指向存放文章的目录，实际使用时需根据实际情况创建和配置
├── letterpress.config  # 系统配置文件，定义了日期格式、站点信息等
└── README.md           # 项目说明文档，包括安装和使用指导

2. 项目的启动文件介绍

• letterpress.py：这个是项目的主程序文件，它利用Python的pyinotify库来监视位于press_folder中的Markdown文件变化。当检测到新文件被添加、现有文件更新或删除时，它将执行相应的操作来更新静态网页。此外，它还监控模板文件的变化，并在必要时重建整个站点。

3. 项目的配置文件介绍

• letterpress.config：此配置文件是Letterpress的核心配置所在，含有以下关键项：
  • 日期格式：指定文章日期的显示格式。
  • 站点标题：用于自定义你的博客标题。
  • Twitter handle：如果你希望文章中包含指向Twitter的链接，可以在这里设置你的用户名。
  • 其他个性化设置：可能还包括资产路径、是否开启代码高亮等功能的开关等，这些都根据个人需求进行调整。

配置示例:

title: 我的个人博客
date_format: yyyy-mm-dd
excerpt_length: 100
site_dir: output
templates: templates
post_dir: press

安装与基本使用步骤

1. 先决条件: 确保你的系统满足Python 3版本要求，并安装必要的依赖，例如pyinotify。
2. 部署依赖: 复制letterpress.py和markdown2.py到Python运行时路径。
3. 配置环境: 创建press_folder，复制必要的文件，并根据需要修改letterpress.config。
4. 安装额外库: 如需代码高亮，安装Pygments。
5. 启动项目: 使用命令 python letterpress.py path_to_press_folder 来监控并构建站点。

通过以上步骤，你可以快速搭建起基于Letterpress的个人Markdown博客系统。确保按照目录结构和配置文件的要求正确设置，以充分利用该系统的功能。