add include component

[ninedev-i]

Добавил компонент инклюд

Summary by CodeRabbit

• New Features

  • Added a new component Include.vue for dynamically rendering content from specified paths
  • Introduced a new syntax for including Markdown files within a locale

• Documentation

  • Updated documentation with details about the new content inclusion mechanism

[coderabbitai]

Walkthrough

This pull request introduces a new mechanism for including external Markdown content within a document. A new Vue component Include.vue has been developed with an asynchronous data fetching method using useAsyncData to retrieve content based on a specified path. Simultaneously, documentation in components.md has been updated to explain the new :include syntax for integrating Markdown files within a locale.

Changes

File	Change Summary
components/content/Include.vue	Added <script setup> with TypeScript, defined path prop, implemented async content fetching using useAsyncData and queryContent
doc/components.md	Added new section "Инклюд" describing :include{path="..."} syntax for including Markdown files within a locale

Sequence Diagram

sequenceDiagram
    participant User
    participant Include.vue
    participant ContentRenderer
    participant queryContent

    User->>Include.vue: Provide path prop
    Include.vue->>queryContent: Request content for path
    queryContent-->>Include.vue: Return content data
    Include.vue->>ContentRenderer: Render fetched content

Loading

Possibly related PRs

• Bugfix/subtitle localization #106: Localization and internationalization changes that might interact with content inclusion mechanism

Suggested reviewers

• lostpoint-ru

Poem

🐰 A rabbit's tale of content's grace,
Markdown files find their special place
With paths so neat and syntax bright
Inclusion becomes a pure delight!
Hop, hop, hooray for modular might! 📄✨

---

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.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

doc/components.md (1)

7-12: Enhance documentation with more details and examples.

The documentation could be more comprehensive. Consider adding:

1. Purpose and use cases for the include component
2. Limitations or restrictions (if any)
3. Multiple examples showing different scenarios
4. Language specification for the code block (as flagged by markdownlint)

Here's a suggested improvement:

 ## Инклюд
 
-```
+Компонент для включения содержимого других Markdown файлов в текущий документ.
+
+### Использование
+
+```md
 :include{path="Путь до md файла внутри локали (например "/_integrators/abrom"}

+### Примеры
+
+1. Включение файла из той же директории:
+md +:include{path="./installation.md"} +
+
+2. Включение файла из другой локали:
+md +:include{path="/_integrators/setup.md"} +

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 Markdownlint (0.37.0)</summary>

9-9: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

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

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 4f23f7229e3752dd1676967cb3dc9aeb9ea05603 and 77286d1636e137bbb2e1f84aed5efd1d75999168.

</details>

<details>
<summary>📒 Files selected for processing (2)</summary>

* `components/content/Include.vue` (1 hunks)
* `doc/components.md` (1 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>🪛 Markdownlint (0.37.0)</summary>

<details>
<summary>doc/components.md</summary>

9-9: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

</details>

<details>
<summary>⏰ Context from checks skipped due to timeout of 90000ms (1)</summary>

* GitHub Check: Codacy Static Code Analysis

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->