mirror of
https://github.com/jbranchaud/til
synced 2026-01-03 15:18:01 +00:00
Add Markdown And MDX Files Are Rendered To Routes as a Remix TIL
This commit is contained in:
@@ -10,7 +10,7 @@ pairing with smart people at Hashrocket.
|
|||||||
|
|
||||||
For a steady stream of TILs, [sign up for my newsletter](https://crafty-builder-6996.ck.page/e169c61186).
|
For a steady stream of TILs, [sign up for my newsletter](https://crafty-builder-6996.ck.page/e169c61186).
|
||||||
|
|
||||||
_1221 TILs and counting..._
|
_1222 TILs and counting..._
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -925,6 +925,7 @@ _1221 TILs and counting..._
|
|||||||
### Remix
|
### Remix
|
||||||
|
|
||||||
- [Get Query Params From The Request URL](remix/get-query-params-from-the-request-url.md)
|
- [Get Query Params From The Request URL](remix/get-query-params-from-the-request-url.md)
|
||||||
|
- [Markdown And MDX Files Are Rendered To Routes](remix/markdown-and-mdx-files-are-rendered-to-routes.md)
|
||||||
- [Relative And Absolute Paths In Links](remix/relative-and-absolute-paths-in-links.md)
|
- [Relative And Absolute Paths In Links](remix/relative-and-absolute-paths-in-links.md)
|
||||||
- [Run The Development Server From Another Port](remix/run-the-development-server-from-another-port.md)
|
- [Run The Development Server From Another Port](remix/run-the-development-server-from-another-port.md)
|
||||||
- [Set The Title Of A Page](remix/set-the-title-of-a-page.md)
|
- [Set The Title Of A Page](remix/set-the-title-of-a-page.md)
|
||||||
|
|||||||
24
remix/markdown-and-mdx-files-are-rendered-to-routes.md
Normal file
24
remix/markdown-and-mdx-files-are-rendered-to-routes.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# Markdown And MDX Files Are Rendered To Routes
|
||||||
|
|
||||||
|
If you put a markdown or [mdx](https://mdxjs.com/) file somewhere within the
|
||||||
|
`app/routes` directory of a [Remix](https://remix.run/) app, it knows how to
|
||||||
|
render it to HTML. There is no additional setup necessary, it works out of the
|
||||||
|
box.
|
||||||
|
|
||||||
|
For instance, trying creating an `about.md` file under `app/routes`.
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# About
|
||||||
|
|
||||||
|
My name is **Josh Branchaud** and I am an _independent_ software developer.
|
||||||
|
|
||||||
|
Reach out to me at <a href="mailto:josh@email.com">josh@email.com</a>.
|
||||||
|
```
|
||||||
|
|
||||||
|
Now, run the app's dev server and visit `localhost:3000/about`. You'll see a
|
||||||
|
fairly unstyled page with this text rendered to it. Try inspecting the source
|
||||||
|
and you'll see, for instance, that _About_ is wrapped in an `<h1>` tag.
|
||||||
|
|
||||||
|
If you want this markdown styled (e.g. a larger font size for that `<h1>`),
|
||||||
|
you'll either have to write some custom styles or pull in something like
|
||||||
|
[`@tailwindcss/typography`](https://tailwindcss.com/docs/typography-plugin).
|
||||||
Reference in New Issue
Block a user