-
Notifications
You must be signed in to change notification settings - Fork 960
feat: Add component previews #2689
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
base: main
Are you sure you want to change the base?
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Looks like the @NWylynko how do you feel about using frontmatter to control the rendering of this? |
Correct, we need to control the positioning of the elements (outside the contents of the body of the pages), which is why I went with frontmatter as opposed to exposing a component to be used. |
Yup frontmatter definitely makes sense here. But adds to the point that we need to be transforming markdown before exposing it to LLMs as things like this will just confuse them. |
Should we just strip the frontmatter and inject an h1 tag and description with the page? ---
title: '`<SignIn />` component'
description: Clerk's <SignIn /> component renders a UI for signing in users.
sdk: astro, chrome-extension, expo, nextjs, nuxt, react, react-router, remix, tanstack-react-start, vue, js-frontend
preview:
src: '/sign-in'
shadcn:
nextjs: 'nextjs-sign-in-page'
---
...becomes # `<SignIn />` component
> Clerk's <SignIn /> component renders a UI for signing in users.
...This looks to be what mintlify does. |
for context, imo, i think we should stick with frontmatter - for the sake of maintaining consistency across docs pages |
Yeah, my recommendation was only for the transformed content for LLMs. You'd still author everything using frontmatter.
Yeah, I can tweak the avatar sizing today |
|
@alexisintech here is a PR to reduce the height of the avatar component https://github.com/clerk/clerk/pull/1922 |
|
is it supposed to 404, or is it supposed to do nothing at all? Screen.Recording.2026-01-05.at.17.40.24.mov |
|
In the theme editor, we have "reset to default" - how much of a hassle would it be to add an "undo" functionality? π |
Here is a PR to implement undo/redo functionality https://github.com/clerk/clerk/pull/1956 |
|
@alexisintech working on the mock fixes! |
this should be fixed too |
|
last nit pick - for |
|
@alexcarpenter have just taken a look at this. It looks awesome π Noticed some weird behaviour with the Two things:
Screen.Recording.2026-01-08.at.3.50.08.pm.movAs another note, if I select a theme for a component, and then click on another component, I understand the theme will propagate across components. And also applies when I go to customize the theme, and say apply a red background, that red background will propagate to the other components I click on after that. Just curious to know if that was the intention here, or a bug? |
|
@SarahSoutoul the two bullets are expected. Since its the light theme being displayed on a dark background. The default theme atm of this deployment doesn't support switching between light/dark mode, only shadcn theme does.
Intentional, yes |
π Previews:
What does this solve?
What changed?
Checklist