数字政府项目（digitalgov.gov）使用教程

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

digitalgov.gov 项目是一个开源的静态网站，使用 Hugo 作为站点引擎，并通过 cloud.pages.gov 进行托管。以下是项目的目录结构及各部分的简要介绍：

digitalgov.gov/
├── .circleci/                # CircleCI 配置文件
├── .github/                  # GitHub 工作流和配置文件
├── .husky/                   # Husky 配置文件，用于 Git 钩子
├── config/                   # 配置文件
├── content/                  # 网站内容文件，包括 Markdown 文件
├── data/                     # 数据文件，如 JSON 或 YAML 格式
├── scripts/                  # 脚本文件
├── static/                   # 静态文件，如图片、CSS、JavaScript 文件
├── themes/                   # Hugo 主题
├── .browserslistrc           # Browserslist 配置文件
├── .eslintrc.yml             # ESLint 配置文件
├── .gitignore                # Git 忽略文件
├── .hugo-version             # Hugo 版本文件
├── .markdown-lint.yml        # Markdown Lint 配置文件
├── .nvmrc                    # Node.js 版本管理器配置文件
├── .pa11yci                  # Pa11y ci 配置文件
├── .prettierignore           # Prettier 忽略文件
├── .prettierrc               # Prettier 配置文件
├── .stylelintrc.json         # Stylelint 配置文件
├── CODE_OF_CONDUCT.md        # 行为准则文件
├── CONTRIBUTING.md           # 贡献指南文件
├── LICENSE.md                # 许可证文件
├── SECURITY.md               # 安全策略文件
├── config.yml                # 网站配置文件
├── env.example               # 环境变量示例文件
├── gulpfile.js               # Gulp 配置文件
├── logs.txt                  # 日志文件
├── package-lock.json         # npm 包锁定文件
├── package.json              # npm 包配置文件
├── readme.md                 # README 文件
└── tsconfig.json             # TypeScript 配置文件

2. 项目的启动文件介绍

项目的启动主要依赖于 package.json 文件中定义的 npm 脚本。以下是一些主要的启动文件和脚本：

• package.json: 包含项目的依赖和启动脚本。在终端运行 npm install 来安装依赖。
• npm start: 运行这个脚本来启动本地开发服务器。它会执行以下任务：
  • gulp env: 设置环境变量为开发环境。
  • gulp: 构建和压缩 SCSS 和 JS 文件，并复制 jQuery 和 uswds JS 文件到 /dist/ 目录。
  • gulp watch: 开始监视 SCSS 和 JS 文件的变化。
  • hugo serve: 构建所有 Hugo 页面并创建一个本地服务器在 http://localhost:1313/。

启动本地服务器的命令是：

npm start

3. 项目的配置文件介绍

项目的配置主要通过以下文件进行：

• config.yml: 这是 Hugo 的主要配置文件，用于设置网站的基本信息，如标题、描述、主题等。
• .env: 环境变量文件，用于设置敏感信息，如 AWS 密钥。通过复制 env.example 到 .env 并替换其中的 [your key goes here] 来创建此文件。

确保正确配置这些文件，以便项目能够正确运行。