Quick start BashWrite

About BashWrite

Single, pure bash script to make your blog.

• No dependencies
• Support extended Markdown with mattcone/markdown-guide
• Darkmode
• Tags
• Recent posts
• Pinned posts
• RSS
• Github pages

Quick start

Install

1. Download bw.sh - Release page.
2. Open bw.sh, edit settings and save the file.
3. Open terminal, and run ./bw.sh b
4. Then your blog will be generated!

Write new posts

1. Write a markdown file in write/.
2. The markdown file should starts with frontmatter
3. Save your file and run ./bw.sh b

Frontmatter

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

Remove posts

1. Remove a markdown file in write/
2. Run ./bw.sh b
3. The script will delete files and links.

About directory structure

Download from repo

• bw.sh
• .github/ - Download this folder if you want to use github pages.

Automatically generated: Do not edit these 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

Create these folders yourself, and work only within these folders

• write/ - Write your markdowns in this folder. You can also add assets needed for the posting.
• assets/ - Add any assets in this folder.