@marlinjai/clearify 1.11.0 → 1.11.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.
package/README.md
CHANGED
|
@@ -1,12 +1,3 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Clearify
|
|
3
|
-
summary: README for Clearify, an open-source documentation site generator that turns markdown into beautiful docs with zero config, MDX support, Mermaid diagrams, full-text search, OpenAPI rendering, and SSG with SEO.
|
|
4
|
-
category: documentation
|
|
5
|
-
tags: [clearify, documentation, mdx, vite, ssg]
|
|
6
|
-
status: active
|
|
7
|
-
date: 2026-02-07
|
|
8
|
-
---
|
|
9
|
-
|
|
10
1
|
# Clearify
|
|
11
2
|
|
|
12
3
|
An open-source documentation site generator. Turn markdown into beautiful docs.
|
|
@@ -245,11 +245,13 @@ When making changes to this project, keep the documentation in sync:
|
|
|
245
245
|
|
|
246
246
|
1. **Changelog** \u2014 After any user-facing change, add a bullet under \`## [Unreleased]\` in \`CHANGELOG.md\` using [Keep a Changelog](https://keepachangelog.com/) format (\`Added\`, \`Changed\`, \`Fixed\`, \`Removed\`).
|
|
247
247
|
|
|
248
|
-
2. **
|
|
248
|
+
2. **Roadmap** \u2014 When a planned feature is implemented, move it from \`Planned\` or \`In Progress\` to \`Completed\` in \`ROADMAP.md\`. When new work is decided, add it to \`Planned\`.
|
|
249
249
|
|
|
250
|
-
3. **
|
|
250
|
+
3. **Docs pages** \u2014 When a feature or behavior changes, update the relevant page in \`docs/public/\`. If a new feature has no page, create one.
|
|
251
|
+
|
|
252
|
+
4. **Config docs** \u2014 When config options are added or changed, update \`docs/public/configuration.md\` with the new option, type, default, and description.
|
|
251
253
|
${hasInternal ? `
|
|
252
|
-
|
|
254
|
+
5. **Architecture decisions** \u2014 For significant design decisions, add an entry to \`docs/internal/\` explaining the context, decision, and trade-offs.
|
|
253
255
|
` : ""}`;
|
|
254
256
|
writeFileSync(claudeRulesPath, rulesContent);
|
|
255
257
|
console.log(" Created .claude/rules/clearify-docs.md");
|
|
@@ -246,6 +246,12 @@ async function buildSite() {
|
|
|
246
246
|
alias: { "@clearify": resolve(root, "..") },
|
|
247
247
|
dedupe
|
|
248
248
|
},
|
|
249
|
+
ssr: {
|
|
250
|
+
// Bundle all deps into the SSR output so pre-rendering works in any
|
|
251
|
+
// host project, even if it doesn't have react/react-router installed.
|
|
252
|
+
// The SSR bundle is temporary and deleted after pre-rendering.
|
|
253
|
+
noExternal: true
|
|
254
|
+
},
|
|
249
255
|
build: {
|
|
250
256
|
outDir: ssrOutDir,
|
|
251
257
|
ssr: resolveClientPath("entry-server.tsx"),
|
package/dist/node/node/build.js
CHANGED
package/dist/node/node/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import {
|
|
2
2
|
buildSite
|
|
3
|
-
} from "../chunk-
|
|
3
|
+
} from "../chunk-EMM4VLF7.js";
|
|
4
4
|
import {
|
|
5
5
|
remarkMermaidToComponent
|
|
6
6
|
} from "../chunk-PRTER35L.js";
|
|
@@ -11,7 +11,7 @@ import {
|
|
|
11
11
|
import "../chunk-B2Q23JW3.js";
|
|
12
12
|
import {
|
|
13
13
|
init
|
|
14
|
-
} from "../chunk-
|
|
14
|
+
} from "../chunk-EKN6DWXT.js";
|
|
15
15
|
import {
|
|
16
16
|
checkFrontmatter,
|
|
17
17
|
checkLinks
|
package/dist/node/node/init.js
CHANGED