Skip to content

fifthbell/brokaw

Repository files navigation

@fifthbell/brokaw

Server-side renderer and Handlebars template bundle for fifthbell pages.

What it does

  • Renders canonical content documents into HTML
  • Supports article-page, homepage, category-page, live-story, and 404 layouts
  • Ships reusable Handlebars templates, partial dependency metadata, and compiled CSS

Installation

npm install @fifthbell/brokaw

Basic usage

import { render } from '@fifthbell/brokaw';

const html = render(doc);

doc must match the canonical schema used by the renderer (see src/types/canonical-article.ts).

Exports

  • @fifthbell/brokaw -> renderer entrypoint
  • @fifthbell/brokaw/partial-deps.json -> partial-to-layout dependency map

Development

npm install
npm run typecheck
npm run test:unit
npm run build
npm run storybook

Publish flow

  • CI validates typecheck, unit tests, and package build on pull requests and main pushes.
  • Package publish is triggered by pushing a v* tag.

About

UI Components for fifthbell

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors