https://github.com/travisvn/next-mdx-template
Next.js 14 MDX template
https://github.com/travisvn/next-mdx-template
blog cms markdown mdx next-remote-mdx nextjs portfolio react tailwindcss template typescript
Last synced: 4 months ago
JSON representation
Next.js 14 MDX template
- Host: GitHub
- URL: https://github.com/travisvn/next-mdx-template
- Owner: travisvn
- Created: 2024-05-04T06:57:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-10T21:08:26.000Z (7 months ago)
- Last Synced: 2024-11-12T04:12:56.647Z (6 months ago)
- Topics: blog, cms, markdown, mdx, next-remote-mdx, nextjs, portfolio, react, tailwindcss, template, typescript
- Language: TypeScript
- Homepage: https://next-mdx-template.vercel.app
- Size: 185 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Next.js MDX Template







[](https://img.shields.io/github/sponsors/travisvn)Simple, easy-to-modify template to use for creating a blog, portfolio, or content-based website
## Features âī¸
- :white_check_mark: Next.js 14 App Directory
- :white_check_mark: `next-mdx-remote`
- :white_check_mark: RSS Feed
- :white_check_mark: Sitemap generation
- Tailwind CSS
- Syntax highlighting in `.mdx`
- Custom components embeddable in `.mdx` files
- Utility functions to customize further[View live demo](https://next-mdx-template.vercel.app/)
## Config âī¸
- `config/site.ts` - Site title, description, and URL
- `.env` to set `BASE_URL` if you'd like to override the base URL you set in `config/site.ts`## Structure đ
The majority of the structure should be self evident, based on [Next.js docs](https://nextjs.org/docs)
- `content/` - Location for posts (.mdx files)
- `utils/mdx-utils.ts` - Main functions for handling `.mdx` and converting frontmatter
- `lib/helpers.ts` - _extra (i.e. not required)_ Options for handling `.mdx`### Notes âšī¸
- `gray-matter` and `date-fns` are included but not required
- If you'd like to remove them, remove the `lib/helpers.ts` file and its connections
- Based off of [leerob.io repo](https://github.com/leerob/leerob.io)