Skip to content

About

WebC component packages for 11ty sites: generic patterns, build-time code samples, & the studio open source layer.

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Norn

Un-opinionated WebC components, layouts, & helpers for Eleventy sites, named for the Norse weavers of fate: small threads a project weaves into its own pages. Each component carries its own CSS & JS, so a page ships only what it uses. A project adds one Eleventy plugin, with a mapping from its own data to the layout props:

import norn from "@allons-y/webc-patterns/plugin";

export default function (config) {
	config.addPlugin(norn, { props: (data) => ({ title: data.title, name: "My project" }) });

	return { markdownTemplateEngine: false };
}
Package Purpose
@allons-y/webc-patterns Generic components, the norn-* page layouts, & the Norn plugin
@allons-y/webc-code-sample Code sample component with build-time syntax highlighting, used by the plugin when installed
@allons-y/webc-oss-site The OSS site theme for Norn: Allons-y Studio brand tokens, fonts, & the OSS banner, call to action, & credit

Try every component & layout in the component preview.

Start with the patterns README: setup, the layout props, hooks, & theming.

Supports evergreen browsers from about 2024. Features newer than that degrade gracefully.

For AI agents

llms.txt says which package to use. Each package ships its own llms.txt: the setup, the data shapes, the rules for calling components & styling them, & a reference of every component's props, slots, & tokens, generated from the sources. Contributors read AGENTS.md.

Status

Beta. The packages publish as 0.1.0-beta.N. The plugin, the six layouts & their props, the hooks, & the tokens are in place & documented in each package's README. The API can still change before 1.0.

Development

The packages support Node 22 or later. CI runs Node 22 & 24, & .nvmrc pins 24 for development & releases.

yarn install
yarn build       # compile packages/*/src into the components/, layouts/, and css/ folders the packages ship
yarn lint
yarn test        # builds first
yarn pack:check  # builds first
yarn docs:start  # serve the component preview (builds first)

fixtures/ holds one Eleventy site per flavor that the tests build, & preview/ is the component preview. The components, layouts, & stylesheets are written in each package's src/ & compiled into components/, layouts/, & css/, which are build output. tokens.json holds the shared design tokens: the build fills each t('path') in a source with the token's default.

See AGENTS.md for component conventions & release flow.

Contributing

Contributions are welcome & appreciated! Please open an issue (before submitting a pull request) if you find a bug, have a feature request, or have a question. Be sure to follow the contribution guidelines and code of conduct but most importantly, be excellent to each other. 💖

License

This project is licensed under the MPL-2.0 License - see the LICENSE file for details. This means you can use this freely, modify as needed; changes to MPL-licensed files should be shared back under the same license.

Funding ☕️

If you find this plugin useful and would like to buy me a coffee/beer as a small thank you, I would greatly appreciate it!

Buy Me A Coffee

About

WebC component packages for 11ty sites: generic patterns, build-time code samples, & the studio open source layer.

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages