Note
This was an early v1 prototype of SpecTree.
A newer version with more features and cross-language support is here.
A simple format for composable Markdown trees using @ references.
SpecTree is Markdown with one addition: the @ operator for referencing other Markdown files via transclusion. This enables you to build trees of instructions from modular, reusable components.
As my LLM prompts and specs have gotten more complex, I wanted a simple way to make plain English instructions more composable and reusable.
Given this file structure:
specs/
βββ app.md
βββ stack.md
βββ design/
βββ system.md
βββ colors.md
Where app.md contains:
# My App
@stack.md
@design/system.md
@design/colors.mdSpecTree resolves these references into a single, complete Markdown document.
- The
@operator must be the first character on a line - Followed by a relative path to a Markdown file
- Paths are resolved relative to the current file
- Circular references are not allowed
- Python - Install with
pip install spectree-md - JavaScript - Install with
npm install spectree(coming soon)
MIT