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(docs): Correct all occurrences of toml code blocks #3713

Merged
merged 7 commits into from
Nov 8, 2024

Conversation

vivekjain23
Copy link
Contributor

@vivekjain23 vivekjain23 commented Oct 28, 2024

Description of change

Fixing all occurrences of toml code blocks by swizzling the prism-include-languages.js component and adding a custom prism-toml.js component to it.

Links to any relevant issues

fixes #1947

Type of change

  • Documentation Fix

How the change has been tested

Changes were built locally.

Change checklist

Tick the boxes that are relevant to your changes, and delete any items that are not.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that new and existing unit tests pass locally with my changes

@vivekjain23 vivekjain23 added dx-improvement Mainly for DX team itself to track issues with features/fixes that improve dx. devx Issues related to the DevX team labels Oct 28, 2024
@vivekjain23 vivekjain23 requested a review from a team as a code owner October 28, 2024 13:00
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 28, 2024
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

@lucas-tortora lucas-tortora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The codeblocks are displaying as plain text (no syntax highlights). Please take a look at https://docusaurus.io/docs/markdown-features/code-blocks#supported-languages and add the necessary config for prism

Copy link
Contributor

github-actions bot commented Nov 4, 2024

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

github-actions bot commented Nov 4, 2024

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

github-actions bot commented Nov 5, 2024

✅ Vercel Preview Deployment is ready!

View Preview

@vivekjain23 vivekjain23 self-assigned this Nov 8, 2024
@vivekjain23 vivekjain23 merged commit 549b554 into develop Nov 8, 2024
31 of 32 checks passed
@vivekjain23 vivekjain23 deleted the devx/fix-toml-codeblock branch November 8, 2024 10:52
Copy link
Contributor

github-actions bot commented Nov 8, 2024

✅ Vercel Preview Deployment is ready!

View Preview

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devx Issues related to the DevX team documentation Improvements or additions to documentation dx-improvement Mainly for DX team itself to track issues with features/fixes that improve dx.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Fix .toml codeblock in docs/content/developer/getting-started/create-a-package.mdx
3 participants