💾 Archived View for alltext.umaneti.net › fronde › README.gmi captured on 2024-07-08 at 23:20:20. Gemini links have been rewritten to link to archived content

-=-=-=-=-=-=-

Fronde

What's fronde for?

file:./tigre.png

Fronde is an opinionated static website generator for Org[1]. It helps you convert Org mode files into websites, giving you full control over the publication process.

[1] Org (HTTPS)

Features

Inherits all Org mode features[1] (tables, syntax highlighting, code blocks evaluation, multiple languages support…)
Does not require any emacs lisp knowledge
Does not require any server-side code, nor databases, only a simple http server like apache, nginx, lighttpd, hiawatha…
Allows fine customization of generated html files
Allows multiple sources for your Org file and lets you organize them as you wish in the destination folder
Can use different themes for different sources
Supports tags and ATOM feeds[2]

[1] Org mode features (HTTPS)

[2] ATOM feeds (HTTPS)

Announcements

See the ./NEWS.gmi[1] file.

[1] ./NEWS.gmi

Quick install

Fronde is a Ruby gem[1]. You need a working Ruby environment to use it. We recommend that you use RVM[2] and a specific gemset. However fronde works with a global ruby installation too.

rvm get latest
rvm install ruby-3.2.2
rvm use ruby-3.2.2@fronde --create
gem install fronde

Now you're ready to create your first fronde website.

mkdir mywebite
cd mywebsite
fronde init -t "My first fronde website"
fronde build
fronde preview

[1] Ruby gem (HTTPS)

[2] RVM (HTTPS)

Contributing

Fronde is proudly following the Contributor Covenant Code of Conduct[1].

[1] Contributor Covenant Code of Conduct

Translations

You can fetch the yaml files directly from the source code tree[1] and send your changes as a pull request (see bellow) or by email, as you prefer.

[1] source code tree

Code

The canonical repository is located at https://git.umaneti.net/fronde[1]. A mirror also exists on Framagit[2] and Github[3].

Merge requests and issues are accepted both on framagit and github, or by mail to the main author.

[1] https://git.umaneti.net/fronde (HTTPS)

[2] Framagit (HTTPS)

[3] Github (HTTPS)

Support

You can help me a lot by giving me some tip, either through Liberapay[1] or Paypal[2]. Thank you very much!

[1] Liberapay (HTTPS)

[2] Paypal (HTTPS)

Going further

Please refer to the ./DOCUMENTATION.gmi[1] file.

[1] ./DOCUMENTATION.gmi

📅

📝 Étienne Deparis with GNU/Emacs 29.4 (Org mode 9.7.6)

propelled by fronde