BashWrite Quick Start

About BashWrite

Pure Bash, single script blog generator

• Minimal requirements (Common commands: sed, awk, grep, tar)
• Support Extended Markdown
• RSS
• Tags
• Darkmode
• Pinned posts
• Recent posts

Quick Start

Install

1. Download: bw.sh - Codeberg
2. Make file executable: chmod +x ./bw.sh
3. Edit and save script's user settings: nano ./bw.sh (Or use preferred text editor)
4. View help/first steps (See: Write New Posts): ./bw.sh
5. Generate blog: ./bw.sh b

Write New Posts

1. Create a markdown file in ./write/: touch ./write/first-post.md
2. Edit newly created markdown file: nano ./write/first-post.md (Or use preferred text editor)
3. Start markdown file with frontmatter

---
title: My new post
description: Write description of this post.
date: 2025-02-05
lastmod: 2025-05-02
tags: tags seperated by whitespace
draft: false
pin: 1
banner: image.png
---

1. Add post content in markdown syntax after frontmatter
2. Save markdown file
3. Update blog: ./bw.sh b

Remove posts

1. Remove a markdown file in ./write/: rm -i ./write/first-post.md
2. Update blog: ./bw.sh b

Commands

• ./bw.sh h : Show help
• ./bw.sh b : Build blog
• ./bw.sh r : Force blog rebuild

Directory Structure

Downloaded From Repository

• bw.sh

Automatically Generated

Note: Do not edit the following files

• ./backup/
• ./checksum/ - Checksum list to compare the diffrence of files
• ./posts/
• ./tags/
• ./404.html
• ./all-posts.html - List of every posts
• ./all-tags.html - List of every tags
• ./index.html
• ./robots.txt
• ./rss.xml
• ./style.css
• ./sitemap.xml

User Created Folders

Note: Only edit files within these folders

Create folders: mkdir ./assets ./write

• ./assets/ - For site assets (Example: Favicons)
• ./write/ - For post markdown files and post assets