@marlinjai/clearify 1.14.2 → 1.15.0

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 (2) hide show
  1. package/README.md +28 -34
  2. package/package.json +3 -1
package/README.md CHANGED
@@ -1,42 +1,33 @@
1
1
  # Clearify
2
2
 
3
- An open-source documentation site generator. Turn markdown into beautiful docs.
4
-
5
- ## Features
6
-
7
- - **Zero config** — drop markdown files in `docs/public/` and go
8
- - **MDX support** — use React components in your docs (Callout, Tabs, Steps, Cards, CodeGroup, Accordion, Badge, Tooltip, Columns, Frame)
9
- - **Mermaid diagrams** — fenced `mermaid` code blocks render as SVG, with optional build-time pre-rendering via Puppeteer
10
- - **Built-in search** — instant full-text search across all pages and API endpoints
11
- - **Dark mode** — automatic light/dark theme switching
12
- - **Syntax highlighting** — beautiful code blocks with Shiki (dual light/dark themes)
13
- - **SSG & SEO** — pre-rendered HTML, Open Graph, Twitter Cards, JSON-LD, sitemap, robots.txt
14
- - **OpenAPI API Reference** — custom-built renderer for OpenAPI specs with code examples, schema viewer, and full design system integration
15
- - **Multi-section support** — pill-based section switcher (e.g. public docs + internal docs)
16
- - **Auto changelog** — drop a `CHANGELOG.md` in your project root, it appears as `/changelog`
17
- - **README as landing page** — optionally include your project's `README.md` as the docs overview page
3
+ An open-source documentation site generator. Turn markdown into beautiful docs. Run one site per project, or aggregate many repos into a single hub.
18
4
 
19
5
  ## Quick Start
20
6
 
21
- Install Clearify as a dev dependency:
22
-
23
7
  ```bash
24
8
  pnpm add -D @marlinjai/clearify
9
+ pnpm exec clearify init
10
+ pnpm exec clearify dev
25
11
  ```
26
12
 
27
- Scaffold your project:
13
+ Your docs are live at `http://localhost:4747`.
28
14
 
29
- ```bash
30
- pnpm exec clearify init
31
- ```
15
+ ## Hub mode
32
16
 
33
- Start the dev server:
17
+ Hub mode aggregates docs from many repos into one site. Each sub-repo owns its `docs/public/` folder. The hub clones only the docs from each registered repo, assembles them, and deploys once. To add a project to an existing hub, run `clearify init --hub`. See [Hub Model](./docs/public/hub-model.md) for the full onboarding walkthrough and provisioning paths.
34
18
 
35
- ```bash
36
- pnpm exec clearify dev
37
- ```
19
+ ## Features
38
20
 
39
- Your docs are live at `http://localhost:4747`.
21
+ - Zero config: drop markdown in `docs/public/` and go
22
+ - MDX support (Callout, Tabs, Steps, Cards, CodeGroup, Accordion, Badge, Tooltip, Columns, Frame)
23
+ - Mermaid diagrams (client or build-time via Puppeteer)
24
+ - Built-in full-text search
25
+ - Dark mode, syntax highlighting (Shiki, dual themes)
26
+ - SSG and SEO: pre-rendered HTML, Open Graph, Twitter Cards, JSON-LD, sitemap, robots.txt
27
+ - OpenAPI API Reference: custom renderer with code examples and schema viewer
28
+ - Multi-section support (pill-based section switcher)
29
+ - Hub mode: aggregate many repos into one site with sparse checkout and dispatch-triggered rebuilds
30
+ - Auto changelog, README as landing page
40
31
 
41
32
  ## Configuration
42
33
 
@@ -51,13 +42,8 @@ export default defineConfig({
51
42
  { label: 'Docs', docsDir: './docs/public' },
52
43
  { label: 'Internal', docsDir: './docs/internal', basePath: '/internal', draft: true },
53
44
  ],
54
- theme: {
55
- primaryColor: '#3B82F6',
56
- mode: 'auto',
57
- },
58
- openapi: {
59
- spec: './docs/openapi.json',
60
- },
45
+ theme: { primaryColor: '#3B82F6', mode: 'auto' },
46
+ openapi: { spec: './docs/openapi.json' },
61
47
  });
62
48
  ```
63
49
 
@@ -68,12 +54,20 @@ export default defineConfig({
68
54
  | `clearify dev` | Start Vite-powered dev server with HMR |
69
55
  | `clearify build` | Build static documentation site |
70
56
  | `clearify init` | Scaffold a docs folder (use `--no-internal` to skip internal section) |
57
+ | `clearify init --hub` | Scaffold and register the project with an existing hub (prompts for hub owner/repo) |
71
58
  | `clearify check` | Check for broken internal links |
72
59
  | `clearify openapi:generate` | Generate OpenAPI spec from a NestJS app |
73
60
 
61
+ ## Requirements
62
+
63
+ - Node.js 22 or later
64
+ - npm, pnpm, or yarn
65
+ - For hub onboarding: a GitHub account and (for CLI-assisted secret provisioning) a GitHub OAuth App. See [Installation](./docs/public/installation.md) for prerequisites per path.
66
+
74
67
  ## Links
75
68
 
76
- - [Documentation](https://github.com/marlinjai/clearify)
69
+ - [Documentation](https://docs.lumitra.co/clearify)
70
+ - [Hub Model](./docs/public/hub-model.md)
77
71
  - [GitHub](https://github.com/marlinjai/clearify)
78
72
  - [Changelog](./CHANGELOG.md)
79
73
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@marlinjai/clearify",
3
- "version": "1.14.2",
3
+ "version": "1.15.0",
4
4
  "description": "An open-source documentation site generator. Turn markdown into beautiful docs.",
5
5
  "type": "module",
6
6
  "bin": {
@@ -31,6 +31,7 @@
31
31
  "release": "semantic-release"
32
32
  },
33
33
  "dependencies": {
34
+ "@inquirer/password": "^5.0.11",
34
35
  "@mdx-js/react": "^3.1.1",
35
36
  "@mdx-js/rollup": "^3.1.1",
36
37
  "@scalar/openapi-parser": "^0.10.7",
@@ -44,6 +45,7 @@
44
45
  "flexsearch": "^0.8.212",
45
46
  "globby": "^16.1.0",
46
47
  "gray-matter": "^4.0.3",
48
+ "libsodium-wrappers": "^0.8.4",
47
49
  "mermaid": "^11.0.0",
48
50
  "postcss": "^8.5.6",
49
51
  "react-router-dom": "^7.13.0",