https://github.com/kifbv/basker
Bash static site generator
https://github.com/kifbv/basker
bash catppuccin cmark static-site-generator
Last synced: 2 months ago
JSON representation
Bash static site generator
- Host: GitHub
- URL: https://github.com/kifbv/basker
- Owner: kifbv
- Created: 2025-04-03T08:47:27.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-05T11:40:58.000Z (about 1 year ago)
- Last Synced: 2025-07-30T23:03:08.746Z (11 months ago)
- Topics: bash, catppuccin, cmark, static-site-generator
- Language: CSS
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌟 Basker - A Minimalist Static Site Generator 🌟
## 📝 Overview
Basker is a lightweight static site generator that converts Markdown files into a beautifully styled website using the Catppuccin color theme. It's perfect for blogs, documentation sites, or personal websites that prioritize simplicity and readability.
Check out the live demo at [basker.franckratier.design](https://basker.franckratier.design) to see Basker in action!
## ✨ Features
- 🌓 **Dark/Light Mode Toggle**: Switch between Catppuccin Latte & Mocha themes with a click
- 📱 **Responsive Design**: Looks great on mobile, tablet, and desktop
- 🔤 **Google Fonts**: Uses Cinzel for headings and Fauna One for body text
- 📅 **Automatic Date Handling**: Sorts posts by date and displays them nicely
- 🔄 **Simple Build Process**: One script to generate your entire site
## 🚀 Getting Started
### Prerequisites
- Bash shell
- [cmark](https://github.com/commonmark/cmark) for Markdown processing
### Installation
1. Use this repository as a template:
- Click the "Use this template" button at the top of the [GitHub repository](https://github.com/kifbv/basker)
- Name your new repository and create it
- Clone your new repository:
```bash
git clone https://github.com/yourusername/your-repo-name.git
cd your-repo-name
```
2. Place your Markdown files in the `src/` directory
3. Run the build script:
```bash
./build.sh
```
4. Your generated site will be in the `docs/` directory. Browse/test it locally and [publish it](https://docs.github.com/en/pages) to Github Pages!
## 📄 File Structure
```
basker/
├── build.sh # Main build script
├── header.html # Header template
├── footer.html # Footer template
├── catppuccin-latte.css # Light theme
├── catppuccin-mocha.css # Dark theme
├── src/ # Place your Markdown files here
│ ├── post1.md
│ ├── post2.md
│ └── ...
└── docs/ # Generated HTML and assets
├── index.html
├── post1.html
└── ...
```
## 📝 Creating Content
### Markdown Format
Each Markdown file should include YAML frontmatter at the top:
```markdown
---
title: My Awesome Post
description: A brief description of the post
date: 2024-04-03
---
# Main Content Starts Here
Your markdown content goes here...
```
- The `title` appears in the post and index page
- The `description` is used in the index page
- The `date` is used for sorting (will be added automatically if missing)
## 🎨 Customization
### Site Name
Change the `SITE_NAME` variable in `build.sh`:
```bash
SITE_NAME="Your Site Name"
```
### Styling
Modify the CSS files to change the appearance:
- `catppuccin-latte.css` - Light theme
- `catppuccin-mocha.css` - Dark theme
### Fonts
The site uses Google Fonts:
- Cinzel for titles (elegant serif font)
- Fauna One for body text (readable serif font)
- Monospace for code blocks
To change fonts, edit:
1. The Google Fonts import in `header.html`
2. The same import in the index page section of `build.sh`
3. Update the font-family properties in both CSS files
## 🔧 Advanced Usage
### Adding Images
Place image files in the `dist/` directory and reference them in your Markdown:
```markdown
```
### Custom HTML
You can include HTML directly in your Markdown files:
```markdown
Custom HTML here
```
## 📚 Examples
Check out the example posts in the `src/` directory to see how to format your content.
## 🤝 Contributing
Contributions are welcome! Feel free to submit issues or pull requests.
## 📄 License
This project is open source and available under the [MIT License](LICENSE).