@amitkaps/pagez
v0.3.0
Published
pagez — Markdown, as pages.
Readme
pagez
pagez — Markdown, as pages.
A folder holds pages written in Markz, each .md at its folder's path, and what they use: a style.css, a frame.html, images and fonts. Pagez compiles each page, writes its head from its frontmatter, checks that every file and page it links is there, and Vite bundles them with hashed names. One page is the smallest site.
site/
├── index.md the page at /
├── about.md the page at about/
├── style.css their design, in place of Pagez's theme
├── frame.html the document around them, optional
├── img/
└── fonts/A folder below uses the nearest style.css and frame.html above it, or its own.
pagez build site # writes site/dist/
pagez dev site # serves it while it's written
pagez preview site # serves what was built
pagez preview site --port 4173 # on that port, or fails if it's taken
pagez check site # lists what to fix in every page, and writes nothing
pagez rules folder-page # prints a rule, an error or a warning
pagez help build # prints what a command doesUsage states each command once: build, dev, preview, check, rules and help.
A folder with its own Vite config adds the plugin instead:
import pagez from "@amitkaps/pagez/vite";
export default { plugins: [pagez()] };Usage says how to build with it, and pages has the rules a page and a site follow. 0.1 builds one page without elements or ${…}. Elements, ${…} and many pages are built since, and what's left comes next, in the plan.
Install
pnpm add -D @amitkaps/pagez vite-plusIt needs Node 26 or newer, the Node it's built and tested on.
Read the docs for its design, plan and lessons. It follows craftz's rules for how it builds, checks and releases.
