# MarkSite

**Repository Path**: bingbingyihao/mark-site

## Basic Information

- **Project Name**: MarkSite
- **Description**: 采用python代理指定文件夹，支持将markdown文档渲染成博客网页
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-03
- **Last Updated**: 2025-12-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MarkSite

## 📖 介绍

**MarkSite** 是一个轻量级的 Markdown 文档托管与展示服务。它使用 Python Flask 构建，能够代理指定的文件夹内容，自动读取其中的 Markdown 文件并渲染为结构清晰、样式美观的网页博客站点，非常适合用于文档展示、技术博客、项目说明等场景。

## 🧩 功能特点

- ✅ 自动扫描 `content` 目录，生成侧边栏导航树（支持多级目录）
- ✅ 支持 Markdown 文件实时渲染为 HTML
- ✅ 内置代码高亮（使用 `highlight.js`）
- ✅ 支持中文目录与文件名显示
- ✅ 响应式布局，适配 PC 与移动设备
- ✅ 简洁美观的 UI 样式（可自定义）

## 📁 项目结构

```
MarkSite/
├── app.py                # 主程序入口
├── content/              # 存放 Markdown 文档
├── webui/                # 前端静态资源
│   ├── index.html        # 主页面
│   └── style/            # CSS、JS、图片等静态资源
├── LICENSE               # Apache-2.0 开源协议
└── README.md             # 项目说明文档
```

## 🚀 快速开始

### 安装依赖

```bash
pip install flask
```

### 项目启动

```bash
cd code
python app.py
```

访问 `http://127.0.0.1:5000` 即可查看网页内容。

### 添加文档

将 `.md` 文件放入 `code/content/` 目录中，支持多级文件夹结构，系统会自动构建导航目录。

示例目录结构：

```
content/
├── index.md
├── about.md
├── blog/
│   ├── first-post.md
│   └── second-post.md
└── projects/
    └── my-project.md
```

## 🛠️ 开发与部署建议

- 使用 `Flask` 开发时建议开启 `debug=True` 模式
- 生产环境建议使用 `gunicorn` + `nginx` 部署
- 可通过修改 `webui/style` 中的 CSS 文件自定义主题样式
- 可扩展支持 Markdown 插件（如 Mermaid、TOC 自动生成等）

## 🤝 贡献指南

欢迎提交 Issue 和 Pull Request！请遵循以下建议：

1. Fork 项目
2. 创建新分支 (`git checkout -b feature/new-feature`)
3. 提交更改 (`git commit -m 'Add some feature'`)
4. 推送分支 (`git push origin feature/new-feature`)
5. 创建 Pull Request

## 📄 许可证

本项目采用 [Apache License 2.0](LICENSE) 开源协议。