Skip to content

feat(editor): check Markdown and render Mermaid previews - #228

Merged
Yuna-Celisse merged 1 commit into
mainfrom
codex/227-markdown-checker-mermaid
Oct 25, 2026
Merged

Yuna-Celisse merged 1 commit into
mainfrom
codex/227-markdown-checker-mermaid

Conversation

@Yuna-Celisse

@Yuna-Celisse Yuna-Celisse commented Oct 25, 2026 •

Copy link
Copy Markdown
Member

Summary

Closes #227.

  • Runs the repository's Markdownlint rules in the browser editor, including the archived-directory overrides.
  • Highlights affected editor lines and lists rule, line, and repair guidance before submit.
  • Rejects unclosed code fences/container blocks and validates Mermaid syntax before submitting.
  • Renders valid mermaid / mmd fenced blocks as SVG in the in-page preview and replaces invalid diagrams with an actionable error card.
  • Documents the new checker and Mermaid preview in the writing guide.

Scope

  • Tutorial
  • Process
  • Repair
  • Archived
  • Navigation
  • Assets or templates
  • CI or tooling
  • Governance docs

Checklist

  • I updated the relevant sidebar or confirmed no navigation change is needed.
  • I checked internal links and asset paths affected by this PR.
  • I kept historical archived content unchanged unless this PR is explicitly about archive maintenance.
  • I documented follow-up work that is intentionally outside this PR.

Verification

  • pnpm run ci:lint:markdown
  • pnpm run ci:lint:eslint
  • pnpm docs:build
  • Focused validation tests: 8 passed
  • Remaining non-Windows-sensitive suite: 157 passed
  • Browser-tested editor errors, inline highlights, valid Mermaid SVG, invalid Mermaid card, and archived config behavior

Notes

This Windows checkout has pre-existing line-ending-sensitive failures in utils/docs-api.test.ts and checks/site.test.ts; the full local run was 171 passed / 3 failed. ci:verify also reports 42 existing path-separator anchor mismatches on Windows. The individual lint commands and production build pass, and Linux CI remains the authoritative check.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying documents with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2f6f499
Status: ✅  Deploy successful!
Preview URL: https://7e592b15.documents-dq4.pages.dev
Branch Preview URL: https://codex-227-markdown-checker-m.documents-dq4.pages.dev

View logs

@Yuna-Celisse
Yuna-Celisse requested a review from m1ngsama October 25, 2026 11:07
@Yuna-Celisse
Yuna-Celisse merged commit 946eb9c into main Oct 25, 2026
5 checks passed
@Yuna-Celisse
Yuna-Celisse deleted the codex/227-markdown-checker-mermaid branch October 25, 2026 11:11
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.

feat: add Markdown syntax checker and Mermaid renderer

2 participants