Skip to content

Add docs for the Renderer API#13715

Draft
ArmandPhilippot wants to merge 3 commits intomainfrom
armand/renderer-api
Draft

Add docs for the Renderer API#13715
ArmandPhilippot wants to merge 3 commits intomainfrom
armand/renderer-api

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Apr 10, 2026

Warning

WIP, not yet ready for reviews!

Description (required)

Adds a new reference page for the Renderer API:

  • move some types from the Integration API to the new Renderer API (some have been reworded, not all)
  • reuse a structure similar to that of the Adapter API to explain how to build a renderer

Things I'm not sure of:

  • Renderers are not only for UI Framework but for file formats such as MDX. Is there a term to describe that?
  • It seems /en/reference/renderer-reference existed before, so I had to update the redirections. I'm not sure how Netlify handles them... maybe we want another slug for the page to avoid any conflicts?
  • I also wonder if it wouldn't make sense to have a new sidebar group for integration-related APIs instead of lengthening the list in "Other development APIs"?
Integrations reference
    Integration API
    Adapter API
    Renderer API

Related issues & labels (optional)

@ArmandPhilippot ArmandPhilippot added the add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. label Apr 10, 2026
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 10, 2026

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 07d9ea1
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/69d91475a0b7a20008d3338e
😎 Deploy Preview https://deploy-preview-13715--astro-docs-2.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 project configuration.

@astrobot-houston
Copy link
Copy Markdown
Contributor

astrobot-houston commented Apr 10, 2026

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/reference/integrations-reference.mdx Source changed, localizations will be marked as outdated.
en/reference/renderer-reference.mdx Localization added, will be marked as complete.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

add new content Document something that is not in docs. May require testing, confirmation, or affect other pages.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the renderer API

2 participants