@opnpress/opnpress-cli 0.1.0

package/dist/server.js

@@ -0,0 +1,97 @@
+import { createServer } from 'node:http';
+import path from 'node:path';
+import { promises as fs } from 'node:fs';
+function contentTypeFor(filePath) {
+    const ext = path.extname(filePath).toLowerCase();
+    switch (ext) {
+        case '.html':
+            return 'text/html; charset=utf-8';
+        case '.css':
+            return 'text/css; charset=utf-8';
+        case '.js':
+            return 'text/javascript; charset=utf-8';
+        case '.json':
+            return 'application/json; charset=utf-8';
+        case '.xml':
+            return 'application/xml; charset=utf-8';
+        case '.txt':
+            return 'text/plain; charset=utf-8';
+        case '.md':
+            return 'text/markdown; charset=utf-8';
+        case '.svg':
+            return 'image/svg+xml';
+        case '.png':
+            return 'image/png';
+        case '.jpg':
+        case '.jpeg':
+            return 'image/jpeg';
+        case '.webp':
+            return 'image/webp';
+        case '.ico':
+            return 'image/x-icon';
+        default:
+            return 'application/octet-stream';
+    }
+}
+async function resolveFile(distDir, requestUrl) {
+    const urlPath = decodeURIComponent(new URL(requestUrl, 'http://localhost').pathname);
+    const cleanPath = urlPath === '/' ? '/index.html' : urlPath;
+    const directPath = path.join(distDir, cleanPath.replace(/^\//, ''));
+    try {
+        const stat = await fs.stat(directPath);
+        if (stat.isFile()) {
+            return directPath;
+        }
+    }
+    catch {
+        // fall through
+    }
+    if (!path.extname(cleanPath)) {
+        const nestedIndex = path.join(distDir, cleanPath.replace(/^\//, ''), 'index.html');
+        try {
+            const stat = await fs.stat(nestedIndex);
+            if (stat.isFile()) {
+                return nestedIndex;
+            }
+        }
+        catch {
+            // fall through
+        }
+    }
+    return null;
+}
+export async function startPreviewServer(distDir) {
+    const server = createServer(async (req, res) => {
+        const requestUrl = req.url ?? '/';
+        const filePath = await resolveFile(distDir, requestUrl);
+        if (!filePath) {
+            res.statusCode = 404;
+            res.setHeader('Content-Type', 'text/plain; charset=utf-8');
+            res.end('Not found');
+            return;
+        }
+        const body = await fs.readFile(filePath);
+        res.statusCode = 200;
+        res.setHeader('Content-Type', contentTypeFor(filePath));
+        res.end(body);
+    });
+    await new Promise((resolve) => {
+        server.listen(0, '127.0.0.1', () => resolve());
+    });
+    const address = server.address();
+    const url = `http://127.0.0.1:${address.port}/`;
+    return {
+        url,
+        close: async () => {
+            await new Promise((resolve, reject) => {
+                server.close((error) => {
+                    if (error) {
+                        reject(error);
+                        return;
+                    }
+                    resolve();
+                });
+            });
+        }
+    };
+}

package/dist/utils.js

@@ -0,0 +1,45 @@
+import { promises as fs } from 'node:fs';
+import path from 'node:path';
+export function toPosix(input) {
+    return input.split(path.sep).join('/');
+}
+export function slugify(input) {
+    return input
+        .trim()
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, '-')
+        .replace(/^-+|-+$/g, '');
+}
+export function escapeHtml(input) {
+    return String(input)
+        .replace(/&/g, '&')
+        .replace(/</g, '&lt;')
+        .replace(/>/g, '&gt;')
+        .replace(/"/g, '&quot;')
+        .replace(/'/g, '&#39;');
+}
+export async function ensureDir(dir) {
+    await fs.mkdir(dir, { recursive: true });
+}
+export async function writeFileEnsured(filePath, content) {
+    await ensureDir(path.dirname(filePath));
+    await fs.writeFile(filePath, content, 'utf8');
+}
+export async function walkFiles(root) {
+    const results = [];
+    const entries = await fs.readdir(root, { withFileTypes: true });
+    for (const entry of entries) {
+        const fullPath = path.join(root, entry.name);
+        if (entry.isDirectory()) {
+            results.push(...(await walkFiles(fullPath)));
+            continue;
+        }
+        if (entry.isFile()) {
+            results.push(fullPath);
+        }
+    }
+    return results;
+}
+export function isFullHtmlDocument(html) {
+    return /<html[\s>]/i.test(html) || /<!doctype html>/i.test(html);
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@opnpress/opnpress-cli",
+  "version": "0.1.0",
+  "private": false,
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OpnPress/OpnPressCli.git"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "README.md",
+    "package.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "opnPrs": "./dist/cli.js",
+    "opnPress": "./dist/cli.js"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "check": "tsc --noEmit",
+    "dev": "tsx src/cli.ts",
+    "init": "tsx src/cli.ts init",
+    "run": "tsx src/cli.ts run",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "gray-matter": "^4.0.3",
+    "rehype-autolink-headings": "^7.1.0",
+    "rehype-raw": "^7.0.0",
+    "rehype-slug": "^6.0.0",
+    "rehype-stringify": "^10.0.1",
+    "remark-gfm": "^4.0.1",
+    "remark-parse": "^11.0.0",
+    "remark-rehype": "^11.1.2",
+    "tsx": "^4.20.3",
+    "unified": "^11.0.5",
+    "yaml": "^2.8.1",
+    "zod": "^3.25.67"
+  },
+  "devDependencies": {
+    "@types/node": "^24.3.0",
+    "playwright": "^1.59.1",
+    "typescript": "^5.9.2",
+    "vitest": "^3.2.4"
+  }
+}

package/templates/.github/workflows/build-pages.yml

@@ -0,0 +1,37 @@
+name: Build and Deploy Pages
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: cloudflare-pages
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: npm
+
+      - name: Build site
+        run: npx -y @opnpress/opnpress-cli@latest opnPress build
+
+      - name: Publish to Cloudflare Pages
+        uses: cloudflare/wrangler-action@v3
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: pages deploy dist --project-name=${{ secrets.CLOUDFLARE_PROJECT_NAME }} --branch=${{ github.ref_name }}

package/templates/.skills/README.md

@@ -0,0 +1,6 @@
+# Skills
+
+This folder stores starter guidance for building an OpnPress site.
+
+The files here are copied by `opnPress init`, so edit the templates in this repository to change the scaffold.
+

package/templates/.skills/add-shortcode.md

@@ -0,0 +1,18 @@
+# Add Shortcode
+
+Use this skill when adding a shortcode block to an existing page.
+
+## What To Do
+
+- read `.skills/shortcodes.md` before choosing the block
+- prefer the simplest shortcode that fits the page intent
+- keep page-local links relative, and use `source.md` only when you explicitly want the source mirror
+- use integration-backed blocks only when the content comes from `site.config.yaml`
+- keep the page content readable to an LLM without needing rendered HTML
+
+## Recommended Checks
+
+- verify the shortcode matches the content type and source of truth
+- verify links between pages stay relative
+- verify the build still passes after the page change
+

package/templates/.skills/create-page.md

@@ -0,0 +1,17 @@
+# Create Page
+
+Use this skill when adding a new page to an OpnPress site.
+
+## What To Do
+
+- choose the correct file path under `content/pages/`, `content/services/`, or `content/locations/`
+- add YAML frontmatter with title, description, and layout
+- keep the page focused on one intent
+- validate the build after creating the file
+
+## Recommended Checks
+
+- verify the route matches the file path
+- verify navigation points to the page if needed
+- verify the page renders without broken links
+

package/templates/.skills/deployment-checks.md

@@ -0,0 +1,75 @@
+# Deployment Checks
+
+Use this skill before publishing a site or opening a release.
+
+## Purpose
+
+- run the other relevant skills
+- identify what is missing before publish
+- generate a report with actionable fixes
+- save the report for later reference
+- capture user answers as durable decisions so future checks can reuse them
+
+## Trigger Order
+
+1. `site-audit`
+2. `link-audit`
+3. `theme-customization`
+4. `setup-integrations`
+5. `update-navigation`
+6. `update-header-footer`
+7. `create-page` or `update-page` for page-specific fixes
+
+## What To Check
+
+- missing required page metadata
+- broken internal links
+- orphaned or unreachable pages
+- navigation completeness
+- header and footer consistency
+- integration configuration
+- SEO and AI metadata
+- build output readiness
+- publish target readiness
+
+## Required Output
+
+Write a report with these sections:
+
+- Summary
+- Blocking issues
+- Non-blocking recommendations
+- Pages to create or update
+- Navigation or footer changes
+- Integration fixes
+- Publish readiness verdict
+- Saved decisions
+
+## Report Rules
+
+- be specific about file paths
+- explain why each item matters
+- recommend the exact next action
+- separate blockers from recommendations
+- if nothing is blocking, say so clearly
+
+## Saving The Report
+
+- save the report in the repository under `.opnpress/reports/deployment-checks.md`
+- if the folder does not exist, create it
+- append the date and time of the check to the top of the report
+- keep the latest report easy to find
+
+## Learning From The User
+
+- if the user answers questions during the check, record those answers in the report under `Saved Decisions`
+- preserve the answers in a reusable note so future checks can apply them automatically
+- when a decision is repeated, prefer the saved answer over asking again
+
+## Recommended Behavior
+
+- treat this as the last step before publish
+- if a blocker exists, stop and report it
+- if no blockers exist, confirm the site is ready for deployment
+- prefer concrete file edits over vague advice
+

package/templates/.skills/integrations.md

@@ -0,0 +1,6 @@
+# Integrations
+
+This file documents the default integration blocks that can be enabled in a starter site.
+
+Use the site config to wire provider settings, then reference the corresponding shortcode in content pages.
+

package/templates/.skills/link-audit.md

@@ -0,0 +1,17 @@
+# Link Audit
+
+Use this skill when checking for broken or orphaned pages.
+
+## What To Check
+
+- broken internal links
+- orphaned content pages
+- missing navigation targets
+- mismatched route and file paths
+
+## Output Style
+
+- list the broken or orphaned path
+- explain where it is referenced, or not referenced
+- recommend whether to link it, delete it, or redirect it
+

package/templates/.skills/setup-integrations.md

@@ -0,0 +1,84 @@
+# Setup Integrations
+
+Use this skill when adding or changing integrations.
+
+## What To Do
+
+- define the provider in `site.config.yaml`
+- author the semantic block in markdown
+- keep the content provider-agnostic
+- prefer integration-backed blocks for shared site data
+- validate the page after rendering
+
+## Supported Blocks
+
+- `contact-form`
+- `shareable-links`
+- `socials-links` from `site.socials`
+- `company-info`
+- `contact-links`
+- `booking-calendar`
+- `maps`
+
+## Media Shortcodes
+
+- `video`
+
+Treat `video` as a shortcode with `provider` and `url` params, not as a separate integration category.
+
+## Page-Local Shortcodes
+
+- `contact-card`
+- `mailto`
+- `tel`
+
+Use `contact-card` for page-local contact blocks such as franchise locations or branch pages.
+Use `mailto` and `tel` for single-use contact actions inside page content.
+
+## Social Profiles
+
+Use `site.socials` for public profile links and social metadata.
+
+Supported keys:
+
+- `twitter`
+- `x`
+- `github`
+- `facebook`
+- `instagram`
+- `linkedin`
+- `youtube`
+- `tiktok`
+- `threads`
+- `mastodon`
+- `bluesky`
+- `website`
+- `email`
+
+Each value can be a handle or a full URL. The renderer converts handles into public profile URLs where possible.
+
+## Config Fields
+
+- `site.site.*` for site identity and branding
+- `site.seo.defaultImage` for crawl and preview defaults
+- `site.socials.*` for social identity links
+- `site.branding.poweredByOpnPress` for footer attribution
+- `site.deployment.provider` and `site.deployment.cloudflare.*` for publishing
+- `site.integrations.contactForm.*`
+- `site.integrations.shareableLinks.*`
+- `site.integrations.companyInfo.*`
+- `site.integrations.contactLinks.*`
+- `site.integrations.bookingCalendar.*`
+- `site.integrations.maps.*`
+- `contact-card` shortcode params: `name`, `tagline`, `logo`, `address`, `mapUrl`, `phone`, `email`, `hours`, `website`
+- `contact-links` shortcode params: `variant`, `showIcons`, `showLabels`
+- `mailto` shortcode params: `email`, `subject`, `body`, `label`, `showIcon`
+- `tel` shortcode params: `phone`, `label`, `showIcon`
+- `video` shortcode params: `provider`, `url`, and optional presentation fields
+
+## Recommended Checks
+
+- verify required config values are present
+- verify the block renders instead of falling back to escaped code
+- verify the resulting links stay relative when they should
+

package/templates/.skills/shortcodes.md

@@ -0,0 +1,152 @@
+# Shortcodes
+
+This file is for LLM-facing reference only.
+
+It is not rendered as a site page. The build copies it into `dist/shortcodes.md` and references it from `llms.txt`.
+
+## Principles
+
+- Pages render directly from markdown or standalone HTML.
+- Shortcodes exist for structured sections, not hidden renderer layouts.
+- Some shortcodes are integration display hooks: they only control placement, not the underlying data source.
+- All links between markdown pages, mirrors, and related content should stay relative so an LLM can infer the site structure and traverse it without resolving absolute URLs first.
+
+## Shared Presentation
+
+Most shortcodes support the same shared presentation props:
+
+- `title`
+- `description`
+- `eyebrow`
+- `anchor`
+- `backgroundImage`
+- `backgroundPosition`
+- `backgroundSize`
+- `backgroundRepeat`
+- `backgroundColor`
+- `overlay`
+- `textColor`
+- `padding`
+- `minHeight`
+- `maxWidth`
+- `align`
+
+Keep these relative-path friendly for assets and backgrounds.
+
+## Page-Structure Shortcodes
+
+### `cardrow`
+
+Render a row or grid of cards on a markdown page.
+
+Prefer explicit card objects with relative `href` values such as `about/`.
+Use `source.md` only when the card intentionally points to the LLM/source mirror.
+
+Example:
+
+```md
+:::cardrow
+title: Explore the starter site
+description: Cards should normally point at rendered pages.
+cards:
+  - title: Pages
+    href: about/
+    body: Create markdown pages with YAML frontmatter.
+  - title: Integrations
+    href: integrations/
+    body: Render semantic blocks for forms, social links, maps, video, and calendars.
+  - title: Services
+    href: services/
+    body: Create service pages with the same markdown-first workflow.
+:::
+```
+
+### `pagelist`
+
+Render a list of pages from a folder.
+
+The list links to each page's rendered route by default. Use source mirrors only when the list is specifically for LLM traversal or source inspection.
+
+### `contact-card`
+
+Render a page-local company or branch contact card.
+
+Use this for franchise locations, offices, or branch pages.
+
+It accepts the same contact fields as the `company-info` integration, but on a single page.
+
+### `contact-links`
+
+Render the reusable contact links that come from the site-level `contact-links` integration.
+
+This shortcode only decides where the configured contact links appear on the page.
+
+### `mailto`
+
+Render a single email link or compact email block.
+
+Use `email`, `subject`, `body`, `label`, and `showIcon` in the shortcode body.
+
+### `tel`
+
+Render a single telephone link or compact phone block.
+
+Use `phone`, `label`, and `showIcon` in the shortcode body.
+
+## Integration-Backed Blocks
+
+### `contact-form`
+
+Render a provider-backed contact form.
+
+Requires `site.integrations.contactForm.action`.
+
+### `shareable-links`
+
+Render share links for the current page.
+
+Requires `site.integrations.shareableLinks.enabled`.
+
+### `socials-links`
+
+Render configured social profile links from `site.socials`.
+
+### `booking-calendar`
+
+Render a scheduling embed.
+
+Requires `site.integrations.bookingCalendar.embedUrl`.
+
+### `maps`
+
+Render a map embed.
+
+Requires `site.integrations.maps.embedUrl`.
+
+### `company-info`
+
+Render canonical company/contact information from site config.
+
+This is the site-wide version of the contact card and can be reused in headers, footers, and contact areas.
+
+### `contact-links`
+
+Render the reusable contact link cluster from site config.
+
+This is the site-wide display hook for contact actions like email, phone, website, and map links.
+
+## Media Shortcodes
+
+### `video`
+
+Render a video embed from shortcode params. This is a shortcode, not a site integration category.
+
+Provider should usually be `youtube`, `vimeo`, or `loom`.
+
+## Markdown And HTML Mirrors
+
+- Markdown pages are published as HTML and mirrored as `source.md`.
+- Custom HTML pages are published as HTML and mirrored as `source.html`.
+- `llms.txt` lists both types separately and labels them with `markdown` or `html`.
+- The hidden `[system-reminder]` marker on markdown pages points to the `source.md` mirror, but visible navigation should normally point to the rendered page.
+

package/templates/.skills/site-audit.md

@@ -0,0 +1,20 @@
+# Site Audit
+
+Use this skill when checking a site for missing pieces and recommending fixes.
+
+## What To Check
+
+- required frontmatter fields
+- page titles and descriptions
+- canonical and social metadata
+- navigation completeness
+- footer branding
+- integration config presence
+- build output completeness
+
+## Output Style
+
+- list what is missing
+- explain the impact
+- recommend the next fix in file terms
+

package/templates/.skills/theme-customization.md

@@ -0,0 +1,17 @@
+# Theme Customization
+
+Use this skill when changing the site theme.
+
+## MVP Surface
+
+- colors
+- backgrounds
+- fonts
+- sizing
+- limited layout controls
+
+## Recommended Checks
+
+- verify the theme still reads well on mobile
+- verify contrast and spacing remain usable
+

package/templates/.skills/update-header-footer.md

@@ -0,0 +1,15 @@
+# Update Header And Footer
+
+Use this skill when changing global header or footer content.
+
+## What To Do
+
+- edit the site shell, not individual pages, for global header/footer changes
+- keep branding links intentional
+- preserve readable navigation on mobile
+
+## Recommended Checks
+
+- verify the header still links home correctly
+- verify the footer still includes required brand or attribution links
+

package/templates/.skills/update-navigation.md

@@ -0,0 +1,16 @@
+# Update Navigation
+
+Use this skill when editing site navigation.
+
+## What To Do
+
+- update `navigation.yaml`
+- keep labels short and clear
+- use relative internal paths for site pages
+- keep external links explicit
+
+## Recommended Checks
+
+- verify every internal navigation target exists
+- verify footer and header nav stay consistent with the site structure
+