# teedoc_with_shortrange

**Repository Path**: qpy-doc-center/teedoc_with_shortrange

## Basic Information

- **Project Name**: teedoc_with_shortrange
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

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

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Shortrange Doc Center

## 说明

项目采用[teedoc](https://teedoc.neucrack.com/)工具构建生成，官方文档: [zh](https://teedoc.neucrack.com/get_started/zh/)\\[en](https://teedoc.neucrack.com/get_started/en/index.html)

文档目录位于`docs`文件夹下面，各个首页、错误页或者其他页面放于`pages`中设置

## 构建与运行指导

1. `python3`，teedoc基于python3开发，需要保证有python3程序运行的相关环境
2. `teedoc`，执行`pip install teedoc`，安装工具链
3. `teedoc -d new_site init`，新建文件目录之后在该目录之下初始化文档项目

```bash
mkdir new_site && cd new_site
teedoc init
```

4. `teedoc install`，根据配置的插件信息安装插件
5. `teedoc serve`，部署http服务，使用该指令部署的带有热更新，访问地址为：[http://127.0.0.1:2333](http://127.0.0.1:2333)
> 如果只是需要生成HTML页面不部署http服务，可以只运行构建指令`teedoc build`，生成的页面都放置于`out`文件夹下

## 自定义

由于`teedoc`仍然具有很多局限性，如需要更多的功能需要自写html或者部署脚本来实现自己更多的需求，在本项目之中推荐使用`./build.sh`来部署修改js或css或其他地方做小修改后的页面

`build.sh`中是基于python内置http库部署的，不带热更新