Skip to content

Commit

Permalink
Change references from markdown to mdx (#534)
Browse files Browse the repository at this point in the history
  • Loading branch information
caulagi authored Sep 7, 2023
1 parent 0277b4b commit dd9c3a3
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

[![CI](https://github.com/caulagi/blog/actions/workflows/ci.yml/badge.svg)](https://github.com/caulagi/blog/actions/workflows/ci.yml)

Based on [`blog-starter`][blog-starter] and uses Next.js, Markdown, and TypeScript. The pages are statically generated at build time.
The blog uses next.js, mdx, typescript, and tailwindcss. The pages are statically generated at build time.

The blog posts are stored in `/_posts` as Markdown files with front matter support. Adding a new Markdown file in there will create a new blog post.
The blog posts are stored in `/_posts` as mdx files with front matter support. Adding a new Markdown file in there will create a new blog post.

To create the blog posts we use [`remark`][remark] and [`remark-html`][remark-html] to convert the Markdown files into an HTML string, and then send it down as a prop to the page. The metadata of every post is handled by [`gray-matter`][gray-matter] and also sent in props to the page.
To create the blog posts we use [`remark`][remark] and [`remark-html`][remark-html] to convert the mdx files into an HTML string, and then send it down as a prop to the page. The metadata of every post is handled by [`gray-matter`][gray-matter] and also sent in props to the page.

## Getting started

Expand All @@ -23,7 +23,6 @@ Git commit history doesn't accurately reflect the history of the articles prior

This project is licensed under [`MIT`](LICENSE).

[blog-starter]: https://github.com/vercel/next.js/tree/canary/examples/blog-starter
[remark]: https://github.com/remarkjs/remark
[remark-html]: https://github.com/remarkjs/remark-html
[gray-matter]: https://github.com/jonschlinkert/gray-matter

1 comment on commit dd9c3a3

@vercel
Copy link

@vercel vercel bot commented on dd9c3a3 Sep 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

blog – ./

blog-git-main-caulagi.vercel.app
blog-caulagi.vercel.app
blog.caulagi.com

Please sign in to comment.