Giter Site home page Giter Site logo

mdx-blog-basic's Introduction

MDX Blog (mdxblog.io) is a platform built with the latest web technologies, offering a unique blogging experience. MDX Blog is a simple template for creating blogs using MDX (Markdown + JSX) and Next.js 14. Unlike traditional blogging solutions that rely on a database to store content, content management in MDXBlog is handled by easily editable Markdown (mdx) files in a folder on your local machine! It's a good solution for those who appreciate the ease of Markdown and the power of React components.

Our project is fully accessible on GitHub.

Installation:

  • Clone the repo
  • Run npm install
  • Run npm run dev
  • Open http://localhost:3000 in your browser
  • Create a remote repo on GitHub
  • Push your local repo to GitHub
  • Deploy on Vercel

Create a post:

  • Use the '+' icon in the nav bar, in development mode only, to create a new post - or simply create a new MDX file in the data/posts directory, manually.
  • Edit posts in the browser or manually using VS Code (recommended), or any other text editor.

Key Features of MDX Blog:

  • Next.js 14 & App Router: Utilizing the cutting-edge features of Next.js 14, MDX Blog offers a seamless and efficient user experience, underpinned by the powerful app router for smooth navigation.
  • Deployed on Vercel: Experience the reliability and speed of Vercel, ensuring that our static blog site is always available and performs exceptionally.
  • SEO Optimized: With automatic sitemap generation at build time through 'next sitemap', our platform is finely tuned for search engine optimization, enhancing the visibility and reach of your content.
  • Dynamic Publishing: Our platform smartly handles future-dated posts, ensuring they are published only on or after their set date, thanks to a meticulous filtering system.
  • Development Mode Features: In development mode, users can swiftly create new posts using the '+' icon, streamlining the content creation process.
  • Flexible Content Editing: Edit your MDX (Markdown + JSX) posts with ease, either directly in the browser or using VS Code, providing a flexible and user-friendly environment for content creators.

Custom MDX Components:

  • <YouTube />: Seamlessly embed YouTube videos within your content.
  • <Image />: Integrate images elegantly, enhancing the visual appeal of your posts.
  • code: Include and showcase code snippets with clarity and style.

Dynamic Page Rendering

Our dynamic page rendering system is the backbone of MDX Blog, carefully extracting and presenting content. It leverages the next-mdx-remote/rsc for rendering MDX content, along with custom components like YouTube, Image, and Code, bringing a rich and interactive blogging experience.

Development Insights:

  • Utilizing gray-matter for front matter parsing, we extract crucial metadata for SEO and rendering purposes.
  • Only relevant posts are displayed, based on their publication date.
  • In development mode, additional tools like EditPostButton and OpenInVSCode are available, enhancing the ease of content management and editing.

MDX Blog represents a blend of technological innovation and user-centric design, providing a platform that's not only a pleasure to use but also powerful in its capabilities. Whether you're a developer, a content creator, or someone passionate about blogging, MDX Blog offers you the tools to share your stories and ideas with the world effortlessly.

mdx-blog-basic's People

Contributors

owolfdev avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.