for-humanity 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/README.md +10 -3
  3. package/package.json +6 -5
package/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.2 — 2026-10-03
4
+
5
+ Documentation and release automation update. The CLI commands and Node.js requirement are unchanged.
6
+
7
+ - Link the README to the public documentation site, npm package and GitHub Releases.
8
+ - Set the package homepage to `https://for-humanity.fyi`.
9
+ - Deploy the documentation from `main` to Cloudflare Pages and preserve installation commands in served HTML.
10
+ - Verify pull requests and publish npm plus GitHub Release from matching stable version tags using Trusted Publishing.
11
+ - Add official Releases and Changelog pages to the documentation site, with the changelog generated from this file.
12
+ - Accept both npm 11 array reports and npm 12 package-keyed reports when validating release artifacts.
13
+
14
+ The `v0.1.1` attempt stopped during package validation and was not published to npm.
15
+
3
16
  ## 0.1.0 — 2026-10-03
4
17
 
5
18
  First public release of the Markdown documentation CLI. Requires Node.js 22 or later.
package/README.md CHANGED
@@ -8,7 +8,10 @@
8
8
 
9
9
  Write Markdown. Keep the context. Share a static site.
10
10
 
11
+ [Documentation](https://for-humanity.fyi) · [npm](https://www.npmjs.com/package/for-humanity) · [Releases](https://github.com/minu-ha/for-humanity/releases)
12
+
11
13
  [![MIT](https://img.shields.io/badge/license-MIT-1111aa?style=flat-square)](https://github.com/minu-ha/for-humanity/blob/main/LICENSE)
14
+ [![npm](https://img.shields.io/npm/v/for-humanity?style=flat-square)](https://www.npmjs.com/package/for-humanity)
12
15
  ![Node 22+](https://img.shields.io/badge/node-22%2B-444444?style=flat-square)
13
16
  ![Hono + React](https://img.shields.io/badge/Hono-%2B%20React-444444?style=flat-square)
14
17
  ![Prototype](https://img.shields.io/badge/status-prototype-9a6400?style=flat-square)
@@ -30,7 +33,7 @@ Write Markdown. Keep the context. Share a static site.
30
33
  Node.js 22 or later and pnpm. Install the CLI in your document project:
31
34
 
32
35
  ```sh
33
- pnpm add -D --save-exact for-humanity@0.1.0
36
+ pnpm add -D --save-exact for-humanity@0.1.2
34
37
  mkdir docs
35
38
  ```
36
39
 
@@ -49,7 +52,7 @@ pnpm exec for-humanity preview docs
49
52
 
50
53
  If your Markdown files are in the project root, use `.` instead of `docs`. The root `README.md` becomes the home page; root `AGENTS.md` and `CLAUDE.md` stay out of the site.
51
54
 
52
- Version `0.1.0` supports `dev`, `build` and `preview`. `init` is planned; see the [Roadmap](https://github.com/minu-ha/for-humanity/blob/main/templates/document/roadmap.md) and [Changelog](https://github.com/minu-ha/for-humanity/blob/main/CHANGELOG.md).
55
+ Version `0.1.2` supports `dev`, `build` and `preview`. `init` is planned; see the [Roadmap](https://github.com/minu-ha/for-humanity/blob/main/templates/document/roadmap.md) and [Changelog](https://github.com/minu-ha/for-humanity/blob/main/CHANGELOG.md).
53
56
  Cloudflare Pages can host the generated site. See [Deployment](https://github.com/minu-ha/for-humanity/blob/main/templates/document/deployment.md) for the build settings.
54
57
 
55
58
  ### Develop the kit
@@ -71,11 +74,14 @@ pnpm preview # Preview the static site
71
74
  pnpm build:pages # Add Cloudflare Pages headers and a 404 page
72
75
  ```
73
76
 
77
+ Changes pushed to `main` update the documentation site. A stable version tag such as `v0.1.2` runs checks, publishes the package to npm, then creates a GitHub Release with the same package file.
78
+ The npm README updates with each package release. See [Maintenance](https://github.com/minu-ha/for-humanity/blob/main/templates/document/maintenance.md#packaging-and-release) for the release steps.
79
+
74
80
  ## Make it yours
75
81
 
76
82
  A document folder is enough to get started. Without a site configuration, the sidebar shows **for humanity**. The pixel face appears in the browser tab and follows the mouse on desktop.
77
83
  The folder's `README.md` becomes the home page at `/`, with no frontmatter required. Click the site name to return home.
78
- This repository generates [the documentation home](https://github.com/minu-ha/for-humanity/blob/main/templates/document/README.md) from its root README.md. Edit the repository's root README.md, then run `pnpm sync:readme`; `pnpm dev` and `pnpm build` also sync it on startup.
84
+ This repository generates [the documentation home](https://github.com/minu-ha/for-humanity/blob/main/templates/document/README.md) from its root README.md and [the site changelog](https://github.com/minu-ha/for-humanity/blob/main/templates/document/changelog.md) from CHANGELOG.md. Edit those source files, then run `pnpm sync:docs`; `pnpm dev` and `pnpm build` also sync them on startup.
79
85
  Set your own name in `for-humanity.config.mjs`:
80
86
 
81
87
  ```js
@@ -110,6 +116,7 @@ The contract, code or reasoning behind the visible result.
110
116
  | Getting started | [Commands](https://github.com/minu-ha/for-humanity/blob/main/templates/document/commands.md) · [Deployment](https://github.com/minu-ha/for-humanity/blob/main/templates/document/deployment.md) |
111
117
  | Guide | [Writing](https://github.com/minu-ha/for-humanity/blob/main/templates/document/writing.md) · [Parts](https://github.com/minu-ha/for-humanity/blob/main/templates/document/parts.md) · [Settings](https://github.com/minu-ha/for-humanity/blob/main/templates/document/settings.md) |
112
118
  | Reference | [API](https://github.com/minu-ha/for-humanity/blob/main/templates/document/api.md) |
119
+ | Releases | [Official releases](https://github.com/minu-ha/for-humanity/blob/main/templates/document/releases.md) · [Changelog](https://github.com/minu-ha/for-humanity/blob/main/templates/document/changelog.md) |
113
120
  | Examples | [Fictional Blueprint](https://github.com/minu-ha/for-humanity/blob/main/templates/document/blueprint.md) |
114
121
  | Development | [Architecture](https://github.com/minu-ha/for-humanity/blob/main/templates/document/architecture.md) · [Design](https://github.com/minu-ha/for-humanity/blob/main/templates/document/design.md) · [Maintenance](https://github.com/minu-ha/for-humanity/blob/main/templates/document/maintenance.md) · [Roadmap](https://github.com/minu-ha/for-humanity/blob/main/templates/document/roadmap.md) |
115
122
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "for-humanity",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "Documents written for humans to read: a docs kit with a sidebar, parts, sections and flowcharts, built on Hono and React",
5
5
  "keywords": [
6
6
  "docs",
@@ -17,7 +17,7 @@
17
17
  "type": "git",
18
18
  "url": "git+https://github.com/minu-ha/for-humanity.git"
19
19
  },
20
- "homepage": "https://github.com/minu-ha/for-humanity#readme",
20
+ "homepage": "https://for-humanity.fyi",
21
21
  "bugs": {
22
22
  "url": "https://github.com/minu-ha/for-humanity/issues"
23
23
  },
@@ -36,11 +36,12 @@
36
36
  "scripts": {
37
37
  "build:kit": "esbuild src/cli.ts --bundle --platform=node --format=esm --packages=external --jsx=automatic --outfile=dist/cli.js && esbuild src/client.ts --bundle --platform=browser --format=esm --jsx=automatic --minify --define:process.env.NODE_ENV='\"production\"' --outdir=dist",
38
38
  "sync:readme": "node util/sync-readme.mjs",
39
- "dev": "pnpm sync:readme && pnpm build:kit && node dist/cli.js dev templates/document",
40
- "build": "pnpm sync:readme && pnpm build:kit && node dist/cli.js build templates/document",
39
+ "sync:docs": "pnpm sync:readme && node util/sync-changelog.mjs",
40
+ "dev": "pnpm sync:docs && pnpm build:kit && node dist/cli.js dev templates/document",
41
+ "build": "pnpm sync:docs && pnpm build:kit && node dist/cli.js build templates/document",
41
42
  "build:pages": "pnpm build && node util/prepare-pages.mjs",
42
43
  "preview": "node dist/cli.js preview templates/document",
43
- "test": "esbuild src/util/font/to-font-css.test.ts src/content/read-docs.test.ts --bundle --platform=node --format=esm --packages=external --outbase=src --outdir=node_modules/.cache/for-humanity-tests --out-extension:.js=.mjs && node --test node_modules/.cache/for-humanity-tests/content/*.test.mjs node_modules/.cache/for-humanity-tests/util/font/*.test.mjs",
44
+ "test": "esbuild src/util/font/to-font-css.test.ts src/content/read-docs.test.ts --bundle --platform=node --format=esm --packages=external --outbase=src --outdir=node_modules/.cache/for-humanity-tests --out-extension:.js=.mjs && node --test node_modules/.cache/for-humanity-tests/content/*.test.mjs node_modules/.cache/for-humanity-tests/util/font/*.test.mjs util/*.test.mjs",
44
45
  "lint": "biome check && stylelint \"src/**/*.css\"",
45
46
  "lint:fix": "biome check --write && stylelint \"src/**/*.css\" --fix",
46
47
  "typecheck": "tsc --noEmit",