MDX Blog Template is a simple implementation of a markdown static blog. Built with Next.js 14 and velite js.
-
MDX Components
-
Responsive design built using
shadcn/uiandtailwindcss -
Syntax Highlighting of code.
-
Next.js: Harness the power of Next.js, leveraging its static site generation (SSG) capabilities to create a user interface. -
shadcn/ui: Enhance your app's visual and interactive elements with components from shadcn/ui. These beautifully designed components can be seamlessly integrated into your application, offering accessibility, customizability, and open-source goodness. -
Tailwind CSS: Employ Tailwind CSS for efficient styling, enabling rapid development through its utility-first approach and streamlined design workflow. -
Markdown: MDX lets you use JSX in your markdown content. You can import components, such as interactive charts or alerts, and embed them within your content. -
Velite: Velite is a tool for building type-safe data layer, turn Markdown / MDX, YAML, JSON, or other files into app's data layer with Zod schema.
To get a copy of MDX Blog Template up and running on your local machine, follow these steps:
-
Clone the repository:
git clone https://github.com/devbertskie/next-mdx-blog.git
After successful cloned. Head over to the project directory
cd next-mdx-blog -
Install Dependencies:
Navigate into the project directory and install the required dependencies:
npm install
-
Run the Development Server:
Start the app in development mode with the following command:
npm run dev
Head over to your browser and access the
localhost:3000 -
Build the App:
To build the app, run the following command:
npm run build
-
Add New Blog Content:
To add new blog content, go to
contentfolder and you can add new markdown component in.mdxfileImportant: Make sure to name the component with dash(-) and without space. Example:my-example-blog.mdx
