@theholocron/holocron-plugin-fern 3.43.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Newton Koumantzelis
+
+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,90 @@
+<!-- editorconfig-checker-disable-file -->
+
+# `@theholocron/holocron-plugin-fern`
+
+Fern plugin for [Holocron](../cli). Implements the `wiki` capability for
+engineering knowledge publishing via [Fern](https://buildwithfern.com).
+
+## Install
+
+<!-- prettier-ignore -->
+```bash
+pnpm add -D @theholocron/holocron-plugin-fern
+
+```
+
+## Config
+
+<!-- prettier-ignore -->
+```jsonc
+{
+  "providers": {
+    // Short form — org name inferred from config.org
+    "wiki": "fern",
+
+    // With custom domain — all repos share wiki.theholocron.dev/<reponame>
+    "wiki": ["fern", { "domain": "wiki.theholocron.dev" }],
+
+    // With an explicit basepath
+    "wiki": ["fern", { "domain": "wiki.theholocron.dev/myrepo" }],
+  },
+}
+
+```
+
+### Options
+
+| Option   | Required | Description                                                                                                                                                                |
+| -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `domain` | No       | Base domain (`"wiki.theholocron.dev"`) or full path (`"wiki.theholocron.dev/myrepo"`). When a base domain is given, the repo name is appended automatically as a basepath. |
+
+## What `holocron setup` does
+
+1. **Writes `fern/fern.config.json`** — Fern workspace org name and pinned
+   CLI version. Always overwritten.
+2. **Scaffolds `fern/docs.yml`** — Instance URL, optional custom domain with
+   `multi-source: true`, and navigation pointing at `docs/decisions/` and
+   `docs/engineering/`. Skipped if the file already exists so hand-edited
+   navigation entries are preserved.
+
+Both files must be committed — the CI workflow reads them at deploy time.
+
+## Custom domain and multi-source routing
+
+When `domain` is a bare host, the plugin appends the repo name as a
+basepath so every repo in the org gets its own URL under a shared domain:
+
+```yaml
+# Generated fern/docs.yml for repo "theholocron/holocron"
+# with domain: "wiki.theholocron.dev"
+instances:
+  - url: theholocron.docs.buildwithfern.com/holocron
+    custom-domain: wiki.theholocron.dev/holocron
+    multi-source: true
+```
+
+DNS: add one CNAME record — `wiki.theholocron.dev` →
+`theholocron.docs.buildwithfern.com`.
+
+## Password protection
+
+Password protection is configured in the **Fern Dashboard**
+(`dashboard.buildwithfern.com`) — it is not configurable via `docs.yml` or
+any CLI flag. Configure access control manually in the dashboard after
+running `holocron setup`.
+
+## CI secrets
+
+Add `HOLOCRON_FERN_TOKEN` to your repo's GitHub Secrets. The `wiki.yml` thin caller
+passes it to the Fern CLI during `fern generate --docs`.
+
+| Secret                | Purpose                                      |
+| --------------------- | -------------------------------------------- |
+| `HOLOCRON_FERN_TOKEN` | Fern workspace API token for `fern generate` |
+
+Generate a token at `dashboard.buildwithfern.com` under **Settings → API tokens**.
+
+## What `wiki` provides
+
+- `provision(opts?)` — writes `fern/fern.config.json` and scaffolds
+  `fern/docs.yml` (skipped if already present).

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@theholocron/holocron-plugin-fern",
+  "version": "3.43.0",
+  "description": "Holocron plugin for Fern. Implements the wiki capability for engineering knowledge publishing.",
+  "keywords": [
+    "fern",
+    "holocron",
+    "plugin",
+    "wiki"
+  ],
+  "homepage": "https://github.com/theholocron/holocron/tree/main/packages/holocron-plugin-fern#readme",
+  "bugs": "https://github.com/theholocron/holocron/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/theholocron/holocron.git",
+    "directory": "packages/holocron-plugin-fern"
+  },
+  "license": "MIT",
+  "author": "Newton Koumantzelis",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@theholocron/eslint-config": "^7.25.4",
+    "@theholocron/tsconfig": "^7.20.0",
+    "@theholocron/tsdown-config": "^7.20.0",
+    "@theholocron/vitest-config": "^7.20.0",
+    "@types/node": "^26",
+    "@vitest/coverage-v8": "^4.1.10",
+    "@vitest/eslint-plugin": "^1.6.27",
+    "eslint": "^10.8.1",
+    "eslint-plugin-n": "^18.3.0",
+    "globals": "^17.11.0",
+    "tsdown": "^0.22.14",
+    "tsx": "4.23.12",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.10",
+    "@theholocron/cli": "3.43.0"
+  },
+  "peerDependencies": {
+    "@theholocron/cli": "3.43.0"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  }
+}