ficd/zona-go
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Daniel 2024-10-17 03:07:03 -04:00 • committed by GitHub
parent a846167241
commit 2d4b82edd9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 17 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,30 +1,37 @@
# Zona # 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, JavaScript-free style blog. 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:** Porting existing functionality into Go is still WIP. While this warning is here, Zona is _not_ ready to use! Zona is quite opinionated about the website structure, since I am mainly building it for my own use. However, this may change as the project develops.
> **Warning:** Implementing bare minimum basic functionality in Go is still WIP. While this warning is here, Zona is _not_ ready to use! At all!
## Features ## Features
- Simple CLI build interface. - Simple CLI build interface.
- Build a lightweight website with zero JavaScript.
- Write your pages in Markdown or HTML. - Write your pages in Markdown or HTML.
- Automatic RSS/Atom feed generation. - Automatic RSS/Atom feed generation.
- HTML layout optimized for screen readers. - HTML layout optimized for screen readers.
## Build ## Getting Started
### Dependencies
TBD. TBD.
## Dependencies ### Build
TBD. TBD.
## Planned Features ## Roadmap
- Zona configuration file to define build options. - [ ] Zona configuration file to define build options.
- Image optimization & dithering options. - [ ] Image optimization & dithering options.
- [Norg](https://github.com/nvim-neorg/neorg) support. - [ ] [Norg](https://github.com/nvim-neorg/neorg) support...?
- [ ] AUR package after first release
--- ## Inspirations
Zona is inspired by [Zoner](https://git.sr.ht/~ryantrawick/zoner), a tool for building [Zonelets](https://zonelets.net/) style blogs. Zona is not committed to Zonelets backwards compatibility and will likely evolve new features. - [Zoner](https://git.sr.ht/~ryantrawick/zoner)
- Zonelets