Skip to content

A minimal blog platform where users upload markdown files, push the repo, and it's live instantly.

Notifications You must be signed in to change notification settings

eshan-singh78/MDXpress-Blog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“° MDXpress blog

MDXpress blog is a lightweight markdown-powered blogging platform built using Node.js. Designed for simplicity and speed, it allows users to post blog entries by simply adding .md files to a specific folderβ€”no CMS or database required.


✨ Features

  • ⚑ Fast & Minimal: Just write Markdown filesβ€”no database or frontend frameworks.
  • πŸ—‚οΈ Automatic Content Loading: Upload your markdown file to the /public/blogs/ folder and it’s live.
  • 🎨 Built-in Dark Mode: Seamless dark/light theme toggle with a clean UI.
  • πŸ”„ Auto Updates with Push: Push new .md files to the repo and they instantly show up in the UI.
  • πŸ’» Markdown Rendering: Styled and responsive markdown rendering via the marked library.

πŸ“‚ Project Structure

mdxpress-blog/
β”œβ”€β”€ public/
β”‚   β”œβ”€β”€ blogs/         # Markdown blog files (.md)
β”‚   β”œβ”€β”€ styles/        # CSS styles including dark mode
β”‚   └── views/         # HTML templates (home, blog viewer)
β”œβ”€β”€ server.js          # Express server with markdown rendering
β”œβ”€β”€ package.json       # Project metadata and dependencies
└── vercel.json        # Vercel configuration

πŸ“ How to Use

  1. Clone the Repository

    git clone https://github.com/yourusername/mdxpress-blog.git
  2. Add Blog Posts
    Drop your .md files inside the public/blogs/ directory.

  3. Run Locally

    npm install
    npm start
  4. Visit in Browser
    Open http://localhost:3000 to view your home page and blogs.


πŸ™‹β€β™‚οΈ About the Creator

Created by Eshan Singh, a tech enthusiast and full-stack developer who enjoys building minimal, impactful tools.


Want to contribute, suggest features, or report bugs? Open an issue or submit a pull request!

About

A minimal blog platform where users upload markdown files, push the repo, and it's live instantly.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published