Skip to content

alisonaquinas/commonloom

Repository files navigation

Commonloom

Commonloom logo for light mode Commonloom logo for dark mode

Commonloom quality and test battery npm package Node.js 24 TypeScript MIT License

Commonloom is the standalone TypeScript home for a reusable Markdown content pipeline.

It turns Markdown, frontmatter, links, media, source traces, and diagnostics into normalized records that adapters can map into framework-specific renderer outputs.

Why It Exists

Commonloom keeps reusable content compilation separate from website-specific delivery concerns.

Commonloom owns Adapters own
Markdown and frontmatter parsing Routes and page groups
Safe static HTML rendering Framework-specific rendering
Link, image, and media analysis Generated module formatting
Diagnostics and source traces Product copy and public navigation
Manifest-driven compiled records Deployment and release surfaces

Current Battery

The repository has an explicit quality and test battery:

  • npm run lint
  • npm run verify
  • npm run typecheck
  • npm run build
  • npm run examples:check
  • npm run test:unit
  • npm run test:integration
  • npm run test:e2e

The aggregate local gate is:

npm run check

CI runs the same categories as named GitHub Actions steps on Node.js 24.

Integration Examples

The examples/ workspace demonstrates Commonloom with shared content, shared SCSS, and shared logo assets across:

These examples show adapter patterns. They are not framework dependencies of the Commonloom core package.

Documentation Surface

The docs/ vault is maintained as an Obsidian-flavored LLM wiki:

Start Here

npm ci
npm run hooks:install
npm run check

Then read:

  1. README.md
  2. docs/index.md
  3. docs/tests/requirements-matrix.md
  4. docs/roadmap.md

Note

Commonloom 0.1.0 is the first standalone release. The public API is tested and visible, but the package remains on the 0.x line until a future 1.0.0 stability commitment.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors