Skip to content

Repository files navigation

pagesmark


License & acquisition

This project is proprietary. Production use, redistribution, and commercial deployment require a written commercial license or completed acquisition. See LICENSE and ACQUISITION.md. Contact @theworker02.

pagesmark mark

Generate and validate a compact GitHub Pages starter site with a reusable, documented API.

JSR version 1.2.0 license proprietary-0B1F33) node >=18

Package: @theworker02/pagesmark · Docs: GitHub Pages · Source: theworker02/pagesmark

Highlights

  • Generates docs/index.html, docs/styles.css, and docs/logo.svg.
  • Supports custom titles and accent colors.
  • Can build the full site bundle in memory with createBundle().
  • Exposes required file metadata and color validation.
  • Fully documented JSR symbols and TypeScript declarations.
  • Trusted publishing from GitHub Actions with provenance.

Add from JSR

deno add jsr:@theworker02/pagesmark
import { createBundle, REQUIRED_FILES, PACKAGE } from "@theworker02/pagesmark";

const bundle = createBundle("My Project", { color: "#C9A227" });
console.log(REQUIRED_FILES, PACKAGE.version, bundle["index.html"]);

Public API

Site generation

  • createBundle(name, options) â€â€Â� build the complete three-file site in memory.
  • init(dir, options) â€â€Â� write the generated site to docs/.
  • check(dir) â€â€Â� validate that the required starter files exist.
  • htmlFor(name), stylesFor(color), logoFor(color) â€â€Â� generate individual assets.

Metadata and validation

  • PACKAGE â€â€Â� package identity and version metadata.
  • REQUIRED_FILES â€â€Â� canonical PagesMark file list.
  • isValidColor(value) â€â€Â� validate #RRGGBB accent colors.
  • NAVY, GOLD, LOGO, STYLES â€â€Â� default design primitives.
  • requiredFiles(path) â€â€Â� resolve required file paths.

Types

InitOptions, InitResult, CheckResult, PageBundle, and PackageMetadata are all documented in JSR.

CLI from source

git clone https://github.com/theworker02/pagesmark.git
cd pagesmark
node src/cli.js --help

Initialize a site:

node src/cli.js init ./website --title "My Project" --color "#C9A227"

Development

node --test

Publishing

The canonical package is published to JSR through GitHub Actions using OIDC trusted publishing.

Documentation

Contributing

See CONTRIBUTING.md.

Security

See SECURITY.md.

License

Source-available proprietary � evaluation under LICENSE; commercial / production use via COMMERCIAL.md. See LICENSE_TRANSITION_NOTICE.md and NOTICE.

Status

pagesmark is actively packaged for commercial licensing and acquisition diligence. See ACQUISITION.md and docs/acquisition/.

About

Initialize or check a GitHub Pages /docs starter site. npm: https://www.npmjs.com/package/%40magnexis/pagesmark

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages