docs: Tweak syntax highlighter setup and cache-control

[ciscorn]

Summary by CodeRabbit

• New Features
  • Enhanced the CodeBlock component to receive additional shiki prop for improved syntax highlighting.
  • Integrated syntax highlighting capabilities into the content loading process.
• Bug Fixes
  • Updated caching headers for improved performance.
• Documentation
  • Updated component usage examples to reflect changes in prop handling for the CodeBlock.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces significant modifications to the CodeBlock.svelte component, streamlining its handling of the shiki highlighter by removing asynchronous logic and simplifying the rendering process. The shiki variable is now directly passed as a prop from various example components, enhancing the way the CodeBlock receives its properties. Additionally, changes to the layout server and page components incorporate the shiki highlighter into the data flow, allowing for improved syntax highlighting capabilities across the application.

Changes

File Path	Change Summary
src/content/CodeBlock.svelte	Imports for shiki elements commented out; changed shiki from a promise to HighlighterCore; removed conditional rendering logic for shiki.
src/content/examples/*.svelte.md	Added let { shiki } = $props(); to extract shiki from props and updated <CodeBlock> calls to include {shiki} alongside content={demoRaw}.
src/routes/+layout.server.ts	Exported load function and updated setHeaders method for caching to new values (max age 300 seconds, stale-while-revalidate 300 seconds).
src/routes/examples/[slug]/+page.svelte	Updated <data.Content /> to include shiki={data.shiki} prop.
src/routes/examples/[slug]/+page.ts	Added imports for shiki and created a shiki highlighter instance; modified return object of load function to include shiki.

Possibly related PRs

• Code on example pages #15: Simplifies the CodeBlock component's handling of the shiki highlighter, relevant to this PR's updates.
• Change syntax highlighter from PrismJS to Shiki #16: Involves changing the syntax highlighter to Shiki, directly related to the main PR's focus.
• Add CustomControl components #19: Introduces CustomControl components that may interact with the CodeBlock.
• extension: maplibre-contour #30: Adds MapLibreContourSource, possibly utilizing CodeBlock for displaying code.
• Initial deck.gl support #37: Integrates deck.gl overlays, which may involve CodeBlock for showcasing examples.
• deck.gl: More reactivity #39: Updates DeckGL component, potentially using CodeBlock for code snippets.
• docs: Update Shiki’s regex engine to use Oniguruma (Wasm) #40: Directly relates to the use of Oniguruma for regex in Shiki, relevant to the main PR.
• CustomLayer component #41: Addition of CustomLayer may involve CodeBlock for documentation.

🐇 "In the land of code, where bunnies hop,
A shiki highlighter makes our code pop!
With props now flowing, oh what a delight,
Our CodeBlock shines, oh so bright!
From examples galore, we learn and play,
Hooray for the changes, hip-hip-hooray!" 🐇

---

🪧 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 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.

[cloudflare-workers-and-pages]

Deploying svelte-maplibre-gl with    Cloudflare Pages

Latest commit:	23172cd
Status:	✅  Deploy successful!
Preview URL:	https://ff8201a6.svelte-maplibre-gl.pages.dev
Branch Preview URL:	https://shiki-cf.svelte-maplibre-gl.pages.dev

View logs