Skip to content

Repository files navigation

Stem

CI Status License: MIT

Stem is a Git-native, file-based documentation system for software developers. It keeps reusable knowledge in Markdown blocks and lets teams compose those blocks into multiple view files without duplicating content.

Stem is designed for teams working with AI coding agents and LLM workflows: the block store and dynamic connection graph provide structured, queryable context while keeping every source file plain Markdown in Git.

The Problem

Software documentation gets stale, duplicated, bloated, and locked into a single perspective. Stem separates canonical content from the views people read, so one block can power onboarding, backend, frontend, architecture, and AI-agent context views.

Ecosystem

Stem is composed of two main packages:

  1. @stemdev/cli: The core command-line interface for creating, managing, and rendering Stem projects.
  2. vscode-stem: The official VS Code extension providing live, side-by-side previews of your composed Markdown views.

(We recommend installing both! See their respective READMEs for installation and usage instructions.)

Architecture

The CLI is intentionally thin. All business logic belongs in src/core/, and the public core API is exported from src/index.ts so future MCP servers, editor tools, and UI clients can import Stem without depending on CLI code.

Rendered Markdown is generated under rendered/ by default and should not be committed unless a project intentionally publishes generated output.

To view the full Layer Model, strict dependency rules, and single-responsibility guidelines for the core modules, please read ARCHITECTURE.md.

Contributing

We welcome contributions! To build the project locally:

pnpm install
pnpm build

Please feel free to open issues or submit pull requests on our GitHub Repository. You can find details about the release process in CONTRIBUTING.md.

License

MIT

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages