Git 北京项目教程

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

gitbeijing/
├── data/
├── src/
├── static/
├── .gitignore
├── CNAME
├── LICENSE
├── README.md
├── gatsby-config.js
├── gatsby-node.js
├── package.json
└── yarn.lock

• data/: 存放项目的数据文件。
• src/: 存放项目的源代码文件。
• static/: 存放静态资源文件。
• .gitignore: 指定Git版本控制系统忽略的文件和目录。
• CNAME: 用于自定义域名的配置文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• gatsby-config.js: Gatsby项目的配置文件。
• gatsby-node.js: Gatsby项目的Node.js配置文件。
• package.json: 项目的依赖管理文件。
• yarn.lock: 锁定项目依赖版本的文件。

2. 项目的启动文件介绍

项目的启动文件主要是 package.json 中的 scripts 部分。以下是一些常用的启动命令：

{
  "scripts": {
    "develop": "gatsby develop",
    "build": "gatsby build",
    "serve": "gatsby serve",
    "clean": "gatsby clean"
  }
}

• develop: 启动开发服务器，用于本地开发。
• build: 构建项目，生成静态文件。
• serve: 启动本地服务器，用于预览构建后的项目。
• clean: 清除缓存和生成的文件。

3. 项目的配置文件介绍

gatsby-config.js

gatsby-config.js 是 Gatsby 项目的主要配置文件，用于配置站点元数据、插件、路径等。以下是一个简单的配置示例：

module.exports = {
  siteMetadata: {
    title: `Git 北京`,
    description: `带初学者学会 git 版本控制工具和 github.com 社交化编程平台的书。`,
    author: `happypeter`,
  },
  plugins: [
    `gatsby-plugin-react-helmet`,
    {
      resolve: `gatsby-source-filesystem`,
      options: {
        name: `images`,
        path: `${__dirname}/src/images`,
      },
    },
    `gatsby-transformer-sharp`,
    `gatsby-plugin-sharp`,
    {
      resolve: `gatsby-plugin-manifest`,
      options: {
        name: `git-beijing`,
        short_name: `gitbj`,
        start_url: `/`,
        background_color: `#663399`,
        theme_color: `#663399`,
        display: `minimal-ui`,
        icon: `src/images/gatsby-icon.png`, // This path is relative to the root of the site.
      },
    },
  ],
}

gatsby-node.js

gatsby-node.js 用于在构建过程中执行自定义的 Node.js 代码。以下是一个简单的示例：

exports.createPages = async ({ actions, graphql, reporter }) => {
  const { createPage } = actions
  const blogPostTemplate = require.resolve(`./src/templates/blog-post.js`)
  const result = await graphql(`
    {
      allMarkdownRemark(
        sort: { order: DESC, fields: [frontmatter___date] }
        limit: 1000
      ) {
        edges {
          node {
            frontmatter {
              path
            }
          }
        }
      }
    }
  `)
  if (result.errors) {
    reporter.panicOnBuild(`Error while running GraphQL query.`)
    return
  }
  result.data.allMarkdownRemark.edges.forEach(({ node }) => {
    createPage({
      path: node.frontmatter.path,
      component: blogPostTemplate,
      context: {}, // additional data can be passed via context
    })
  })
}

以上是 gitbeijing 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。