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

feat(content): introduce build-time rendering/highlighting for markdown #1174

Merged
merged 8 commits into from
Jun 21, 2024

Conversation

brandonroberts
Copy link
Member

@brandonroberts brandonroberts commented Jun 21, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

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:

Which package are you modifying?

  • vite-plugin-angular
  • vite-plugin-nitro
  • vitest-angular
  • astro-angular
  • create-analog
  • router
  • platform
  • content
  • nx-plugin
  • trpc

What is the current behavior?

Shiki syntax highlighting is done at build time and runtime. This causes the full shiki package to be included, producing many lazy loaded chunks.

Closes #1132

What is the new behavior?

  • All markdown rendering and syntax highlighting is done at build time through a Vite plugin. No rendering/highlighting code is shipped to the client.
  • All client rendering/highlighting code is removed
  • Some rendering code for using transfer state for content headings is retained

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

[optional] What gif best describes this PR or how it makes you feel?

Copy link

netlify bot commented Jun 21, 2024

Deploy Preview for analog-app ready!

Name Link
🔨 Latest commit 4c54e32
🔍 Latest deploy log https://app.netlify.com/sites/analog-app/deploys/6675e17ce3f41b0008da2fe0
😎 Deploy Preview https://deploy-preview-1174--analog-app.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Jun 21, 2024

Deploy Preview for analog-blog ready!

Name Link
🔨 Latest commit 4c54e32
🔍 Latest deploy log https://app.netlify.com/sites/analog-blog/deploys/6675e17c72561700081ec9bb
😎 Deploy Preview https://deploy-preview-1174--analog-blog.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Jun 21, 2024

Deploy Preview for analog-docs ready!

Name Link
🔨 Latest commit 4c54e32
🔍 Latest deploy log https://app.netlify.com/sites/analog-docs/deploys/6675e17c2952aa0008c9efe0
😎 Deploy Preview https://deploy-preview-1174--analog-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Jun 21, 2024

Deploy Preview for analog-ng-app ready!

Name Link
🔨 Latest commit 4c54e32
🔍 Latest deploy log https://app.netlify.com/sites/analog-ng-app/deploys/6675e17ca13aad0008a0a132
😎 Deploy Preview https://deploy-preview-1174--analog-ng-app.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@brandonroberts brandonroberts merged commit 9ccf6b2 into beta Jun 21, 2024
24 checks passed
@brandonroberts brandonroberts deleted the feat-platform-content branch June 21, 2024 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Using Shiki highlighter produces too many lazy chunks by default
1 participant