From ea286868b70645ff96cc9fa936c499197f80e84c Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 23 Mar 2025 22:49:28 -0400 Subject: [PATCH] updated readme --- README.md | 70 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 37 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index bca9e60..fae69c8 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,23 @@ # Zona -Zona is a tool for building a static website, optimized for lightweight blogs -following minimalist design principles. +[Zona](https://sr.ht/~ficd/zona/) is a tool for building a static website, +optimized for lightweight blogs following minimalist design principles. The +project is hosted on [sourcehut](https://sr.ht/~ficd/zona/) and mirrored on +[GitHub](https://github.com/ficcdaf/zona). You are welcome to open an issue on +GitHub or send a message to the +[mailing list](https://lists.sr.ht/~ficd/zona-devel). -> [!NOTE] -> Zona is currently in development. The `main` branch of this repository -> does not yet contain the software. The `dev-stable` branch contains the code -> used to generate [ficd.ca](https://ficd.ca) -- although the program is -> undocumented and missing features, so please proceed at your own risk. The -> `dev` branch contains the latest development updates and is not guaranteed to -> be functional (or even compile) at any given commit. Kindly note that the -> commit history will be cleaned up before the program is merged into the `main` -> branch. + +> [!NOTE] +> Zona is currently in development. The `main` branch of this repository does +> not yet contain the software. The `dev-stable` branch contains the code used +> to generate [ficd.ca](https://ficd.ca) -- although the program is undocumented +> and missing features, so please proceed at your own risk. The `dev` branch +> contains the latest development updates and is not guaranteed to be functional +> (or even compile) at any given commit. Kindly note that the commit history +> will be cleaned up before the program is merged into the `main` branch. + ## Design Goals @@ -26,31 +31,30 @@ 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. -## Feature Progress +## Features Implemented -- [x] Write pages purely in Markdown. -- [x] Single-command build process. -- [x] Lightweight output. -- [x] Sensible default template and stylesheet. -- [x] Configuration file. -- [x] Internal links preserved. -- [x] Custom image element parsing & formatting. -- [x] Site header and footer defined in Markdown. -- [x] YAML frontmatter support. -- [ ] Automatically treat contents of `posts/` directory as blog posts. -- [ ] Automatically generated `Archive`, `Recent Posts`, and `Image Gallery` [ ] - elements. -- [ ] Support for custom stylesheets, favicons, and page templates. -- [ ] Image optimization and dithering. -- [ ] Custom markdown tags that expand to user-defined templates. -- [ ] Live preview server. -- [ ] Robust tests. +- Write pages purely in Markdown. +- Single-command build process. +- Lightweight output. +- Sensible default template and stylesheet. +- Configuration file. +- Internal links preserved. +- Custom image element parsing & formatting. +- Site header and footer defined in Markdown. +- YAML frontmatter support. + +## Planned Features + +- Automatically treat contents of `posts/` directory as blog posts. +- Automatically generated `Archive`, `Recent Posts`, and `Image Gallery` + elements. +- Support for custom stylesheets, favicons, and page templates. +- Image optimization and dithering. +- Custom markdown tags that expand to user-defined templates. +- Live preview server. +- Robust tests. ## Inspirations - [Zoner](https://git.sr.ht/~ryantrawick/zoner) - [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.