Prose for Programmers 项目教程

Prose for Programmers 项目教程

prose-for-programmersA book to help software developers write better prose项目地址:https://gitcode.com/gh_mirrors/pr/prose-for-programmers

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

prose-for-programmers/
├── _data/
│   └── ...
├── _includes/
│   └── ...
├── admin/
│   └── ...
├── content/
│   └── ...
├── filters/
│   └── ...
├── manuscript/
│   └── ...
├── styles/
│   └── ...
├── uploads/
│   └── ...
├── .eleventy.js
├── .eleventyignore
├── .gitattributes
├── .gitignore
├── .nvmrc
├── 404.md
├── LICENSE
├── LICENSE.txt
├── README.md
├── loader.js
├── netlify.toml
├── outline.md
├── package.json
├── password_template.html
├── postcss.config.js
├── robots.md
└── search-index.json

目录结构介绍

• _data/: 存放项目的数据文件。
• _includes/: 存放项目的包含文件，通常用于模板。
• admin/: 存放项目的管理相关文件。
• content/: 存放项目的内容文件。
• filters/: 存放项目的过滤器文件。
• manuscript/: 存放项目的手稿文件。
• styles/: 存放项目的样式文件。
• uploads/: 存放项目的上传文件。
• .eleventy.js: Eleventy 配置文件。
• .eleventyignore: Eleventy 忽略文件。
• .gitattributes: Git 属性文件。
• .gitignore: Git 忽略文件。
• .nvmrc: Node Version Manager 配置文件。
• 404.md: 404 页面文件。
• LICENSE: 项目许可证文件。
• LICENSE.txt: 项目许可证文本文件。
• README.md: 项目说明文件。
• loader.js: 加载器文件。
• netlify.toml: Netlify 配置文件。
• outline.md: 项目大纲文件。
• package.json: 项目依赖和脚本配置文件。
• password_template.html: 密码模板文件。
• postcss.config.js: PostCSS 配置文件。
• robots.md: robots.txt 文件。
• search-index.json: 搜索索引文件。

2. 项目的启动文件介绍

项目的启动文件是 package.json 中的 scripts 部分。通常，启动项目的命令如下：

{
  "scripts": {
    "start": "eleventy --serve"
  }
}

运行 npm start 或 yarn start 即可启动项目。

3. 项目的配置文件介绍

.eleventy.js

这是 Eleventy 的配置文件，用于配置项目的构建和生成过程。示例如下：

module.exports = function(eleventyConfig) {
  // 添加自定义配置
  eleventyConfig.addPassthroughCopy("styles");
  eleventyConfig.addPassthroughCopy("uploads");

  return {
    dir: {
      input: "content",
      output: "dist"
    }
  };
};

netlify.toml

这是 Netlify 的配置文件，用于配置项目的部署和构建过程。示例如下：

[build]
  command = "npm run build"
  publish = "dist"

postcss.config.js

这是 PostCSS 的配置文件，用于配置 CSS 处理过程。示例如下：

module.exports = {
  plugins: {
    autoprefixer: {}
  }
};

以上是 Prose for Programmers 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。

prose-for-programmersA book to help software developers write better prose项目地址:https://gitcode.com/gh_mirrors/pr/prose-for-programmers