for-humanity 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 0.1.0 — 2026-10-03
+
+First public release of the Markdown documentation CLI. Requires Node.js 22 or later.
+
+- `dev`, `build` and `preview` commands for a document folder or the project root.
+- Static HTML, CSS, a browser script, self-hosted fonts and a favicon.
+- A README home page, grouped navigation, a table of contents, Markdown links and highlighted code.
+- Notes, disclosures, Mermaid flowcharts, status badges and color swatches.
+- System light and dark themes, mobile navigation and keyboard access.
+- Root `AGENTS.md` and `CLAUDE.md` excluded from the document list.
+
+`init`, search and deployment under a URL subpath are planned. Static output currently assumes the site root `/`.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 하민우
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,118 @@
+<div align="center">
+
+<img src="https://raw.githubusercontent.com/minu-ha/for-humanity/main/src/asset/favicon.svg" width="96" height="96" alt="for humanity pixel face">
+
+# for humanity
+
+**Documents, for humans.**
+
+Write Markdown. Keep the context. Share a static site.
+
+[![MIT](https://img.shields.io/badge/license-MIT-1111aa?style=flat-square)](https://github.com/minu-ha/for-humanity/blob/main/LICENSE)
+![Node 22+](https://img.shields.io/badge/node-22%2B-444444?style=flat-square)
+![Hono + React](https://img.shields.io/badge/Hono-%2B%20React-444444?style=flat-square)
+![Prototype](https://img.shields.io/badge/status-prototype-9a6400?style=flat-square)
+
+[Quick start](#quick-start) · [Guide](https://github.com/minu-ha/for-humanity/blob/main/templates/document/writing.md) · [API](https://github.com/minu-ha/for-humanity/blob/main/templates/document/api.md) · [Deployment](https://github.com/minu-ha/for-humanity/blob/main/templates/document/deployment.md) · [Korean](https://github.com/minu-ha/for-humanity/blob/main/language/README.ko.md)
+
+</div>
+
+## A little structure. Room to read.
+
+- **Find your place.** Pages grouped by purpose, a reading order, a tree of contents and the current reading position.
+- **Keep the detail.** Notes for context, native disclosures for implementation details, and links that open folded sections.
+- **Show the connections.** Tables, highlighted code, Mermaid flowcharts, status badges and color swatches.
+- **Share the result.** Static HTML, self-hosted fonts and a small browser script. No React hydration.
+- **Read your way.** System-matched light and dark themes, keyboard navigation and a layout for narrow screens.
+
+## Quick start
+
+Node.js 22 or later and pnpm. Install the CLI in your document project:
+
+```sh
+pnpm add -D --save-exact for-humanity@0.1.0
+mkdir docs
+```
+
+Create `docs/README.md` for the home page, then start the development server:
+
+```sh
+pnpm exec for-humanity dev docs
+```
+
+Open [localhost:4321](http://localhost:4321). Build and preview your static site:
+
+```sh
+pnpm exec for-humanity build docs    # Generate docs/dist
+pnpm exec for-humanity preview docs
+```
+
+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.
+
+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).
+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.
+
+### Develop the kit
+
+To work on the CLI or read this library's guides and examples locally, run the project from source:
+
+```sh
+git clone https://github.com/minu-ha/for-humanity.git
+cd for-humanity
+pnpm install
+pnpm dev
+```
+
+Open [localhost:4321](http://localhost:4321) to read this library's usage guides, API reference and fictional examples.
+
+```sh
+pnpm build      # Generate templates/document/dist
+pnpm preview    # Preview the static site
+pnpm build:pages # Add Cloudflare Pages headers and a 404 page
+```
+
+## Make it yours
+
+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.
+The folder's `README.md` becomes the home page at `/`, with no frontmatter required. Click the site name to return home.
+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.
+Set your own name in `for-humanity.config.mjs`:
+
+```js
+export default {
+    title: "Project notes",
+    description: "Decisions, working notes and the details behind them.",
+    navigation: ["Getting started", "Guide", "Reference", "Examples"],
+};
+```
+
+See [Commands](https://github.com/minu-ha/for-humanity/blob/main/templates/document/commands.md) for using another document folder, and [Settings](https://github.com/minu-ha/for-humanity/blob/main/templates/document/settings.md) for configuration.
+Each document other than the root README chooses a `group` and optional `order`. Pages stay independent; groups do not need parent documents or nested folders. Document names may share the same first letter.
+
+## Write with context
+
+```markdown
+:::note[Scope]
+What this document covers and what still needs a decision.
+:::
+
+:::details[Implementation]
+The contract, code or reasoning behind the visible result.
+:::
+```
+
+[Parts](https://github.com/minu-ha/for-humanity/blob/main/templates/document/parts.md) pairs source examples with their rendered results. The [Blueprint sample](https://github.com/minu-ha/for-humanity/blob/main/templates/document/blueprint.md) uses a fictional reading-list app to show a screen flow, decisions, open questions and illustrative API contracts.
+
+## Documentation
+
+| Group | Read |
+| ----- | ---- |
+| 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) |
+| 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) |
+| Reference | [API](https://github.com/minu-ha/for-humanity/blob/main/templates/document/api.md) |
+| Examples | [Fictional Blueprint](https://github.com/minu-ha/for-humanity/blob/main/templates/document/blueprint.md) |
+| 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) |
+
+## License
+
+[MIT](https://github.com/minu-ha/for-humanity/blob/main/LICENSE) © 2026 [minu-ha](https://github.com/minu-ha)