Abbaye — 00fdabf

Commit

Hash: 00fdabf0a6b15d61fc5fa581779f2ba7538e35fb
Author: ololduck <ololduck@vit.am>
Date: 2026-05-31 16:59 UTC
Parent: 672037d

Message

docs: Add customization info to crate docs/README

Changed Files (3)

modified CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md

index 457bb76..9568e2b 100644

--- a/CHANGELOG.md

+++ b/CHANGELOG.md

@@ -3,10 +3,14 @@

### 🚀 Features

- Add CLI and config serialization

+- Add repository URL support

+- Add changelog to releases.atom feed

+- Add theming support

### 🐛 Bug Fixes

- Remove builder artifact hashing as it is done on site build

+- Remove central wheel from logo

### 📚 Documentation

modified README.md

diff --git a/README.md b/README.md

index 60c4d2e..93fcdba 100644

--- a/README.md

+++ b/README.md

@@ -33,7 +33,9 @@ Here's an example file structure:

## Why ?

-This piece of software is for people that can't or won't use a full-featured forge such as GitHub, GitLab, ForgeJo & others. These forges provide "release pages" that allow you to upload and distribute your software, as well as get a changelog.

+This piece of software is for people that can't or won't use a full-featured forge such as GitHub, GitLab, ForgeJo & others.

+These forges provide "release pages" that allow you to upload and distribute your software, as well as get a changelog.

Abbaye is made to be a simple, lightweight alternative to these forges, for the release/documentation parts.

### Why "Abbaye" ?

@@ -89,4 +91,22 @@ Then run `abbaye build` to build the site. The site will be generated in the `pu

Now you can copy the contents of `public/` to your web server to deploy the site. For instance, with rsync:

`rsync --progress -avz --links --perms --update public/ ololduck@vit.am:public_html/abbaye/`

+### ✨ Customization ✨

+You can dump the default theme/templates to your local filesystem with `abbaye dump-theme`.

+This will create a `.abbaye/theme/` directory in your current directory with the default templates, which you can then ✨customize✨.

+## Future plans

+- [x] Add support for theming

+- [ ] Add support for more site variables, such as the site title, description, and author, or even a custom footer and stuff.

+- [ ] Add support for a `self-update`-like command to update the abbaye binary to the latest version. The mechanisms put in place for this goal should be usable to any user of `abbaye`.

+## Contributing

+Contributions are welcome! As i am mainly a rust developer, i am open to any contributions that improve the project, especially to support more artifacts builders/types.

+Just clone the repository and {send me an email,contact me on {IRC (ololduck@irc.libera.chat),the Fediverse (@ololduck@fosstodon.org)}} with {a link to your fork,a git patch,compliments and adoration}.

License: AGPL-3.0-or-later

modified src/main.rs

diff --git a/src/main.rs b/src/main.rs

index fc1d2b8..43f4855 100644

--- a/src/main.rs

+++ b/src/main.rs

@@ -91,6 +91,18 @@

//! Now you can copy the contents of `public/` to your web server to deploy the site. For instance, with rsync:

//! `rsync --progress -avz --links --perms --update public/ ololduck@vit.am:public_html/abbaye/`

//!

+//! ### ✨ Customization ✨

+//!

+//! You can dump the default theme/templates to your local filesystem with `abbaye dump-theme`.

+//!

+//! This will create a `.abbaye/theme/` directory in your current directory with the default templates, which you can then ✨customize✨.

+//!

+//! ## Future plans

+//!

+//! - [x] Add support for theming

+//! - [ ] Add support for more site variables, such as the site title, description, and author, or even a custom footer and stuff.

+//! - [ ] Add support for a `self-update`-like command to update the abbaye binary to the latest version. The mechanisms put in place for this goal should be usable to any user of `abbaye`.

+//!

//! ## Contributing

//!

//! Contributions are welcome! As i am mainly a rust developer, i am open to any contributions that improve the project, especially to support more artifacts builders/types.