Skip to content

docs(style-presets): add custom style guides - #17

Open
cycleccc wants to merge 1 commit into
mainfrom
docs/style-presets
Open

docs(style-presets): add custom style guides#17
cycleccc wants to merge 1 commit into
mainfrom
docs/style-presets

Conversation

@cycleccc

@cycleccc cycleccc commented Jul 19, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • add Chinese and English guides for semantic custom style presets
  • document installation, registration, toolbar configuration, business CSS, HTML output, commands, and compatibility
  • add both guides to the VitePress sidebars and AI full-document generation order
  • correct the old content guide claim that generated HTML never contains inline styles
  • link the native custom styles demo

Depends on wangeditor-next/wangEditor-next#943.

Verification

  • pnpm install --frozen-lockfile passed
  • pnpm docs:gen-full regenerated both AI full-document files
  • pnpm docs:build passed, including Chinese and English style preset routes
  • git diff --check passed

Risk and rollback

This PR changes documentation and generated documentation only. Reverting the single commit restores the previous sidebar and content pages.

Summary by CodeRabbit

  • Documentation
    • Added English and Chinese guides for Custom Style Presets, including setup, configuration, persistence, HTML import, styling, and command usage.
    • Updated custom-style guidance to clarify HTML output, required editor and application CSS, and semantic preset recommendations.
    • Added Custom Style Presets to both language navigation sidebars.
    • Regenerated full documentation outputs with the new guide and updated section numbering.

Document setup, semantic CSS, HTML round trips, compatibility, and the native demo in Chinese and English.
@cursor

cursor Bot commented Jul 19, 2026

Copy link
Copy Markdown

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

@changeset-bot

changeset-bot Bot commented Jul 19, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: b1e21b3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Jul 19, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d2bfeb04-cdbe-4283-be16-38b051486983

📥 Commits

Reviewing files that changed from the base of the PR and between bb4f0fd and b1e21b3.

📒 Files selected for processing (9)
  • docs/.vitepress/config/en.ts
  • docs/.vitepress/config/zh.ts
  • docs/en/guide/content.md
  • docs/en/guide/style-presets.md
  • docs/public/ai/en-guide-full.txt
  • docs/public/ai/zh-guide-full.txt
  • docs/zh/guide/content.md
  • docs/zh/guide/style-presets.md
  • scripts/generate-full-docs.mjs

📝 Walkthrough

Walkthrough

This documentation change adds custom style preset guides in English and Chinese, updates HTML styling guidance, exposes the guides in both sidebars, and regenerates full-document outputs with the new section and adjusted numbering.

Changes

Custom Style Presets Documentation

Layer / File(s) Summary
Preset guide content
docs/en/guide/style-presets.md, docs/zh/guide/style-presets.md, docs/*/guide/content.md
Documents preset registration, configuration, CSS classes, persistence, HTML restoration, command APIs, compatibility, and revised getHtml() styling behavior.
Navigation and document ordering
docs/.vitepress/config/*.ts, scripts/generate-full-docs.mjs
Adds the guide to both language sidebars and includes it in generated guide ordering.
Generated full-doc bundles
docs/public/ai/*-guide-full.txt
Regenerates English and Chinese full documentation with the new guide, updated content guidance, timestamps, and re-numbered sections.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding custom style preset documentation and related docs updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/style-presets

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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