style: fix markdown code style

[zzxming]

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

• Documentation

  • Updated documentation for Fluent Editor API
  • Refined method signatures for Quill class
  • Modified FluentEditor options interface
  • Updated documentation formatting for toolbar and module configurations

• Chores

  • Removed ESLint rule comments in framework usage examples
  • Updated ESLint configuration to disable no-new rule

[coderabbitai]

Walkthrough

This pull request encompasses documentation updates across multiple files in the Fluent Editor package. The changes primarily involve refining method signatures, updating interface definitions, and improving code formatting. The modifications focus on clarifying the structure of the Quill class methods, adjusting the FluentEditorOptions interface, and removing ESLint directive comments. The updates aim to enhance documentation clarity and consistency without fundamentally changing the underlying functionality.

Changes

File	Change Summary
eslint.config.mjs	Added 'no-new': 'off' rule to ESLint configuration
packages/docs/fluent-editor/docs/api/fluent-editor-class.md	Updated Quill class method signatures to include static keyword
packages/docs/fluent-editor/docs/api/fluent-editor-instance.md	Refined method signatures for getModule, getContents, and setContents
packages/docs/fluent-editor/docs/api/options.md	Changed property names in FluentEditorOptions to string-based keys
packages/docs/fluent-editor/docs/modules/header-list.md	Minor formatting improvements
packages/docs/fluent-editor/docs/modules/toolbar-tip.md	Replaced double quotes with single quotes, adjusted formatting
packages/docs/fluent-editor/docs/used-in-framework.md	Removed ESLint directive comments

Possibly related PRs

• feat: enable format with prettier in eslint #90: Modifies ESLint configuration
• chore: lint fix #126: Focuses on linting fixes
• feat: remove header-list and toolbar-tip internal dependencies #178: Discusses removal of internal dependencies related to toolbar-tip
• fix: toolbar-tip text doesn't display #187: Addresses tooltip text display bug
• refactor: simplify the fluent-editor.ts file, retaining only the logic related to module registration #193: Simplifies fluent-editor.ts file

Suggested labels

documentation

Suggested reviewers

• kagol

Poem

🐰 A Rabbit's Documentation Dance

With quotes and methods neatly aligned,
Our code now sings, so well-defined!
Static methods leap, interfaces gleam,
In Fluent Editor's documentation stream.
Hop, hop, hooray for clarity's might! 🎉

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e9b8d04 and 69b8073.

📒 Files selected for processing (7)

• eslint.config.mjs (1 hunks)
• packages/docs/fluent-editor/docs/api/fluent-editor-class.md (2 hunks)
• packages/docs/fluent-editor/docs/api/fluent-editor-instance.md (4 hunks)
• packages/docs/fluent-editor/docs/api/options.md (1 hunks)
• packages/docs/fluent-editor/docs/modules/header-list.md (3 hunks)
• packages/docs/fluent-editor/docs/modules/toolbar-tip.md (4 hunks)
• packages/docs/fluent-editor/docs/used-in-framework.md (0 hunks)

💤 Files with no reviewable changes (1)

• packages/docs/fluent-editor/docs/used-in-framework.md

✅ Files skipped from review due to trivial changes (1)

• packages/docs/fluent-editor/docs/modules/toolbar-tip.md

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: test

🔇 Additional comments (10)

packages/docs/fluent-editor/docs/api/fluent-editor-instance.md (3)

22-25: LGTM! Improved method signature clarity.

The updated format better illustrates that getModule is a method of the Quill class.

---

48-50: LGTM! Consistent method signature format.

The updated format for getContents maintains consistency with other method signatures.

---

72-74: LGTM! Consistent method signature format.

The updated format for setContents maintains consistency with other method signatures.

packages/docs/fluent-editor/docs/api/options.md (1)

24-24: LGTM! Consistent property name format.

Property names are now consistently formatted as string literals, which aligns with TypeScript's interface style guidelines.

Also applies to: 30-30, 33-33, 36-36

packages/docs/fluent-editor/docs/api/fluent-editor-class.md (2)

22-24: LGTM! Improved static method signature.

The updated format clearly indicates that import is a static method of the Quill class.

---

56-61: LGTM! Comprehensive method overload documentation.

The updated format clearly shows all overloads of the static register method, improving API documentation clarity.

packages/docs/fluent-editor/docs/modules/header-list.md (3)

26-27: LGTM! Added trailing comma.

Added trailing comma improves code consistency.

---

38-47: LGTM! Improved table formatting.

The table formatting is now more consistent and readable with proper alignment and spacing.

---

57-57: LGTM! Consistent toolbar configuration format.

The toolbar configuration follows a consistent format.

eslint.config.mjs (1)

50-50: LGTM! Verify removal of ESLint directives from markdown files.

The addition of 'no-new': 'off' is properly placed with other similar rule configurations.

Let's verify that the corresponding ESLint directives have been removed from markdown files:

✅ Verification successful

[^\n]\n[^`]*new\s+\w+[^`]```" -U

---

<!-- [monologue]
[task verification_final]
Analyze the search results and make a final determination.
[observations]
1. No eslint-disable directives found in markdown files
2. Found multiple instances of `new FluentEditor()` usage in markdown documentation:
   - Used in framework integration examples
   - API documentation
   - Quick start guides
   - README files
3. The usage of `new` operator is legitimate and necessary in these examples
[analysis]
1. The absence of eslint-disable directives suggests they were either:
   - Successfully removed after adding the 'no-new' rule
   - Never existed, and the rule was added proactively
2. The `new FluentEditor()` usage is:
   - Consistent across documentation
   - Required for proper initialization of the editor
   - Part of official API examples
3. The 'no-new' rule being disabled is justified because:
   - It's necessary for showing correct usage in documentation
   - The examples demonstrate the intended API usage
[actions]
1. Generate final response confirming the rule is necessary
2. Mark as verified since the change is justified by the codebase evidence
-->

**✓ The `no-new` rule disable is necessary for documentation**

The rule disable is justified as the codebase contains multiple legitimate uses of the `new` operator in markdown documentation, particularly for demonstrating the proper initialization of `FluentEditor` instances (e.g., `new FluentEditor('#editor', {...})`).



</details>

<details>
<summary>🏁 Scripts executed</summary>

The following scripts were executed for the analysis:

Script:

```shell
#!/bin/bash
# Description: Check for any remaining eslint-disable-next-line no-new comments in markdown files
rg -t md "eslint-disable.*no-new" 

Length of output: 35

---

Script:

#!/bin/bash
# Search for any eslint-disable directives in markdown files
echo "=== Checking for any eslint-disable directives in markdown files ==="
rg -t md "eslint-disable"

# Search for 'new' operator usage in markdown code blocks
echo -e "\n=== Checking for 'new' operator usage in markdown files ==="
rg -t md "

Length of output: 430

---

Script:

#!/bin/bash
# Search for 'new' operator usage in markdown files
echo "=== Checking for 'new' operator usage in markdown files ==="
rg -t md "new [A-Z]\w+" -A 1 -B 1

Length of output: 3967

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[petercat-assistant]

Walkthrough

This pull request focuses on fixing markdown code style across several documentation files and configuration files. It includes changes to code formatting, such as converting functions to class methods and adjusting quotes for consistency.

Changes

Files	Summary
eslint.config.mjs	Added 'no-new' rule to the ESLint configuration.
packages/docs/fluent-editor/docs/api/fluent-editor-class.md	Converted standalone functions to static class methods for Quill.
packages/docs/fluent-editor/docs/api/fluent-editor-instance.md	Converted standalone functions to class methods for Quill.
packages/docs/fluent-editor/docs/api/options.md	Adjusted quotes for consistency in object keys.
packages/docs/fluent-editor/docs/modules/header-list.md	Fixed trailing commas and adjusted table formatting.
packages/docs/fluent-editor/docs/modules/toolbar-tip.md	Changed double quotes to single quotes and adjusted trailing commas.
packages/docs/fluent-editor/docs/used-in-framework.md	Removed ESLint directive comments and adjusted code formatting.

🪧 Tips

For further assistance, please describe your question in the comments and @petercat-assistant to start a conversation with me.