Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix in-app docs #13953

Merged
merged 2 commits into from Jun 17, 2022
Merged

Fix in-app docs #13953

merged 2 commits into from Jun 17, 2022

Conversation

azrikahar
Copy link
Contributor

Description

Problem

vite-plugin-md package was updated from 0.11.4 to 0.14.0 in #13845, but unfortunately it seems to break the in-app docs for Directus 9.12.2 now:

chrome_xAkAucE3X2

0.14.0 included one particular sizable change — antfu/vite-plugin-md#77, and I believe the 2 main reasons why it's broken on our end are:

Solution

  • Downgraded vite-plugin-md package to 0.13.1 temporarily while we await for the additional styling to be removed in a future version.

    Side note: regarding packages removed in the package-lock file after this downgrade, it's mostly because they were added in 0.14.0. They have since been removed in 0.14.2.

  • Opted to rename DocsWrapper to docs-wrapper, even if PascalCase still works in 0.13.1 as I believe it's more unlikely for kebab-case support to be removed in future versions based on my understanding in that thread.

Result

chrome_57qWxYyxbx

Type of Change

  • Bugfix
  • New Feature
  • Refactor / codestyle updates
  • Other, please describe:

Requirements Checklist

  • New / updated tests are included
  • All tests are passing locally
  • Performed a self-review of the submitted code

If adding a new feature:

  • Documentation was added/updated

@rijkvanzanten rijkvanzanten merged commit e48d9ae into main Jun 17, 2022
@rijkvanzanten rijkvanzanten deleted the fix/vite-plugin-md branch June 17, 2022 13:10
@rijkvanzanten rijkvanzanten added this to the v9-next milestone Jun 17, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants