add mdx support #16
Closed
add mdx support #16
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michaelglass
force-pushed
the
markdown-templating
branch
from
6bd9390 to
02a91e3
Compare
michaelglass
commented
Mar 1, 2024
| @@ -40,17 +41,21 @@ export const Prose: FC<{ children: ReactNode; className?: string }> = ({ | |||
| </div> | |||
| ); | |||
|
|
|||
| export const PageContent: FC<{ md: string }> = ({ md }) => ( | |||
There was a problem hiding this comment.
this is backwards compatible until / if we migrate documentation to support mdx
michaelglass
commented
Mar 1, 2024
| @@ -6,7 +6,10 @@ | |||
| "dev": "vite --force", | |||
| "build": "tsc && vite build" | |||
| }, | |||
| "type": "module", | |||
| "dependencies": { | |||
There was a problem hiding this comment.
mdxjs plays nicer with ESM
michaelglass
commented
Mar 1, 2024
| @@ -3,20 +3,14 @@ import { PageTitle } from "../components/PageTitle"; | |||
| import { PageContent } from "../components/PageContent"; | |||
| import { packageUrls } from "../constants"; | |||
|
|
|||
| export const content = ` | |||
|
|
|||
| <PageTitle pretitle="Introduction" title="Getting started" /> | |||
There was a problem hiding this comment.
example mdx translation
michaelglass
commented
Mar 1, 2024
packages/website/src/routes.tsx
Outdated
| @@ -160,7 +160,7 @@ export const routes: { | |||
| { | |||
| label: "Getting started", | |||
| url: "/headless-getting-started", | |||
| element: <HeadlessSetup />, | |||
| element: <HeadlessGettingStarted />, | |||
There was a problem hiding this comment.
unrelated cleanup I did along the way
michaelglass
force-pushed
the
markdown-templating
branch
from
2f7d94f to
c04c95c
Compare
michaelglass
force-pushed
the
markdown-templating
branch
from
c04c95c to
78d99f3
Compare
michaelglass
force-pushed
the
markdown-templating
branch
from
20f620c to
417143a
Compare
jakub-nlx
approved these changes
Mar 4, 2024
peterszerzo
approved these changes
Mar 4, 2024
|
this seems to be a bad fit considering mdx doesn't have native interpolation in code blocks the workarounds make dealing with code / pre decoration annoying. So stick with the status quo |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
adding mdx support for easier documentation writing (and proper markdown syntax highlighting)
quick side-track while writing voice compass docs