diff --git a/.claude-plugin/marketplace.json b/.claude-plugin/marketplace.json new file mode 100644 index 0000000..c85a4f0 --- /dev/null +++ b/.claude-plugin/marketplace.json @@ -0,0 +1,20 @@ +{ + "name": "inkform-framework", + "owner": { + "name": "Inkform", + "url": "https://github.com/inkform-dev" + }, + "plugins": [ + { + "name": "inkform-framework", + "source": "./", + "description": "Add MDX-powered docs, a blog, or a changelog to a Next.js site with @inkform/framework.", + "author": { + "name": "Inkform" + }, + "repository": "https://github.com/inkform-dev/framework", + "license": "MIT", + "keywords": ["inkform", "mdx", "nextjs", "docs", "blog", "changelog", "openapi"] + } + ] +} diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json new file mode 100644 index 0000000..88ee5e1 --- /dev/null +++ b/.claude-plugin/plugin.json @@ -0,0 +1,12 @@ +{ + "name": "inkform-framework", + "version": "0.1.0", + "description": "Add MDX-powered docs, a blog, or a changelog to a Next.js site with @inkform/framework.", + "author": { + "name": "Inkform", + "url": "https://github.com/inkform-dev" + }, + "repository": "https://github.com/inkform-dev/framework", + "license": "MIT", + "keywords": ["inkform", "mdx", "nextjs", "docs", "blog", "changelog", "openapi"] +} diff --git a/examples/inkform-docs/content/docs/docs.json b/examples/inkform-docs/content/docs/docs.json index 0a281d3..a6999e7 100644 --- a/examples/inkform-docs/content/docs/docs.json +++ b/examples/inkform-docs/content/docs/docs.json @@ -35,7 +35,8 @@ { "title": "Add a Blog to an Existing Site", "slug": "guides/blog-in-existing-site", "file": "guides/blog-in-existing-site.mdx", "icon": "layers" }, { "title": "Changelog", "slug": "guides/changelog", "file": "guides/changelog.mdx", "icon": "map" }, { "title": "Widgets", "slug": "guides/widgets", "file": "guides/widgets.mdx", "icon": "blocks" }, - { "title": "Comments, Reactions & Subscribe Forms", "slug": "guides/interactive", "file": "guides/interactive.mdx", "icon": "heart" } + { "title": "Comments, Reactions & Subscribe Forms", "slug": "guides/interactive", "file": "guides/interactive.mdx", "icon": "heart" }, + { "title": "Claude Code Skill", "slug": "guides/claude-code-skill", "file": "guides/claude-code-skill.mdx", "icon": "sparkles" } ] }, { diff --git a/examples/inkform-docs/content/docs/guides/claude-code-skill.mdx b/examples/inkform-docs/content/docs/guides/claude-code-skill.mdx new file mode 100644 index 0000000..fc64594 --- /dev/null +++ b/examples/inkform-docs/content/docs/guides/claude-code-skill.mdx @@ -0,0 +1,65 @@ +--- +title: Claude Code Skill +description: Let Claude Code add the framework to a site for you, and open the PR. +--- + +# Claude Code skill + +If you're integrating the framework across several sites, there's an agent skill that does +the work: it picks the right approach, wires the pages, verifies the build, and opens a PR. + +It's a plain markdown file — [`skills/inkform-framework/SKILL.md`](https://github.com/inkform-dev/framework/blob/main/skills/inkform-framework/SKILL.md) +in the repo. Nothing is hidden in it, and you can read the whole thing in a couple of minutes. + +## Install + +Three ways, pick whichever fits. + +**As a plugin** — one command, then it's available in every repo: + +``` +/plugin marketplace add inkform-dev/framework +/plugin install inkform-framework@inkform-framework +``` + +**As a copied file** — for you everywhere, or committed to one repo for the team: + +```bash +mkdir -p ~/.claude/skills/inkform-framework +curl -o ~/.claude/skills/inkform-framework/SKILL.md \ + https://raw.githubusercontent.com/inkform-dev/framework/main/skills/inkform-framework/SKILL.md +``` + +**Not at all** — just point Claude at these docs in a prompt: + +``` +Add a blog to this Next.js site following +https://framework.inkform.dev/guides/blog-in-existing-site — then open a PR. +``` + +## Using it + +Ask for the outcome; the skill triggers on its own: + +``` +Add an MDX blog to this site at /blog and open a PR. +``` + +## What it knows that a link doesn't + +The published guides tell you how it works. The skill additionally carries the things that +go wrong: + +- `transpilePackages: ['@inkform/framework']` is mandatory — the package ships TS/JSX source, + and omitting it causes most "unexpected token" build failures. +- The framework needs **Next ≥ 16** and **React 19**. On an older site the skill stops and + says so, rather than quietly bumping a major version inside a content PR. +- Adding a blog to an existing site should not transplant the docs shell over that site's + own layout and design system. +- Every docs page must be registered in `docs.json` — a file on disk that isn't listed + won't route. + + + Newsletter signup forms and the hosted platform API are a separate skill in the platform + repo: `/plugin marketplace add inkform-dev/cms`. + diff --git a/skills/README.md b/skills/README.md new file mode 100644 index 0000000..0fdbadb --- /dev/null +++ b/skills/README.md @@ -0,0 +1,58 @@ +# Inkform framework skills for Claude Code + +Agent skills that teach Claude Code how to work with `@inkform/framework`. Point Claude at +one and it does the integration and opens the PR. + +| Skill | What it does | +|---|---| +| [`inkform-framework`](./inkform-framework/SKILL.md) | Adds MDX docs, a blog, or a changelog to a Next.js site — scaffolding a new site, or bolting onto an existing one without touching its layout. | + +## Install + +### Option 1 — install the plugin (one command) + +``` +/plugin marketplace add inkform-dev/framework +/plugin install inkform-framework@inkform-framework +``` + +Loads automatically in any repo from then on. Update with +`/plugin marketplace update inkform-framework`. + +### Option 2 — copy the markdown + +`SKILL.md` is self-contained. Drop it in either location: + +```bash +# just you, every project +mkdir -p ~/.claude/skills/inkform-framework +curl -o ~/.claude/skills/inkform-framework/SKILL.md \ + https://raw.githubusercontent.com/inkform-dev/framework/main/skills/inkform-framework/SKILL.md + +# or commit it to one repo, for everyone working in it +mkdir -p .claude/skills/inkform-framework +``` + +### Option 3 — just link the docs + +No install: + +``` +Add a blog to this Next.js site following +https://framework.inkform.dev/guides/blog-in-existing-site — then open a PR. +``` + +The skill is worth installing when you're doing this across several sites: it also carries +the failure modes — the `transpilePackages` requirement, the Next ≥ 16 / React 19 floor, and +not transplanting the docs shell onto someone's existing site. + +## Using it + +``` +Add an MDX blog to this site at /blog and open a PR. +``` + +## Related + +Newsletter signup forms and the hosted platform API live in the platform repo's skill: +`/plugin marketplace add inkform-dev/cms`. diff --git a/skills/inkform-framework/SKILL.md b/skills/inkform-framework/SKILL.md new file mode 100644 index 0000000..ae71cf0 --- /dev/null +++ b/skills/inkform-framework/SKILL.md @@ -0,0 +1,199 @@ +--- +name: inkform-framework +description: Add MDX-powered docs, a blog, or a changelog to a Next.js site using @inkform/framework, then open a PR. Use when someone wants to add a blog or docs section to an existing Next.js app, scaffold a documentation site, render MDX content with frontmatter, build an API reference from an OpenAPI spec, or migrate markdown content into a site — e.g. "add a blog to this site", "set up docs for this project", "render these MDX files", or when pointed at framework.inkform.dev. +metadata: + docs: + - "https://framework.inkform.dev/getting-started/quickstart" + - "https://framework.inkform.dev/guides/blog-in-existing-site" + - "https://framework.inkform.dev/reference/framework-api" + pathPatterns: + - "next.config.*" + - "content/**/*.mdx" + - "content/**/docs.json" +--- + +# Add @inkform/framework to a Next.js site + +`@inkform/framework` is a standalone Next.js + MDX renderer for docs, blogs, changelogs, and +OpenAPI reference. No account, no database, no platform dependency — content is MDX files in +the repo, read at build time. + +## First, decide which job this is + +| Situation | Do this | +|---|---| +| Greenfield — a whole new docs site | Scaffold with the CLI (§A) | +| Existing Next.js site, wants `/blog` or `/docs` added | Bolt on the two standalone pieces (§B) | + +Getting this wrong is the main way this goes badly: **do not drop the full docs shell into +someone's existing marketing site.** They asked for a blog, not a theme transplant. §B keeps +their layout, header, footer, and design system untouched. + +## Requirements — check before promising anything + +```bash +grep -E '"next"|"react"' package.json +``` + +The framework peer-depends on **Next ≥ 16** and **React ≥ 19**. If the site is on Next 15 or +older, stop and tell the user plainly: this needs a Next major upgrade first, which is a +separate piece of work with its own risk. Do **not** quietly bump their Next major as a side +effect of "add a blog" — that is a large change they didn't ask for and can't easily review +inside a content PR. + +## §A — Scaffold a new site + +```bash +npx @inkform/cli@latest init my-docs --theme galley +cd my-docs && npm install && npm run dev +``` + +Themes: Aurora, Fern, Cedar, Mono, Base, Galley. Add `--openapi ` to generate an +API Reference tab from a spec. The CLI is non-destructive — pointed at a non-empty directory +it moves existing contents into `existing-contents/` rather than overwriting. + +Pin `@inkform/framework` to `^0.3.0` or later. Earlier `^0.2.x` ranges were never published +and fail `npm install` with `ETARGET`. + +## §B — Bolt onto an existing site + +Two standalone pieces, nothing else: + +- `@inkform/framework/content` — reads `content/blog/*.mdx` (frontmatter + body) at build time +- `@inkform/framework/mdx` — renders an MDX body to React, with syntax highlighting and the + built-in blocks (``, ``, ``, ``, ``, ``) + +Skip `DocsShell`, the sidebar, search, and theme tokens — that's the full-docs-site layer. + +### 1. Install and transpile + +```bash +npm install @inkform/framework +``` + +**Merge** into the existing `next.config.ts` — don't replace the file: + +```ts +const nextConfig: NextConfig = { + // ...whatever is already here + transpilePackages: ['@inkform/framework'], +}; +``` + +The package ships TS/JSX source rather than compiled output, so Next has to transpile it. +Skipping this is the cause of most "unexpected token" build failures. + +### 2. Content + +MDX with frontmatter under `content/blog/`: + +```mdx +--- +title: Hello World +date: 2026-09-05 +description: What this post is about. +tags: [engineering] +--- + +Body starts here. +``` + +### 3. Pages that match the host site + +Write these in the site's **own** layout and components. The point is that a reader can't tell +the blog was bolted on. + +```tsx +// app/blog/page.tsx +import Link from 'next/link'; +import { loadBlogPosts } from '@inkform/framework/content'; + +export default async function BlogIndex() { + const posts = await loadBlogPosts(); + return ( +
    + {posts.map((post) => ( +
  • + {post.title} + +
    • + ))} +
+ ); +} +``` + +```tsx +// app/blog/[slug]/page.tsx +import { notFound } from 'next/navigation'; +import { Mdx } from '@inkform/framework/mdx'; +import { loadBlogPost } from '@inkform/framework/content'; + +export default async function Post({ params }: { params: Promise<{ slug: string }> }) { + const { slug } = await params; + const post = await loadBlogPost(slug); + if (!post) notFound(); + return ( +
+

{post.title}

+ +
+ ); +} +``` + +Import `@inkform/framework/styles.css` only if you want the framework's content styling. On a +site with its own design system, prefer styling the output yourself. + +### Docs sites use `docs.json` + +For a docs section, navigation is declared in `content/docs/docs.json`, independent of where +files sit on disk: + +```jsonc +{ + "name": "My Docs", + "navigation": [ + { + "group": "Get Started", + "pages": [{ "title": "Introduction", "slug": "introduction", "file": "introduction.mdx" }] + } + ] +} +``` + +Rename a slug and the framework 301-redirects the old URL, so published links keep working. +Every page must be registered here — a file on disk that isn't in `docs.json` won't route. + +## Verify before opening the PR + +```bash +npx tsc --noEmit +npm run build +``` + +Both must pass, and the new routes must appear in the build's route list. If the build +rewrites `tsconfig.json` as a side effect, revert it — unrelated churn doesn't belong in the +PR. Check `git status` and stage deliberately; don't sweep up lockfile noise you didn't mean +to change. + +## Open the PR + +Branch off the repo's default branch, and confirm the remote is the repo the team actually +uses (`git remote -v`, `gh repo view --json owner,name`) — a stale clone can point at a +renamed repo or a fork. + +State in the PR body: what routes were added, that the site's own layout is untouched, the +Next/React requirement, and anything the reviewer must do (add content, set a nav entry). + +## Things to get right + +- **`transpilePackages` is not optional.** Omitting it is the single most common failure. +- **Don't replace `next.config.ts`** — merge the one key in. +- **Don't adopt the docs shell on an existing site** unless the user asked for a docs site. +- **Content is build-time.** New posts need a rebuild (or ISR) to appear — don't describe it + as live-editable, and don't reach for the platform API unless the content genuinely lives + in a different repo. +- **The framework is standalone.** It needs no Inkform account. If someone wants the hosted + editor, subscribers, or newsletter on top, that's the platform — see + `docs.inkform.dev`, and the `inkform-newsletter` skill for signup forms.