pagez

Docs

The writing that spans the code, in reading order.

  1. Usage: install it, build a folder, and what an agent should know.
  2. Pages: the rules a page and a site follow, each held to its tests.
  3. Elements: the rules for an element, one @name.html file of markup, CSS and behavior.
  4. Design: what Pagez is, why, and what it isn't.
  5. Plan: what's next, in order, and what works now.
  6. Lessons: what building it taught, for the next change.
  7. Development: build, test and release it.

Docs

  • design.md

    Pagez is a page compiler. A folder of Markz pages goes in, and their HTML comes out, built to dist/ through Vite. This page is what it is, why, and what it isn't. Pages and elements state the rules, and the plan says what's built.

  • development.md

    How pagez is built and changed. What every repository shares, like the scripts, CI and releases, is in craftz's rules, and isn't repeated here.

  • elements.md

    An element is one @name.html file that holds its markup, written at build time, its CSS and its behavior. This page is what goes in the file, rule by rule, in the form pages uses. How a page uses an element is in pages.

  • lessons.md

    What building pagez taught, for whoever changes it next. Each lesson says what happened and what to do about it. What each piece of work shipped is in git and the release notes, and what works now is in the plan.

  • pages.md

    How to write a page and a site for Pagez, rule by rule. Each rule has an id, and ends with the test cases that hold it, in tests/pages/ and tests/sites/. Elements has the rules for an element's file, and the design says why they're these.

  • plan.md

    Pagez 0.2.0 is on npm, and main builds one page or a site of folders to dist/ through Vite. What each release changed is in its notes on GitHub. This plan says what's next, in order, and what works now. Pages and elements state the rules, the design says why, and the lessons are what building it taught.

  • usage.md

    How to install Pagez, build a folder with it, and what an agent writing pages should know. Pages has the rules a page and a site follow, and elements has an element's.