BK
投稿

投稿创意

快速提交

不想折腾 Git？直接提交一个 Issue，附上工具网址，AI 会自动收集信息并创建 PR。

通过 Issue 提交 →

如何投稿

本站收录工具、文章、教程、资源等各类内容，全部在 content/ 目录下管理。只需添加文件并发起 PR，无需修改任何代码。

  • 仓库地址：bkhq/website
  • 内容目录：content/<your-slug>/
  • 提交方式：GitHub Pull Request

手动提交

# 1. 在 GitHub 上 Fork 仓库
#    打开 https://github.com/bkhq/website → 点击 "Fork"

# 2. 克隆你的 Fork
git clone https://github.com/<your-username>/website.git
cd website

# 3. 创建内容目录
mkdir -p content/my-project

# 4. 添加 meta.json（格式见下方）
# 5. 在 content/list.json 中注册

# 6. 提交并推送
git add .
git commit -m "feat: add my-project"
git push origin main

# 7. 在 GitHub 上发起 Pull Request

文件结构

content/
├── list.json                  # 注册表 — 所有条目的索引
└── my-project/
    ├── meta.json              # 必需 — 元信息
    ├── logo.svg               # 可选 — 自定义图标
    ├── index.md               # 可选 — 介绍
    ├── usage.md               # 可选 — 使用指南
    └── configuration.md       # 可选 — 配置说明

meta.json

唯一必需的文件。最简配置：

{
  "title": { "en": "My Project", "zh": "我的项目" },
  "description": {
    "en": "A short description of what this is about.",
    "zh": "简要描述这是什么。"
  }
}

包含所有可选字段的完整示例

{
  "title": { "en": "My Project", "zh": "我的项目" },
  "description": {
    "en": "A short description of what this is about.",
    "zh": "简要描述这是什么。"
  },
  "version": "1.0.0",
  "website": "https://example.com",
  "github": "https://github.com/user/repo",
  "addedAt": "2026-03-07",
  "addedBy": { "name": "Your Name", "url": "https://github.com/yourname" },
  "links": [
    {
      "label": { "en": "Documentation", "zh": "文档" },
      "url": "https://example.com/docs"
    }
  ]
}

字段说明

字段 必填 说明
title 是 名称，需包含 en 和 zh
description 是 简要描述，需包含 en 和 zh
version 否 版本号
website 否 官方网站链接
github 否 GitHub 仓库链接
addedAt 否 添加日期（YYYY-MM-DD）
addedBy 否 贡献者 name 及可选的 url
links 否 附加链接，含双语 label 和 url

list.json（内容注册表）

在 content/list.json 的 list 数组中添加一条注册信息：

{
  "slug": "my-project",
  "category": "textCode"
}

字段说明

字段 必填 说明
slug 是 需与 content/ 下的目录名一致
category 是 可选值：images textCode colors converters security network data
order 否 显示顺序（数值越大越靠后），不填则自动排到末尾
logo 否 目录中的 logo.svg，或 Lucide 图标名。不填则使用标题首字母

添加页面

可以在 meta.json 旁放置 .md 文件，每个文件会生成独立页面。

使用 frontmatter 设置标题和排序：

---
title:
  en: Usage Guide
  zh: 使用指南
order: 1
---

你的内容...

当有多个 .md 文件时，侧边栏导航会自动生成。order 控制排列顺序（数值越小越靠前）。

准备好了？

发起 Pull Request