https://github.com/albbus-stack/mdx-next-blog
A simple blog starter kit built in next.js using mdx for the editors convenience.
https://github.com/albbus-stack/mdx-next-blog
markdown md mdx next nextjs react tailwindcss typescript
Last synced: 3 months ago
JSON representation
A simple blog starter kit built in next.js using mdx for the editors convenience.
- Host: GitHub
- URL: https://github.com/albbus-stack/mdx-next-blog
- Owner: albbus-stack
- License: mit
- Created: 2022-09-10T17:21:44.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-19T18:36:16.000Z (almost 4 years ago)
- Last Synced: 2025-04-03T12:13:40.272Z (about 1 year ago)
- Topics: markdown, md, mdx, next, nextjs, react, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://next-md-blog-pearl.vercel.app
- Size: 1.25 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mdx-next-blog
This is a simple blog built with NextJS, Typescript and MDX.
## Getting Started
Change your website name, description, domain and main author in `/utils/config.ts`.
Here you can tweak the two main colors of the blog choosing from the [tailwindcss palette](https://tailwindcss.com/docs/customizing-colors).
Provide a `/public/images/card-preview.png` as a preview image for your blog used in link cards.
## Notes for the editor
Each file in the `/posts` directory is a blog post and has some metadata that you can specify at the top of the file like so:
```json
---
title: Example Post
description: My first post.
date: "2021-03-20"
image: "bridge.jpg"
author: Me
---
```
The required fields are `title`, `description` and `date`. The `author` field is optional and will default to the main author.
If you specify an image this will be displayed in the home page along with the post. The image should be placed in the `/public/images` directory.
On markdown images you can specify the smaller size (`small`), the rounded corners (`round`) and/or the horizontal positioning (`side`) with the following syntax:
```md
```
Links can be specified with the following syntax:
```md
[link text](/url)
```
All the other [standard markdown elements](https://www.markdownguide.org/cheat-sheet/) like headings, lists, code blocks and tables are supported.
For convenience you can use the [push-to-git.bat](push-to-git.bat) script to push the new posts and images to your git repository, after having configured the remote.