# f2e-easy-docs

**Repository Path**: f2e-server/f2e-easy-docs

## Basic Information

- **Project Name**: f2e-easy-docs
- **Description**: f2e-server 创建的简单文档分享工具，支持快速导出方便web服务配置
- **Primary Language**: NodeJS
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-12-24
- **Last Updated**: 2025-03-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# f2e-easy-docs  

支持通过编辑markdown文档，生成文档站点！主要功能包括：
- 管理端：
    1. 用户管理：登录、角色、用户
    2. 站点管理：创建、修改、删除、导入导出（结构和文档）
    3. 文档管理：创建、修改（图片、附件上传展示）、删除
- 导出端：
    1. 导出站点：导出站点，包含结构和文档
    2. 导出文档：导出文档，包含图片、附件
    3. 生成的文档结构:
       ``` bash
       <项目名称>.zip
       └─ docs
           ├─ files  # 图片附件等文件存储位置
           └─ index.html # 站点HTML、CSS、JS全部bundle在 index.html
       ```
- 部署端：
    1. 提供部署配置参考  
       直接解压到Nginx项目根目录, 访问路径 `/docs/` **(结尾"/"必需)**