Victor Hugo 项目教程
1. 项目目录结构及介绍
Victor Hugo 项目的目录结构如下:
|-- site // Hugo 构建的所有内容
| |-- content // 页面和集合
| |-- data // YAML 数据文件
| |-- layouts // 模板文件
| | |-- partials // 包含文件
| | |-- index.html // 首页模板
| |-- resources // 资源文件
| |-- static // 静态文件,最终会放在 public 文件夹中
|-- src // 通过资产管道处理的文件
| |-- css // Webpack 会单独打包导入的 CSS 文件
| |-- index.js // Webpack 入口文件,用于处理 CSS 和 JS 资产
详细介绍
-
site: 包含 Hugo 构建的所有内容。
- content: 存放页面和集合文件。
- data: 存放 YAML 数据文件,用于数据驱动的内容。
- layouts: 存放模板文件。
- partials: 存放包含文件,用于模板中的可重用部分。
- index.html: 首页模板文件。
- resources: 存放资源文件。
- static: 存放静态文件,如图片、字体等,这些文件最终会放在 public 文件夹中。
-
src: 包含通过资产管道处理的文件。
- css: 存放 Webpack 会单独打包的 CSS 文件。
- index.js: Webpack 的入口文件,用于处理 CSS 和 JS 资产。
2. 项目启动文件介绍
项目的启动文件主要是 src/index.js
,它是 Webpack 的入口文件。该文件负责导入和处理项目的 CSS 和 JavaScript 资产。
详细介绍
- src/index.js:
- 作为 Webpack 的入口文件,负责导入和处理项目的 CSS 和 JavaScript 资产。
- 可以使用 ES6 语法,并且可以导入 npm 中的库。
- 任何导入到
index.js
中的 CSS 文件都会通过 Webpack 进行处理,使用 PostCSS 进行编译,并最终生成到/dist/[name].[hash:5].css
。
3. 项目配置文件介绍
项目的配置文件主要包括以下几个:
- netlify.toml: Netlify 的配置文件,用于定义构建和部署的设置。
- package.json: 项目的 npm 配置文件,定义了项目的依赖和脚本。
- webpack.common.js: Webpack 的通用配置文件。
- webpack.dev.js: Webpack 的开发环境配置文件。
- webpack.prod.js: Webpack 的生产环境配置文件。
详细介绍
-
netlify.toml:
- 定义了 Netlify 的构建和部署设置。
- 包括构建命令、发布目录等。
-
package.json:
- 定义了项目的依赖和脚本。
- 包括项目的名称、版本、描述、作者、许可证等信息。
- 定义了开发和构建的脚本,如
npm start
、npm run build
等。
-
webpack.common.js:
- Webpack 的通用配置文件,定义了 Webpack 的基本配置。
- 包括入口文件、输出目录、模块解析规则等。
-
webpack.dev.js:
- Webpack 的开发环境配置文件,定义了开发环境下的 Webpack 配置。
- 包括开发服务器、热更新等配置。
-
webpack.prod.js:
- Webpack 的生产环境配置文件,定义了生产环境下的 Webpack 配置。
- 包括代码压缩、优化等配置。
通过以上配置文件,可以灵活地控制项目的构建和部署流程,确保项目在不同环境下的稳定运行。