Portfolio-Generator 项目使用文档

1. 项目的目录结构及介绍

Portfolio-Generator/
├── assets/
│   ├── css/
│   ├── images/
│   └── js/
├── config/
│   └── config.json
├── templates/
│   └── index.html
├── src/
│   ├── main.py
│   └── utils.py
├── README.md
└── requirements.txt

目录结构介绍

• assets/: 存放项目的静态资源文件，包括CSS样式表、图片和JavaScript脚本。
  • css/: 存放项目的CSS样式文件。
  • images/: 存放项目的图片资源。
  • js/: 存放项目的JavaScript脚本文件。
• config/: 存放项目的配置文件。
  • config.json: 项目的配置文件，包含项目的各种配置参数。
• templates/: 存放项目的HTML模板文件。
  • index.html: 项目的主页面模板。
• src/: 存放项目的源代码文件。
  • main.py: 项目的启动文件，负责初始化和启动项目。
  • utils.py: 项目中使用的工具函数。
• README.md: 项目的说明文档，包含项目的简介、安装和使用说明。
• requirements.txt: 项目所需的Python依赖包列表。

2. 项目的启动文件介绍

main.py

main.py 是项目的启动文件，负责初始化和启动整个项目。以下是该文件的主要功能：

• 初始化配置: 读取 config/config.json 文件中的配置参数，并根据这些参数初始化项目。
• 加载模板: 加载 templates/index.html 模板文件，并根据配置参数生成最终的HTML页面。
• 启动项目: 启动项目，生成最终的静态文件，并输出到指定目录。

3. 项目的配置文件介绍

config.json

config.json 是项目的配置文件，包含项目的各种配置参数。以下是该文件的主要内容：

{
  "title": "My Portfolio",
  "description": "This is my personal portfolio.",
  "author": "Anupam Dagar",
  "theme": "default",
  "assets": {
    "css": ["style.css"],
    "js": ["script.js"],
    "images": ["logo.png"]
  }
}

配置参数介绍

• title: 项目的标题，用于显示在生成的HTML页面的标题栏。
• description: 项目的描述，用于简要介绍项目的内容。
• author: 项目的作者，用于标识项目的创建者。
• theme: 项目的主题，用于指定项目的样式主题。
• assets: 项目的静态资源配置，包含CSS、JavaScript和图片文件的路径。
  • css: 项目中使用的CSS文件列表。
  • js: 项目中使用的JavaScript文件列表。
  • images: 项目中使用的图片文件列表。

---

以上是 Portfolio-Generator 项目的使用文档，涵盖了项目的目录结构、启动文件和配置文件的详细介绍。希望这份文档能帮助你更好地理解和使用该项目。