Skip to content

Repository files navigation

T2 Wiki

基于 GitHub Issues 的自动化知识库,使用 Docsify 渲染并部署到 GitHub Pages。

✨ 特性

  • 📝 Issue 即文档 - 创建 Issue 自动生成文档页面
  • 🏷️ 标签分类 - 使用 Issue 标签自动组织文档结构
  • 🔄 实时同步 - Issue 变更自动更新网站内容
  • 🚀 零配置部署 - 自动部署到 GitHub Pages
  • 🔍 全文搜索 - 内置搜索功能

🚀 快速开始

1. 启用 GitHub Pages

  1. 进入仓库 Settings > Pages
  2. Source 下选择 GitHub Actions
  3. 保存设置

2. 创建第一篇文档

  1. 创建一个新 Issue
  2. 填写标题和内容(支持 Markdown)
  3. 添加标签进行分类(可选)
  4. 提交 Issue

等待几秒钟,GitHub Actions 会自动:

  • 将 Issue 转换为 Markdown 文件
  • 更新侧边栏导航
  • 部署到 GitHub Pages

3. 访问你的 Wiki

访问:https://{你的用户名}.github.io/t2wiki/

📖 使用说明

管理文档

  • 创建文档:创建新 Issue
  • 编辑文档:编辑 Issue 内容
  • 分类文档:通过 Issue 标题或 GitHub 标签
  • 删除文档:关闭或删除 Issue

文档标题和标签规则

文档标题

  • 如果 Issue 内容中包含 Markdown 一级标题(# 标题),将使用该标题作为文档标题
  • 否则使用 Issue 的标题作为文档标题

示例

Issue 标题:前端 开发 React教程

Issue 内容:
# React 入门指南
这是一篇关于 React 的教程...

最终文档标题为:React 入门指南

标签(分类)

标签来自两个来源,会自动合并:

  1. Issue 标题中的词语(以空格分隔)
  2. GitHub 手动添加的标签

示例

  • Issue 标题:前端 React 教程
  • GitHub 标签:tutorial, javascript
  • 最终标签:前端, React, 教程, tutorial, javascript

文档会出现在所有对应标签的分类下。

文档组织

  • 文档会按照标签自动分组显示
  • 一个文档可以出现在多个分类下
  • 没有标签的文档会显示在"未分类"部分
  • 侧边栏会自动更新,无需手动维护

标签浏览

系统自动生成标签相关页面:

  • 标签索引页 (docs/tags.md) - 列出所有标签及文章数量
  • 标签详情页 (docs/tags/{标签名}.md) - 列出该标签下的所有文章
  • 支持标签间跳转和文章链接
  • 点击标签可查看相关文章列表

🛠️ 技术栈

  • 文档管理:GitHub Issues
  • 自动化:GitHub Actions
  • 渲染引擎Docsify
  • 部署平台:GitHub Pages

📂 项目结构

.
├── .github/
│   └── workflows/
│       ├── sync-issues.yml    # Issue 同步到文档
│       └── deploy-pages.yml   # 部署到 GitHub Pages
├── docs/
│   ├── index.html            # Docsify 配置
│   ├── README.md             # 首页内容
│   ├── _sidebar.md           # 侧边栏(自动生成)
│   ├── .nojekyll             # GitHub Pages 配置
│   └── issue-*.md            # Issue 文档(自动生成)
├── CLAUDE.md                 # Claude Code 项目说明
├── FEATURES.md               # 功能更新记录
└── README.md                 # 项目说明

🔧 自定义

修改主题

编辑 docs/index.html,更改主题链接:

<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">

可选主题:vue.css, buble.css, dark.css, pure.css

修改配置

docs/index.html 中的 window.$docsify 对象中添加或修改配置项。

详见 Docsify 文档

📝 许可

MIT

About

create from claude

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages