Skip to content

docs: Inkdrop v6 — guides, components & pnpm migration#40

Merged
craftzdog merged 12 commits into
mainfrom
v6
Jun 19, 2026
Merged

docs: Inkdrop v6 — guides, components & pnpm migration#40
craftzdog merged 12 commits into
mainfrom
v6

Conversation

@craftzdog

@craftzdog craftzdog commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Overview

Updates the developer documentation for Inkdrop v6: new primitive UI components, refreshed plugin/theme guides for the v6 APIs, an expanded command reference, a thorough v5→v6 theme migration guide, and the toolchain migration from npm to pnpm.

What's included

v6 API & guide updates

  • Plugin development guide — updated plugin-word-count walkthrough for v6
  • Theme guidecreate-a-theme updated for v6
  • Command reference — substantially expanded list-of-commands (+779 lines)

Migration guide (v5 → v6)

  • Explains the new plugin APIs and fixes a broken URL
  • UI themes — v6 design tokens (--hsl-* / --color-* ramps), recoloring by overriding the ramps in tokens.css, overriding the built-in component variables, and generating palette.json
  • Preview themes — base styles are now embedded in @inkdropapp/css, so themes override --mde-preview-* variables instead of shipping a forked github-markdown stylesheet (manifest cleanup, variables reference table, frame-vs-tokens split with syntax themes)
  • Syntax themes — CM5 → CM6 / Lezer migration

New component docs

  • Added primitive component pages: button, command-button, modal, notebook-list-bar; expanded dialog
  • Wired the new pages into Navigation.tsx
  • Updated component-manager module usage

Toolchain

  • Migrated package manager npm → pnpm (pnpm v11), enabled corepack, and pinned the package manager for deploys

Fixes

  • fix(typography): external links render as inline-flex, so a bare <a> as the sole element child of a tight list item matched both *:first-child and *:last-child and picked up 1.25rem top+bottom margin, blowing the item open. Excluded anchors via :not(a); loose lists (content wrapped in <p>) are unaffected.

Test plan

  • pnpm install resolves cleanly from pnpm-lock.yaml
  • pnpm build succeeds (static export, no MDX compile errors)
  • New component pages render and appear in the sidebar navigation
  • ⌘K search indexes the new pages
  • Migration guide renders: UI / preview / syntax theme sections, code samples, and the --mde-preview-* variables table
  • Spot-check the typography fix: list items with external links no longer have oversized vertical gaps; loose multi-paragraph lists keep their spacing
  • Migration / theme / plugin guides read correctly against the v6 APIs

craftzdog added 11 commits May 26, 2026 13:57
# Conflicts:
#	pnpm-lock.yaml
#	src/app/appendix/plugin-migration-from-v5-to-v6/page.mdx
#	vercel.json
External links render as inline-flex, so a bare <a> as the sole element
child of a tight list item matched both *:first-child and *:last-child,
picking up 1.25rem top+bottom margin and blowing the item open. Exclude
anchors with :not(a); loose lists (content wrapped in <p>) are unaffected.
@vercel

vercel Bot commented Jun 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
api-docs Ready Ready Preview, Comment Jun 19, 2026 7:53am

Request Review

Document migrating UI themes (v6 design tokens, overriding the --hsl-*
ramps in tokens.css, generating palette.json) and preview themes (base
styles now embedded in @inkdropapp/css; override --mde-preview-* variables
instead of shipping a forked github-markdown stylesheet) from v5 to v6.
@craftzdog craftzdog merged commit f3829e0 into main Jun 19, 2026
3 checks passed
@craftzdog craftzdog deleted the v6 branch June 19, 2026 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant