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

updated README

Browse source 
update readme

upd
This commit is contained in:
Daniel Fichtinger 2025-01-11 02:03:51 -05:00
parent 2d3480e94d
commit 1c05dd4a46
1 changed files with 42 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

77
README.md
View file

@ -1,49 +1,56 @@
# Zona # Zona
Zona is a tool for building a static website, optimized for lightweight blogs following minimalist design principles. 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. <!-- prettier-ignore-start -->
> [!NOTE]
## Table of Contents > Zona is currently in development. The `main` branch of this repository
> does not yet contain the software. The `dev-stable` branch contains the code
- [Design Goals](#design-goals) > used to generate [ficd.ca](https://ficd.ca) -- although the program is
- [v1 Features](#v1-features) > undocumented and missing features, so please proceed at your own risk. The
- [Roadmap](#roadmap) > `dev` branch contains the latest development updates and is not guaranteed to
- [Contribution](#contribution) > be functional (or even compile) at any given commit. Kindly note that the
- [Inspirations](#inspirations) > commit history will be cleaned up before the program is merged into the `main`
> branch.
<!-- prettier-ignore-end -->
## Design Goals ## 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. 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 ## Feature Progress
- Write pages purely in Markdown. - [x] Write pages purely in Markdown.
- Single-command build process. - [x] Single-command build process.
- Lightweight output. - [x] Lightweight output.
- Sensible default template and stylesheet. - [x] Sensible default template and stylesheet.
- Configuration entirely optional, but very powerful. - [x] Configuration file.
- Site header and footer defined in Markdown. - [x] Internal links preserved.
- Declarative metadata per Markdown file. - [x] Custom image element parsing & formatting.
- Automatically generated `Archive`, `Recent Posts`, and `Image Gallery` elements. - [x] Site header and footer defined in Markdown.
- Support for custom stylesheets, favicons, and page templates. - [x] YAML frontmatter support.
- [ ] Automatically treat contents of `posts/` directory as blog posts.
## Roadmap - [ ] Automatically generated `Archive`, `Recent Posts`, and `Image Gallery` [ ]
elements.
- [ ] RSS/Atom feed generation. - [ ] Support for custom stylesheets, favicons, and page templates.
- [ ] Image optimization & dithering. - [ ] Image optimization and dithering.
- [ ] Windows, Mac, Linux releases. - [ ] Custom markdown tags that expand to user-defined templates.
- [ ] AUR package. - [ ] Live preview server.
- [ ] Custom Markdown tags that expand to user-defined templates. - [ ] Robust tests.
- [ ] 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](https://zonelets.net/) - [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. > 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.