create-markupress 0.0.0-stage → 0.8.0

package/index.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+// @ts-check
+import { cpSync, existsSync, readdirSync, readFileSync, renameSync, writeFileSync } from 'node:fs';
+import { basename, join, relative, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+/**
+ * Copies the starter site into a new folder: `npm create markupress@latest <folder>`. The starter's package.json depends
+ * on the Markupress release this package shares its version with, and on the HTML Next and Looma it pins.
+ */
+const template = fileURLToPath(new URL('./template', import.meta.url));
+const folder = process.argv[2] ?? 'docs';
+const target = resolve(folder);
+if (existsSync(target) && readdirSync(target).length > 0) {
+  process.stderr.write(`${target} already has files. Choose a new or empty folder: npm create markupress@latest my-docs\n`);
+  process.exit(1);
+}
+cpSync(template, target, { recursive: true });
+// npm leaves .gitignore files out of a package, so the starter's is stored as _gitignore.
+renameSync(join(target, '_gitignore'), join(target, '.gitignore'));
+const manifest = join(target, 'package.json');
+const name = basename(target).toLowerCase().replace(/[^a-z0-9._-]+/g, '-').replace(/^[._-]+/, '') || 'docs';
+writeFileSync(manifest, readFileSync(manifest, 'utf8').replace('"name": "markupress-site"', `"name": ${JSON.stringify(name)}`));
+const where = relative(process.cwd(), target) || '.';
+process.stdout.write(`Created a Markupress site in ${where}.\n\n  cd ${where}\n  npm install\n  npm run dev\n\n`);

package/package.json

@@ -1,6 +1,27 @@
 {
   "name": "create-markupress",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.8.0",
+  "description": "Start a Markupress documentation site: npm create markupress@latest docs.",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "create-markupress": "./index.js"
+  },
+  "files": [
+    "index.js",
+    "template"
+  ],
+  "engines": {
+    "node": ">=22.22.2 <23 || >=24.15 <25"
+  },
+  "publishConfig": { "access": "public" },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/threadlabs-studio/markupress.git",
+    "directory": "packages/create-markupress"
+  },
+  "homepage": "https://threadlabs-studio.github.io/markupress/guide/getting-started/",
+  "bugs": {
+    "url": "https://github.com/threadlabs-studio/markupress/issues"
+  }
+}

package/template/_gitignore

@@ -0,0 +1,2 @@
+node_modules/
+site/

package/template/app/components/counter.html

@@ -0,0 +1,5 @@
+<template component="demo-counter" controller="./counter.js">
+  <defs><state name="count" type="number" value="0"></state></defs>
+  <div><button>Count</button><output>{$count}</output></div>
+  <style>:host { display: flex; align-items: center; gap: 1rem; padding: 1rem; border: 1px solid var(--ui-border); border-radius: var(--ui-radius-md); }</style>
+</template>

package/template/app/components/counter.ts

@@ -0,0 +1,10 @@
+import type { ComponentHost } from '@nextwebwg/html-next/runtime';
+
+export default function counter(host: ComponentHost): void {
+  host.on('connect', () => {
+    const button = host.root.querySelector('button')!;
+    const click = () => { host.state.count = Number(host.state.count) + 1; };
+    button.addEventListener('click', click);
+    return () => button.removeEventListener('click', click);
+  });
+}

package/template/docs/01.guide/01.getting-started.md

@@ -0,0 +1,17 @@
+---
+description: Install and run the project.
+---
+# Getting started
+
+Install the project's dependencies, then start the development server:
+
+```sh
+npm install
+npm run dev
+```
+
+The development server reloads the page after every edit. `npm run build` writes the static site to `site/`, and `npm run preview` serves it.
+
+::: tip Edit this page
+This page is `docs/01.guide/01.getting-started.md`. Change it, save, and the browser shows the change.
+:::

package/template/docs/01.guide/02.writing.md

@@ -0,0 +1,32 @@
+---
+description: Markdown, callouts, code groups and components.
+---
+# Writing pages
+
+Each Markdown file in `docs/` is a page. Folders are sections, and a number prefix such as `02.` orders a page among its siblings.
+
+## Callouts
+
+::: warning Before you upgrade
+Back up your data first.
+:::
+
+## Code groups
+
+::: code-group
+```sh title="npm"
+npm install my-project
+```
+
+```sh title="pnpm"
+pnpm add my-project
+```
+:::
+
+## Components
+
+<link rel="component" href="@/app/components/counter.html">
+
+<demo-counter></demo-counter>
+
+The counter is `app/components/counter.html`, linked from the project root with `@/`, and its controller is `app/components/counter.ts`.

package/template/docs/01.guide/index.md

@@ -0,0 +1,4 @@
+---
+title: Guide
+description: Install, write and publish.
+---

package/template/docs/_footer.md

@@ -0,0 +1,9 @@
+## Docs
+
+- [Getting started](/guide/getting-started/)
+
+## Built with
+
+- [Markupress](https://threadlabs-studio.github.io/markupress/)
+
+Copyright 2026 My project contributors.

package/template/docs/index.md

@@ -0,0 +1,21 @@
+---
+layout: home
+description: The documentation for my project.
+---
+# My project
+
+The documentation for my project, written in Markdown.
+
+[Get started](01.guide/01.getting-started.md) [Writing pages](01.guide/02.writing.md)
+
+## Markdown
+
+Callouts, tabs, code groups and highlighted code, from plain Markdown.
+
+## Components
+
+Native HTML Next components in any page, with TypeScript controllers.
+
+## Versions
+
+`npx markupress snapshot v1` records the docs as they stand.

package/template/markupress.config.ts

@@ -0,0 +1,5 @@
+import { defineConfig } from 'markupress';
+
+export default defineConfig({
+  title: 'My project',
+});

package/template/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "markupress-site",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "markupress dev",
+    "build": "markupress build",
+    "preview": "markupress preview"
+  },
+  "dependencies": {
+    "@nextwebwg/html-next": "1.0.0-alpha.69",
+    "@threadlabs/looma": "0.33.0",
+    "markupress": "^0.8.0"
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.