# Half Node

**Repository Path**: half_tree/half-node

## Basic Information

- **Project Name**: Half Node
- **Description**: Half Node 是 half_tree 的自用博客模板，该博客通过 FastAPI 架构主持 Web 服务，托管用户的 Typst 文档并自动将其编译为 PDF 以展示在网页上以供他人访问。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-14
- **Last Updated**: 2025-10-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Half Node

## 简介

Half Node 是 half_tree 的自用博客模板，该博客通过 FastAPI 架构主持 Web 服务，托管用户的 Typst 文档并自动将其编译为 PDF 以展示在网页上以供他人访问。

## 部署

得益于该架构和 Typst 的特性，该项目跨平台，可部署在任何支持 FastAPI 和 Typst 的操作系统上。

- 首先应当安装 Typst CLI，具体安装方法请参考 Typst 官方文档；

- 然后应当克隆本仓库，并安装 Python 依赖：

```bash
cd half-node
pip install -r requirements.txt
```

- 接下来创建 `documents` 文件夹和 `description.json`，并将 Typst 文档放入其中：

```bash
mkdir documents
touch documents/description.json
```

目录结构应当看起来像这样

```
documents/
├── description.json
├── 上位机与物联网开发
│   └── ROS2的配置与基础概念.typ
└── 下位机与嵌入式开发
    └── 通信协议栈.typ
```

- 在 `description.json` 中添加文件夹描述信息，格式如下：

```json
{
    ".": "Root",
    "下位机与嵌入式开发": "研究硬件与软件的结合",
    "上位机与物联网开发": "实现设备间的互联互通"
}
```

- 最后在 `/static/config.json` 中配置网页的基础信息

```json
{
    "title": "Half Node",
    "description": "我所知道的不过是世界的冰山一角",
    "author": "half_tree (ﾟ∀ﾟ) 2023 - 2025"
}
```

- 配置完成，可以启动 FastAPI 服务了，启动后即可访问网页服务

```bash
python3 main.py
```