Update readme
This commit is contained in:
parent
1467001f67
commit
89f43ea03c
2 changed files with 138 additions and 50 deletions
82
README.md
82
README.md
|
|
@ -1,67 +1,49 @@
|
||||||
# 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, lightweight blog.
|
Zona is a tool for building a static website, optimized for lightweight blogs following minimalist design principles.
|
||||||
|
|
||||||
> **Warning:** Implementing v1 functionality is still WIP. There will be binaries available to download from the Releases tab when Zona is ready to be used. Until then, you are welcome to download the source code, but I can't promise anything will work!
|
**Warning:** Zona has not yet reached **v1**. The `dev-*` branches of this repository contain the code -- however, there is no assurance of stability or functionality until the first release. Configuration and usage documentation will also be provided at this time.
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Features](#v1-features)
|
- [Design Goals](#design-goals)
|
||||||
- [Installation](#installation)
|
- [v1 Features](#v1-features)
|
||||||
- [Roadmap](#roadmap)
|
- [Roadmap](#roadmap)
|
||||||
|
- [Contribution](#contribution)
|
||||||
|
- [Inspirations](#inspirations)
|
||||||
|
|
||||||
|
## Design Goals
|
||||||
|
|
||||||
|
Zona is intended to be easy-to-use. A user should be able to build a reasonably complex website or blog with only a directory of Markdown content and a single command, without needing to write any HTML or configuration. However, users should optionally have access to sensible and flexible configuration options, including writing HTML. The output of Zona should also be lightweight, retaining the smallest file sizes possible. These characteristics make Zona well-suited for both beginners and power users that wish to host a website on a service like Neocities or GitHub Pages.
|
||||||
|
|
||||||
## v1 Features
|
## v1 Features
|
||||||
|
|
||||||
- Write your pages in Markdown.
|
- Write pages purely in Markdown.
|
||||||
- Build a lightweight website with zero JavaScript.
|
- Single-command build process.
|
||||||
- Simple CLI build interface.
|
- Lightweight output.
|
||||||
- HTML layout optimized for screen readers and Neocities.
|
- Sensible default template and stylesheet.
|
||||||
|
- Configuration entirely optional, but very powerful.
|
||||||
## Getting Started
|
- Site header and footer defined in Markdown.
|
||||||
|
- Declarative metadata per Markdown file.
|
||||||
### Dependencies
|
- Automatically generated `Archive`, `Recent Posts`, and `Image Gallery` elements.
|
||||||
|
- Support for custom stylesheets, favicons, and page templates.
|
||||||
- `go 1.23.2`
|
|
||||||
|
|
||||||
```Bash
|
|
||||||
# On Arch Linux
|
|
||||||
sudo pacman -S go
|
|
||||||
|
|
||||||
# On Ubuntu/Debian
|
|
||||||
sudo apt install go
|
|
||||||
```
|
|
||||||
|
|
||||||
### Installation
|
|
||||||
|
|
||||||
First, download the repository and open it:
|
|
||||||
|
|
||||||
```Bash
|
|
||||||
git clone https://github.com/ficcdaf/zona.git && cd zona
|
|
||||||
```
|
|
||||||
|
|
||||||
On Linux:
|
|
||||||
|
|
||||||
```Bash
|
|
||||||
# run the provided build script
|
|
||||||
./build.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
On other platforms:
|
|
||||||
|
|
||||||
```Bash
|
|
||||||
go build -o bin/zona cmd/zona
|
|
||||||
```
|
|
||||||
|
|
||||||
The resulting binary can be found at `bin/zona`.
|
|
||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
|
|
||||||
- [ ] Zona configuration file to define build options.
|
- [ ] RSS/Atom feed generation.
|
||||||
- [ ] Image optimization & dithering options.
|
- [ ] Image optimization & dithering.
|
||||||
- [ ] AUR package after first release
|
- [ ] Windows, Mac, Linux releases.
|
||||||
- [ ] Automatic RSS/Atom feed generation.
|
- [ ] AUR package.
|
||||||
|
- [ ] Custom Markdown tags that expand to user-defined templates.
|
||||||
|
- [ ] Live preview local server.
|
||||||
|
|
||||||
|
## Contribution
|
||||||
|
|
||||||
|
Zona is a small project maintained by a very busy graduate student. If you want to contribute, you are more than welcome to submit issues and pull requests.
|
||||||
|
|
||||||
## Inspirations
|
## Inspirations
|
||||||
|
|
||||||
- [Zoner](https://git.sr.ht/~ryantrawick/zoner)
|
- [Zoner](https://git.sr.ht/~ryantrawick/zoner)
|
||||||
- Zonelets
|
- [Zonelets](https://zonelets.net/)
|
||||||
|
|
||||||
|
> Note: I am aware of `Zola`, and the similar name is entirely a coincidence. I have never used it, nor read its documentation, thus it is not listed as an inspiration.
|
||||||
|
|
|
||||||
106
README.md.orig
Normal file
106
README.md.orig
Normal file
|
|
@ -0,0 +1,106 @@
|
||||||
|
# Zona
|
||||||
|
|
||||||
|
Zona is a tool for building a static website, optimized for lightweight blogs following minimalist design principles.
|
||||||
|
|
||||||
|
**Warning:** Zona has not yet reached **v1**. The `dev-*` branches of this repository contain the code -- however, there is no assurance of stability or functionality until the first release. Configuration and usage documentation will also be provided at this time.
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Features](#v1-features)
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Roadmap](#roadmap)
|
||||||
|
|
||||||
|
## 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`
|
||||||
|
|
||||||
|
```Bash
|
||||||
|
# On Arch Linux
|
||||||
|
sudo pacman -S go
|
||||||
|
|
||||||
|
# On Ubuntu/Debian
|
||||||
|
sudo apt install go
|
||||||
|
```
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
First, download the repository and open it:
|
||||||
|
|
||||||
|
```Bash
|
||||||
|
git clone https://github.com/ficcdaf/zona.git && cd zona
|
||||||
|
```
|
||||||
|
|
||||||
|
On Linux:
|
||||||
|
|
||||||
|
```Bash
|
||||||
|
# run the provided build script
|
||||||
|
./build.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
On other platforms:
|
||||||
|
|
||||||
|
```Bash
|
||||||
|
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.
|
||||||
|
=======
|
||||||
|
- [Contribution](#contribution)
|
||||||
|
- [Inspirations](#inspirations)
|
||||||
|
|
||||||
|
## Design Goals
|
||||||
|
|
||||||
|
Zona is intended to be easy-to-use. A user should be able to build a reasonably complex website or blog with only a directory of Markdown content and a single command, without needing to write any HTML or configuration. However, users should optionally have access to sensible and flexible configuration options, including writing HTML. The output of Zona should also be lightweight, retaining the smallest file sizes possible. These characteristics make Zona well-suited for both beginners and power users that wish to host a website on a service like Neocities or GitHub Pages.
|
||||||
|
|
||||||
|
## v1 Features
|
||||||
|
|
||||||
|
- Write pages purely in Markdown.
|
||||||
|
- Single-command build process.
|
||||||
|
- Lightweight output.
|
||||||
|
- Sensible default template and stylesheet.
|
||||||
|
- Configuration entirely optional, but very powerful.
|
||||||
|
- Site header and footer defined in Markdown.
|
||||||
|
- Declarative metadata per Markdown file.
|
||||||
|
- Automatically generated `Archive`, `Recent Posts`, and `Image Gallery` elements.
|
||||||
|
- Support for custom stylesheets, favicons, and page templates.
|
||||||
|
|
||||||
|
## Roadmap
|
||||||
|
|
||||||
|
- [ ] RSS/Atom feed generation.
|
||||||
|
- [ ] Image optimization & dithering.
|
||||||
|
- [ ] Windows, Mac, Linux releases.
|
||||||
|
- [ ] AUR package.
|
||||||
|
- [ ] Custom Markdown tags that expand to user-defined templates.
|
||||||
|
- [ ] Live preview local server.
|
||||||
|
|
||||||
|
## Contribution
|
||||||
|
|
||||||
|
Zona is a small project maintained by a very busy graduate student. If you want to contribute, you are more than welcome to submit issues and pull requests.
|
||||||
|
>>>>>>> e368126 (Update readme)
|
||||||
|
|
||||||
|
## Inspirations
|
||||||
|
|
||||||
|
- [Zoner](https://git.sr.ht/~ryantrawick/zoner)
|
||||||
|
<<<<<<< HEAD
|
||||||
|
- Zonelets
|
||||||
|
=======
|
||||||
|
- [Zonelets](https://zonelets.net/)
|
||||||
|
|
||||||
|
> Note: I am aware of `Zola`, and the similar name is entirely a coincidence. I have never used it, nor read its documentation, thus it is not listed as an inspiration.
|
||||||
|
>>>>>>> e368126 (Update readme)
|
||||||
Loading…
Add table
Add a link
Reference in a new issue