Gitment 开源项目教程

Gitment 开源项目教程

gitmentA comment system based on GitHub Issues.项目地址:https://gitcode.com/gh_mirrors/gi/gitment

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

Gitment 是一个基于 GitHub Issues 的评论系统。以下是其主要目录结构及介绍：

gitment/
├── dist/
│   ├── gitment.browser.js
│   ├── gitment.css
│   └── gitment.js
├── example/
│   ├── index.html
│   └── style.css
├── src/
│   ├── css/
│   │   └── main.css
│   ├── js/
│   │   ├── gitment.js
│   │   └── utils.js
│   └── index.js
├── .babelrc
├── .gitignore
├── .npmignore
├── LICENSE
├── package.json
├── README.md
└── webpack.config.js

• dist/：包含编译后的文件，可以直接用于生产环境。
• example/：包含一个示例页面，展示了如何使用 Gitment。
• src/：源代码目录，包含 CSS 和 JavaScript 文件。
• .babelrc：Babel 配置文件。
• .gitignore：Git 忽略文件列表。
• .npmignore：NPM 忽略文件列表。
• LICENSE：项目许可证。
• package.json：NPM 包配置文件。
• README.md：项目说明文档。
• webpack.config.js：Webpack 配置文件。

2. 项目的启动文件介绍

Gitment 的启动文件主要位于 src/ 目录下：

• src/index.js：项目的入口文件，负责初始化和配置 Gitment。
• src/js/gitment.js：Gitment 的核心逻辑文件，包含了评论系统的所有功能。
• src/js/utils.js：工具函数文件，提供了一些辅助函数。

3. 项目的配置文件介绍

Gitment 的配置文件主要包括：

• package.json：包含了项目的依赖、脚本命令等信息。
• webpack.config.js：Webpack 的配置文件，定义了如何打包项目。
• src/index.js：在初始化 Gitment 时，可以传入配置参数，如 GitHub 仓库信息、客户端 ID 和密钥等。

示例配置：

const gitment = new Gitment({
  id: '页面 ID', // 可选。
  owner: '你的 GitHub ID',
  repo: '存储评论的仓库',
  oauth: {
    client_id: '你的客户端 ID',
    client_secret: '你的客户端密钥',
  },
});

gitment.render('comments');

以上配置文件和参数定义了 Gitment 如何与 GitHub Issues 进行交互，并存储评论数据。

gitmentA comment system based on GitHub Issues.项目地址:https://gitcode.com/gh_mirrors/gi/gitment