docs: add counter docs

[kagol]

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our Commit Message Guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

• New Features

  • Added a "Character Count" menu item in the sidebar for quick access to documentation.
  • Introduced new Vue components for character counting functionality within the editor.
  • Added comprehensive documentation for the character counting feature, including usage examples and configuration options.

• Bug Fixes

  • Improved clarity and consistency in test file formatting and variable naming.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a character counting feature to the editor by adding a new entry in the sidebar and creating Vue components for the functionality. It includes comprehensive documentation for the character counting feature and updates to existing test files for consistency. The changes enhance the editor's capabilities, providing users with a real-time character count and improving overall navigation within the documentation.

Changes

File Path	Change Summary
packages/docs/fluent-editor/.vitepress/sidebar.ts	Added sidebar entry for "字符统计" linking to '/docs/counter'.
packages/docs/fluent-editor/demos/counter-count.vue	Introduced a Vue component for character counting, integrating FluentEditor with SSR compatibility.
packages/docs/fluent-editor/demos/counter.vue	Added another Vue component for character counting with FluentEditor, utilizing <script setup>.
packages/docs/fluent-editor/demos/image-upload.spec.ts	Updated syntax and variable names for clarity, maintaining existing test logic.
packages/docs/fluent-editor/docs/counter.md	Created documentation for the character counting feature, detailing configuration options and usage.

Possibly related PRs

• test: add image-upload e2e-test #50: Introduces automated testing for the image upload functionality, relevant to the character counting feature.
• fix: toolbar style update and ts error #51: Focuses on fixing styling issues in the toolbar, which may relate to overall user interface improvements.

🐰 In the meadow, a change took flight,
With a counter for characters, oh what a sight!
A sidebar entry, so neat and bright,
Helping users count, day and night.
Hopping along, with joy we share,
A feature so fine, beyond compare! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.