https://github.com/indexzero/spectree
Textual composibility inspired by fuzzycomputer/spectree with integrations into espanso
https://github.com/indexzero/spectree
Last synced: about 1 month ago
JSON representation
Textual composibility inspired by fuzzycomputer/spectree with integrations into espanso
- Host: GitHub
- URL: https://github.com/indexzero/spectree
- Owner: indexzero
- License: apache-2.0
- Created: 2025-07-31T03:50:45.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-08-04T19:46:12.000Z (11 months ago)
- Last Synced: 2025-08-04T20:58:55.895Z (11 months ago)
- Language: JavaScript
- Size: 107 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SpecTree JavaScript Implementation
A JavaScript implementation of SpecTree - a simple format for composable Markdown trees using `@` references.
## Installation
```sh
# Install globally
npm install -g @spectree/cli
# Or with pnpm
pnpm add -g @spectree/cli
# Or run directly with npx
npx @spectree/cli
```
## Usage
```sh
# Resolve @ references in a Markdown file
spectree input.md
# Output to a file
spectree input.md -o output.md
# Show help
spectree --help
```
## Example
Given these files:
```markdown
# main.md
# My App
@stack.md
@design/colors.md
# stack.md
## Tech Stack
- Node.js
- React
# design/colors.md
## Colors
- Primary: #007bff
```
Running `spectree main.md` outputs:
```markdown
# My App
## Tech Stack
- Node.js
- React
## Colors
- Primary: #007bff
```
# Inspiration
This was heavily inspired by [fuzzycomputer/spectree](https://github.com/fuzzycomputer/spectree) and his [writing about it](https://www.fuzzycomputer.com/posts/spectree).
The original `README.md` and `README.spec.md` are included in `dev/ref` for reference purposes *(with attribution)*.
## Contributing
Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to contribute to this project.
## Code of Conduct
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.