Skip to content

Commit 8d37b31

Browse files
xuyushun441-sysos-zhuangclaude
authored
fix(ADR-0046): enable Tailwind typography so Markdown docs render styled (#1687)
plugin-markdown's MarkdownImpl renders Markdown inside `prose prose-h1:text-3xl prose-h2:text-2xl …`, but the console never registered @tailwindcss/typography — so every `prose` utility was a no-op. Result: the /docs/<name> viewer rendered its `# Heading` at body text size with no list markers or spacing (looked unstyled / "title not showing"). Register the plugin in index.css (`@plugin '@tailwindcss/typography'`) and add the devDependency. Verified live: doc h1 now renders 30px/600 (was body-sized), paragraphs/inline-code/links styled with proper hierarchy. Co-authored-by: Jack Zhuang <277994282+os-zhuang@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 893e530 commit 8d37b31

4 files changed

Lines changed: 47 additions & 9 deletions

File tree

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
"@object-ui/console": patch
3+
---
4+
5+
fix(ADR-0046): enable Tailwind typography so Markdown docs render styled.
6+
7+
`plugin-markdown`'s `MarkdownImpl` renders inside `prose prose-h1:text-3xl …`,
8+
but the console never registered `@tailwindcss/typography`, so every `prose`
9+
utility was a no-op — Markdown rendered with no heading sizes, list markers, or
10+
spacing (the `/docs/<name>` page showed its `# Title` at body size, looking
11+
unstyled). Register the plugin (`@plugin '@tailwindcss/typography'`) and add the
12+
dependency. Now doc headings, paragraphs, inline code, and links render with
13+
proper hierarchy.

apps/console/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@
8989
"@objectstack/client": "^9.0.0",
9090
"@objectstack/spec": "^9.1.0",
9191
"@tailwindcss/postcss": "^4.3.0",
92+
"@tailwindcss/typography": "^0.5.20",
9293
"@testing-library/jest-dom": "^6.9.1",
9394
"@testing-library/react": "^16.3.2",
9495
"@testing-library/user-event": "^14.6.1",

apps/console/src/index.css

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
@import 'tailwindcss';
22
@import '@object-ui/app-shell/styles.css';
33

4+
/* Typography plugin — generates the `prose` utilities. plugin-markdown's
5+
MarkdownImpl renders docs/markdown inside `prose prose-h1:text-3xl …`;
6+
without this plugin those classes are no-ops and Markdown renders with
7+
NO heading sizes, list markers, or spacing (ADR-0046 docs looked unstyled
8+
— headings indistinguishable from body text). */
9+
@plugin '@tailwindcss/typography';
10+
411
/* Scan sources for Tailwind classes */
512
@source '../src/**/*.{ts,tsx}';
613
@source '../../../packages/app-shell/src/**/*.{ts,tsx}';

pnpm-lock.yaml

Lines changed: 26 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)