Files
markdownblog/README.md
rattatwinko 037c7cd31e initial
2025-06-16 16:55:38 +02:00

1.5 KiB

Markdown Blog

A modern blog system built with Next.js, Markdown, and Electron for cross-platform support.

Features

  • Write blog posts in Markdown
  • Responsive web design
  • Desktop application support via Electron
  • Mobile-friendly interface
  • Tag-based organization
  • Clean and modern UI

Getting Started

Prerequisites

  • Node.js 18+ and npm

Installation

  1. Clone the repository:
git clone <repository-url>
cd markdownblog
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev
  1. For desktop development:
npm run electron-dev

Writing Posts

Create new blog posts by adding Markdown files to the posts/ directory. Each post should include frontmatter with the following fields:

---
title: "Your Post Title"
date: "YYYY-MM-DD"
tags: ["tag1", "tag2"]
summary: "A brief summary of your post"
---

Your post content here...

Building for Production

  1. Build the web version:
npm run build
  1. Build the desktop version:
npm run electron-build

Project Structure

markdownblog/
├── posts/           # Markdown blog posts
├── src/
│   ├── app/        # Next.js app directory
│   └── lib/        # Utility functions
├── electron/       # Desktop app code
└── public/         # Static assets

Technologies Used

  • Next.js 14
  • TypeScript
  • Tailwind CSS
  • Electron
  • Markdown (remark)
  • date-fns

License

MIT