Metalsmith 开源项目教程

Metalsmith 开源项目教程

metalsmith项目地址:https://gitcode.com/gh_mirrors/met/metalsmith

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

Metalsmith 是一个灵活的静态站点生成器，其目录结构通常如下：

metalsmith-project/
├── src/
│   ├── index.md
│   └── layouts/
│       └── default.hbs
├── metalsmith.json
├── package.json
└── README.md

• src/：包含所有的源文件，如 Markdown 文件和模板文件。
  • index.md：主页的 Markdown 文件。
  • layouts/：存放模板文件，如 Handlebars 模板。
• metalsmith.json：项目的配置文件。
• package.json：Node.js 项目的依赖和脚本配置。
• README.md：项目的说明文档。

2. 项目的启动文件介绍

Metalsmith 项目的启动通常通过 metalsmith.json 配置文件或 JavaScript 脚本来完成。以下是一个简单的 metalsmith.json 配置示例：

{
  "source": "src",
  "destination": "build",
  "plugins": {
    "metalsmith-markdown": {},
    "metalsmith-layouts": {
      "engine": "handlebars",
      "directory": "src/layouts"
    }
  }
}

• source：指定源文件目录。
• destination：指定生成站点的目标目录。
• plugins：配置使用的插件及其选项。

3. 项目的配置文件介绍

metalsmith.json 是 Metalsmith 项目的主要配置文件，用于定义源目录、目标目录和插件配置。以下是一个详细的配置示例：

{
  "source": "src",
  "destination": "build",
  "clean": true,
  "metadata": {
    "siteName": "My Awesome Site"
  },
  "plugins": {
    "metalsmith-markdown": {},
    "metalsmith-permalinks": {
      "pattern": ":title"
    },
    "metalsmith-layouts": {
      "engine": "handlebars",
      "directory": "src/layouts"
    },
    "metalsmith-assets": {
      "source": "./public",
      "destination": "./"
    }
  }
}

• source：源文件目录。
• destination：生成站点的目标目录。
• clean：是否在构建前清理目标目录。
• metadata：全局元数据，可在模板中使用。
• plugins：插件配置，如 Markdown 转换、永久链接生成和模板渲染等。

通过这些配置，Metalsmith 可以根据源文件生成静态站点，并应用各种插件进行处理和优化。

metalsmith项目地址:https://gitcode.com/gh_mirrors/met/metalsmith