Skip to content

esaye/blog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Personal Blog

A simple, fast static blog built with Node.js and vanilla HTML/CSS/JavaScript.

Features

  • ✅ Static site generation from Markdown
  • ✅ Responsive design
  • ✅ Fast loading times
  • ✅ Easy to customize
  • ✅ GitHub Pages ready

Getting Started

Prerequisites

  • Node.js (v16 or higher)
  • Git

Installation

  1. Clone the repository:

    git clone https://github.com/esaye/blog.git
    cd blog
  2. Build the blog:

    npm run build
  3. Serve locally:

    npm run serve
  4. Open your browser and visit http://localhost:8000

Writing Posts

  1. Create a new Markdown file in the posts/ directory:

    touch posts/YYYY-MM-DD-your-post-title.md
  2. Add front matter and content:

    ---
    title: Your Post Title
    date: YYYY-MM-DD
    author: Your Name
    excerpt: A brief description of your post
    ---
    
    # Your Post Content
    
    Write your content here in Markdown format...
  3. Build the site:

    npm run build

Deployment

This blog is configured for GitHub Pages deployment. Simply push your changes to the main branch, and GitHub Pages will automatically serve your site from the public/ directory.

Customization

  • Styling: Edit assets/css/style.css
  • Layout: Modify src/template.html
  • Build Process: Update build.js

Project Structure

blog/
├── posts/           # Markdown blog posts
├── src/            # Templates and source files
├── assets/         # CSS, JS, images
├── public/         # Generated static site
├── package.json    # Project configuration
├── build.js        # Build script
└── README.md       # This file

License

MIT License - feel free to use this for your own blog!


Built with ❤️ using Node.js and modern web technologies.

About

blog

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published