BK
Submit

Submit Ideas

Quick Submit

Don't want to deal with Git? Just open an Issue with the tool URL — AI will automatically collect the info and create a PR for you.

Submit via Issue →

How It Works

This site hosts tools, articles, guides, resources, and more — all managed under the content/ directory. Just add files and open a PR — no code changes required.

  • Repository: bkhq/website
  • Content directory: content/<your-slug>/
  • Submit method: GitHub Pull Request

Manual Submit

# 1. Fork the repo on GitHub
#    Go to https://github.com/bkhq/website → click "Fork"

# 2. Clone your fork
git clone https://github.com/<your-username>/website.git
cd website

# 3. Create your content directory
mkdir -p content/my-project

# 4. Add meta.json (see format below)
# 5. Register in content/list.json

# 6. Commit and push
git add .
git commit -m "feat: add my-project"
git push origin main

# 7. Open a Pull Request on GitHub

File Structure

content/
├── list.json                  # Registry — list of all entries
└── my-project/
    ├── meta.json              # Required — metadata
    ├── logo.svg               # Optional — custom icon
    ├── index.md               # Optional — introduction
    ├── usage.md               # Optional — usage guide
    └── configuration.md       # Optional — configuration

meta.json

The only required file. At minimum:

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

Full example with all optional fields

{
  "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"
    }
  ]
}

Field Reference

Field Required Description
title Yes Name in en and zh
description Yes Short description in en and zh
version No Version string
website No Official website URL
github No GitHub repository URL
addedAt No Date added (YYYY-MM-DD)
addedBy No Contributor name and optional profile url
links No Extra links with i18n label and url

list.json (Entry Registry)

Register your entry by adding to the list array in content/list.json:

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

Field Reference

Field Required Description
slug Yes Must match your directory name under content/
category Yes One of: images textCode colors converters security network data
order No Display position (higher = further down). Omit to append at the end
logo No A logo.svg in your directory, or a Lucide icon name. Omit to use the first letter of the title

Adding Pages

Optionally add .md files alongside meta.json. Each file becomes a page with its own URL.

Use frontmatter to set the title and sort order:

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

Your content here...

When there are multiple .md files, a sidebar navigation is generated automatically. order controls the position (lower = higher).

Ready?

Open a Pull Request