Skip to content

AGENTS.md

Latest commit

 

History

History
23 lines (16 loc) · 1.02 KB

AGENTS.md

File metadata and controls

23 lines (16 loc) · 1.02 KB

eleventy-plugin-mdlite

Eleventy plugin that copies raw markdown to output and generates a SQLite full-text search index.

The goal of this project is to make it easier for LLM agents to consume websites generated by 11ty.

Key Files

  • index.js — Plugin entry point; all core logic lives here
  • spec.md — Design specification
  • CHANGELOG.md — Release history
  • .github/workflows/test.yml — CI workflow
  • test/plugin.test.js — Test suite (node:test, snapshot-based)
  • test/fixtures/ — Eleventy configs and source files used by tests
  • test/snapshots/ — Expected output snapshots

AI Coding Workflow

  1. ensure that all changes are reflected by spec.md, update that first if needed, but make sure to confirm changes with the developer.
  2. practice red-green TDD; write tests first, confirm that they demonstrate the desired feature or change, then iterate on code until tests pass
  3. test, lint, and format code before finishing

Golden rule: always leave the project in a better state than when you started.