search

enzonotario / vitepress-openapi

Generate VitePress API Docs from OpenAPI specifications
https://vitepress-openapi.vercel.app
MIT License
36 stars 8 forks source link

feat(useTheme): allows to configure heading levels #48

Closed enzonotario closed 2 weeks ago

enzonotario commented 2 weeks ago

Closes #37

Summary by CodeRabbit

vercel[bot] commented 2 weeks ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
vitepress-theme-openapi ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 18, 2024 2:44am
coderabbitai[bot] commented 2 weeks ago

[!WARNING]

Rate limit exceeded

@enzonotario has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 54 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 9f287a4eef17a31a4175a2372a6df341b4820219 and d951ac7fc33e2f2789eee4e309236d11317ee22a.

Walkthrough

Los cambios introducidos en esta solicitud de extracción mejoran las opciones de configuración disponibles para los niveles de encabezado en la aplicación. Se agregó un método setHeadingLevels en el objeto themeConfig, permitiendo a los usuarios definir niveles de encabezado personalizados para etiquetas HTML de h1 a h6. Además, se realizaron modificaciones en el componente OAHeading.vue para que ajuste dinámicamente el nivel de encabezado según la configuración del tema. También se introdujo una nueva interfaz y funciones en useTheme.ts para gestionar estos niveles de encabezado de manera más estructurada.

Changes

Archivos Resumen de cambios
docs/guide/getting-started.md Se agregó themeConfig.setHeadingLevels({ h1: 1, h2: 3, h3: 4, h4: 4, h5: 4, h6: 4 }).
src/components/Common/OAHeading.vue Se integró useTheme para ajustar dinámicamente el nivel de encabezado basado en la configuración del tema. Se agregó la propiedad computada hLevel para obtener el nivel de encabezado.
src/composables/useTheme.ts Se definió la interfaz HeadingLevels y se añadieron funciones para obtener y establecer niveles de encabezado.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ThemeConfig
    participant OAHeading

    User->>ThemeConfig: setHeadingLevels({ h1: 1, h2: 3, h3: 4, h4: 4, h5: 4, h6: 4 })
    ThemeConfig->>OAHeading: getHeadingLevel(level)
    OAHeading->>User: Render heading with adjusted level

Assessment against linked issues

Objetivo Abordado Explicación
Permitir elegir niveles de encabezado (37) ✅

Possibly related PRs

Suggested reviewers

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , 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 generate interesting stats about this repository and render them as a table.` -- `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Early access features: enabled We are currently testing the following features in early access: - **OpenAI `o1` for code reviews**: OpenAI's new `o1` model is being tested for code reviews. This model has advanced reasoning capabilities and can provide more detailed feedback on your code. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues on the [discussion post](https://discordapp.com/channels/1134356397673414807/1279579842131787838).
pkg-pr-new[bot] commented 2 weeks ago

Open in Stackblitz

pnpm add https://pkg.pr.new/vitepress-theme-openapi@48
pnpm add https://pkg.pr.new/vitepress-theme-openapi@48

commit: d951ac7

addshore commented 2 weeks ago

LGTM!