Skip to content

**Static Site Generator** is a simple and efficient tool that converts Markdown files into static HTML pages using templates. It’s lightweight, fast, and perfect for generating static websites with consistent layouts. πŸš€ πŸ”— **Live Demo:**

Notifications You must be signed in to change notification settings

Shaheryarkhalid/Static_Site_Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

11 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ—οΈ Static Site Generator

A simple, efficient Static Site Generator built from scratch! πŸš€

πŸ‘‰ Live Demo

πŸ“Œ Features

βœ”οΈ Converts Markdown (.md) to HTML
βœ”οΈ Supports templates for consistent layouts
βœ”οΈ Fast, lightweight, and easy to use
βœ”οΈ Generates fully static websites

πŸš€ Getting Started

1️⃣ Clone the Repository

git clone https://github.com/Shaheryarkhalid/static_site_generator.git  
cd static_site_generator

3️⃣ Run the Generator

main.sh

4️⃣ View the Output

Open docs/index.html in your browser. πŸŽ‰

πŸ› οΈ How It Works

  1. Reads content from .md files
  2. Applies a template to generate HTML
  3. Saves output in the docs/ folder

πŸ“‚ Project Structure

πŸ“¦ static_site_generator  
 ┣ πŸ“‚ content       # Markdown files (your site content)  
 ┣ πŸ“‚ templates     # HTML templates for consistent design  
 ┣ πŸ“‚ docs          # Generated static site  
 ┣ πŸ“œ main.sh       # Main script to generate the site locally
 ┣ πŸ“œ build.sh      # Buil script to build the site for github  
 β”— πŸ“œ README.md     # This file  

✨ Example Usage

./main.sh
./build.sh

This will generate an HTML page from blog.md and save it in docs/. Keep in mind to update execute permission for main.sh and build.sh

sudo chmod +x './main.sh'
sudo chmod +x './build.sh'

πŸ“’ Contributing

Feel free to fork, create issues, or submit PRs. Let's make it better together!

πŸ“œ License

MIT License. Free to use and modify.

πŸ”— GitHub Repo: Shaheryarkhalid/static_site_generator

About

**Static Site Generator** is a simple and efficient tool that converts Markdown files into static HTML pages using templates. It’s lightweight, fast, and perfect for generating static websites with consistent layouts. πŸš€ πŸ”— **Live Demo:**

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages