From dd9c3a342c194cd6634eb8c1945c856889fe0f46 Mon Sep 17 00:00:00 2001 From: Pradip Caulagi Date: Thu, 7 Sep 2023 16:12:09 +0200 Subject: [PATCH] Change references from markdown to mdx (#534) --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 22da2c0..1117ac3 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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