Skip to content

Latest commit

 

History

History
60 lines (45 loc) · 1.76 KB

README.md

File metadata and controls

60 lines (45 loc) · 1.76 KB
Raw

Bitcoin Topics Index

An extensive index of Bitcoin-related topics, combining and enhancing the established Bitcoin Optech Topics with additional relevant entries.

See TOPICS.md for the categorized index or topics.json for the machine-readable format.

Repository Structure

.
├── topics/             # Bitcoin topics
│   ├── topic1.yaml
│   ├── topic2.yaml
│   └── ...
├── scripts/           # Build and maintenance scripts
│   └── build_index.py
├── topics.json       # Machine-readable index
├── TOPICS.md         # Generated documentation
└── README.md

Topics Format

Each topic is defined in YAML format with the following structure:

title: "Topic Title" # Display name of the topic
slug: "topic-slug" # URL-friendly identifier
categories: # List of categories this topic belongs to
  - "Category 1"
  - "Category 2"
aliases: # Optional: Alternative names for the topic
  - "Alternative Name"
  - "Another Name"
excerpt: "A comprehensive description of the topic."

Usage

Building the Index

To build the combined index and documentation:

python scripts/build_index.py

This will:

  1. Fetch the latest topics from Bitcoin Optech's /topics.json.
  2. Combine them with additional topics from the topics/ directory
  3. Automatically generate miscellaneous topics for each category to support uncategorized content
  4. Generate topics.json with the complete topics data
  5. Create TOPICS.md with categorized listings

Adding Topics

  1. Create a new YAML file in the topics/ directory
  2. Follow the topics format described above
  3. Run the build script to update the index