docs: add projects

[kagol]

PR

增加 projects 子包，用来呈现使用 TinyEditor 做出来的富文本产品。

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

Release Notes

• New Features

  • Added a new Vue 3 project with TypeScript and Vite support.
  • Implemented routing with home and YuQue views.
  • Integrated Fluent Editor component.
  • Introduced a NotFound component for handling unmatched routes.
  • Added a README section outlining the Vue 3 + TypeScript + Vite template.

• Development

  • Configured build and deployment workflows to monitor project changes.
  • Added new scripts for project development and building.
  • Set up recommended VS Code extensions for enhanced development experience.
  • Introduced TypeScript configuration files for improved type checking.

• Infrastructure

  • Created project structure with standard configuration files.
  • Added .gitignore for improved repository management.
  • Established a Vite configuration for streamlined asset management.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a comprehensive setup for a new Vue 3 + TypeScript + Vite project within the packages/projects directory. The changes include creating a complete project structure with configuration files, source code, and workflow modifications. The GitHub Actions workflow is updated to include building the projects, and new scripts are added to the root package.json to support project-specific development and build commands.

Changes

File	Change Summary
.github/workflows/auto-deploy.yml	Added path trigger for packages/projects/** and new build step for projects
package.json	Added scripts dev:projects and build:projects
packages/projects/.gitignore	Created new .gitignore for project directory
packages/projects/.vscode/extensions.json	Added Vue Volar extension recommendation
packages/projects/README.md	Added section about Vue 3 + TypeScript + Vite template
packages/projects/index.html	Created new entry point HTML file
packages/projects/package.json	Added project-specific package configuration
packages/projects/src/*	Added Vue components, views, and configuration files

Sequence Diagram

sequenceDiagram
    participant User
    participant Workflow
    participant Build
    participant Deploy

    User->>Workflow: Push changes to packages/projects
    Workflow->>Build: Trigger build process
    Build->>Build: Run pnpm build:projects
    Build-->>Deploy: Generate build artifacts
    Deploy->>Deploy: Prepare for deployment

Loading

Possibly related PRs

• docs(projects): optimize imitate yuque #218: Changes to package.json in this PR involve adding new scripts for building projects
• docs(projects): optimize yuque project #219: Modifications in YuQue.vue include enhancements to the text editor's functionality

Poem

🐰 A Vue project springs to life,
With TypeScript and Vite so rife,
Workflows dance, scripts take flight,
Coding magic, pure delight!
Hop, hop, hooray for dev's new 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 f69a142 and d8f4eeb.

⛔ Files ignored due to path filters (3)

• packages/projects/public/vite.svg is excluded by !**/*.svg
• packages/projects/src/assets/vue.svg is excluded by !**/*.svg
• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (18)

• .github/workflows/auto-deploy.yml (2 hunks)
• package.json (1 hunks)
• packages/projects/.gitignore (1 hunks)
• packages/projects/.vscode/extensions.json (1 hunks)
• packages/projects/README.md (1 hunks)
• packages/projects/index.html (1 hunks)
• packages/projects/package.json (1 hunks)
• packages/projects/src/App.vue (1 hunks)
• packages/projects/src/components/NotFound.vue (1 hunks)
• packages/projects/src/main.ts (1 hunks)
• packages/projects/src/style.css (1 hunks)
• packages/projects/src/views/home/Home.vue (1 hunks)
• packages/projects/src/views/yuque/YuQue.vue (1 hunks)
• packages/projects/src/vite-env.d.ts (1 hunks)
• packages/projects/tsconfig.app.json (1 hunks)
• packages/projects/tsconfig.json (1 hunks)
• packages/projects/tsconfig.node.json (1 hunks)
• packages/projects/vite.config.ts (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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.