ficd/zona-go
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
18 commits 3 branches 0 tags 147 KiB
Find a file
Daniel Fichtinger 575708756e removed test dir from gitignore for now; will add back in once project is stable 
Added testdir back
2024-11-10 13:48:25 -05:00
cmd/zona began implementing dir traversal 2024-11-09 01:00:44 -05:00
internal began implementing dir traversal 2024-11-09 01:00:44 -05:00
test removed test dir from gitignore for now; will add back in once project is stable 2024-11-10 13:48:25 -05:00
.gitignore removed test dir from gitignore for now; will add back in once project is stable 2024-11-10 13:48:25 -05:00
build.sh Created build script 2024-10-19 01:06:58 -04:00
go.mod Implement cli argument for file path, path validation, file type validation 2024-10-19 03:14:20 -04:00
LICENSE Initial commit 2024-10-13 00:58:13 -04:00
README.md Added installation instructions 2024-10-19 01:26:27 -04:00
zona Implement cli argument for file path, path validation, file type validation 2024-10-19 03:14:20 -04:00

README.md

Zona

Zona is a small tool for building a static blog website. It allows users to write pages and blog posts in Markdown and automatically build them into a static, lightweight blog.

Warning: Implementing v1 functionality in Go is still WIP. While this warning is here, Zona is not ready to use! At all!

Table of Contents

v1 Features

  • Write your pages in Markdown.
  • Build a lightweight website with zero JavaScript.
  • Simple CLI build interface.
  • HTML layout optimized for screen readers and Neocities.

Getting Started

Dependencies

  • go 1.23.2
# On Arch Linux
sudo pacman -S go

# On Ubuntu/Debian
sudo apt install go

Installation

First, download the repository and open it:

git clone https://github.com/ficcdaf/zona.git && cd zona

On Linux:

# run the provided build script
./build.sh

On other platforms:

go build -o bin/zona cmd/zona

The resulting binary can be found at bin/zona.

Roadmap

  • Zona configuration file to define build options.
  • Image optimization & dithering options.
  • AUR package after first release
  • Automatic RSS/Atom feed generation.

Inspirations