Knowledge Bundle: markdown-converter
Index of the knowledge bundle for markdown-converter.
Open source Repository Open in the app JSON README (API)
About
# Knowledge Bundle: markdown-converter
This bundle documents the **markdown-converter** — a Rust CLI tool that converts a collection of markdown adventure files into structured JSON for game engines.
## Concepts
| Concept | Description |
|---------|-------------|
| [Project Overview](project_overview.md) | High-level architecture and design decisions |
| [Parser Specification](parser.md) | Input format details: title, story, choices, metadata blocks |
| [API Reference](api.md) | HTTP API endpoints and client interaction |
| [CLI Usage](cli.md) | Command-line arguments and startup |
| [JSON Schema](json_schema.md) | Output types (Story, Page, Choice) |
| [Example](example.md) | Concrete input/output walkthrough |
| [Development Policy](development_policy.md) | Branching strategy — no direct commits to `main` |
Details
- Kind
- OKF bundles
- Topic
- Files & documents
- Publisher
- feralfantasies
- Origin
- okf_github
- Category
- dados
- Version
- 0.2
- Open pull requests
- 1
- Last push
- 2026-08-05T14:51:34Z
- Repository state
- ativo
- Language
- Rust
- Added
- 2026-09-08 16:07:08
- Updated
- 2026-09-08 16:07:08
- Origin id
Feralfantasies/markdown-conversion:knowledge/index.md
README
# markdown-converter
Convert a collection of markdown files into structured JSON for a text based adventure game engine.
## Quick Start
```bash
cargo run -- /path/to/story
```
## Knowledge Base
All documentation follows the [Open Knowledge Format (OKF) v0.2](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md).
| Document | Description |
|----------|-------------|
| [Project Overview](knowledge/project_overview.md) | Architecture, design decisions, processing pipeline |
| [Parser Specification](knowledge/parser.md) | Input format: titles, story text, choices, metadata blocks |
| [CLI Usage](knowledge/cli.md) | Command-line arguments, flags, examples |
| [JSON Schema](knowledge/json_schema.md) | Output types — `Story`, `Page`, `Choice` definitions |
| [Example](knowledge/example.md) | Concrete input/output walkthrough |
## How It Works
1. **Scan** — Recursively walks a story directory for `.md` files
2. **Parse** — Extracts `# Title`, story body, and `- [label](link) {metadata}` selections
3. **Emit** — Produces pretty-printed JSON with categorical page grouping