TB | 基于 Github Issues 的博客平台

TB

专为极客设计的上手简单、酷炫，基于 Github API 的博客平台。

环境准备

• 操作系统：支持 macOS，Linux，Windows
• 运行环境：建议选择 LTS 版本 Node.js，最低要求 8.x

语言

English

链接

• 源码
• 示例
• TB-CLI

安装 & 使用

安装

npm install tb-cli -g

使用

强烈推荐使用 TB-CLI（具体使用说明均在 TB-CLI）。

快速开始

请确保你已安装 TB-CLI。 需了解更多详情请点击 这里。

tb init [project-name]

生成 TB 之后，打开浏览器地址栏输入 http://127.0.0.1:2333 即可。

开发

git clone git@github.com:TB-blog/TB.git
cd TB
npm install // 如果使用 yarn: yarn

注意: 你需要添加配置文件。 如果你不是一位开发者，请使用 TB-CLI 来生成 TB。

如果是开发者，你需要在项目根目录下创建一个名为 config.json 的配置文件.

{
  "token": "***", // 个人 Github access token
  "nickname": "nickname", // 昵称
  "user": "TB", // 你的 Github 用户名
  "repo": "TB", // 你 repo 名称
  "gitalk": {
    "useGitalk": true, // 使用评论模块, 更多详情请看 https://github.com/gitalk/gitalk
    "clientID": "***",
    "clientSecret": "***",
    "repo": "TB-comments",
    "owner": "TB",
    "admin": ["TB"]
  }
}

运行 npm run dev 然后打开浏览器地址栏输入 http://127.0.0.1:2333。

主题

你可以使用 tb theme 来查看最新官方主题（即将到来）。

贡献

如有任何的意见或建议，欢迎通过创建 Issue 或 Pull Request 的方式告知仓库管理员，请先阅读贡献指南。

证书

MIT。