BK
TagsSubmit

Tool Template

Content

Tool Template

Use this page as the copyable starter for a custom tool entry.

Directory Layout

content/
├── tags.json
├── list.json
└── my-tool/
    ├── meta.json
    ├── en.index.md
    ├── zh.index.md
    ├── en.installation.md
    ├── zh.installation.md
    ├── en.configuration.md
    ├── zh.configuration.md
    ├── en.data.md
    ├── zh.data.md
    ├── en.faq.md
    └── zh.faq.md

meta.json

{
  "title": { "en": "My Tool", "zh": "我的工具" },
  "description": {
    "en": "One-line summary for cards and page headers.",
    "zh": "用于卡片和页面头部的一句话说明。"
  },
  "github": "https://github.com/example/my-tool",
  "link": ["agent-browser"]
}

content/tags.json

[
  { "key": "devTools", "en": "Dev Tools", "zh": "开发工具" },
  { "key": "open-source", "en": "Open Source", "zh": "开源" }
]

content/list.json Entry

{
  "slug": "my-tool",
  "path": "my-group/my-tool",
  "tags": ["devTools", "open-source", "free", "cli", "web"]
}

Use path only when the content directory should differ from the URL slug. For example, slug: "zzci-chrome" can point to path: "zzci/chrome". Keep tag label definitions in content/tags.json, and reference their keys from content/list.json.

Common Tags

  • images
  • devTools
  • containers
  • open-source
  • free
  • desktop
  • cli
  • web
  • privacy
  • docker
  • self-hosted
  • automation
  • proxy

Starter Pages

en.index.md

---
title:
  en: Introduction
  zh: 简介
order: 0
---

## Overview

Describe what the tool does, who it is for, and why it matters.

## Related Workflows

Mention adjacent tools with placeholders like [[agent-browser]] or [[zzci-chrome|zzci/chrome]].

en.installation.md

---
title:
  en: Installation
  zh: 安装
order: 1
---

## Installation

Add the shortest working setup path.

en.configuration.md

---
title:
  en: Configuration
  zh: 配置
order: 2
---

## Configuration

List the switches, ports, files, or environment variables people need.

en.data.md

---
title:
  en: Data & Storage
  zh: 数据说明
order: 3
---

## Data & Storage

Explain what state is persisted, what is ephemeral, and what should be backed up.

en.faq.md

---
title:
  en: FAQ
  zh: 常见问题
order: 4
---

## FAQ

Add the real questions people will ask after trying the tool.

Duplicate the same files with zh.*.md and translate the body text.

Placeholder Links

Use placeholders instead of hardcoding locale-specific paths:

[[agent-browser]]
[[zzci-chrome|zzci/chrome]]
[[bkd/data|Data & Storage]]

The renderer converts them into the current locale automatically.