https://github.com/milouse/fronde
A static website generator for Emacs Org mode (Mirror)
https://github.com/milouse/fronde
emacs org-mode ruby static-site-generator
Last synced: 12 days ago
JSON representation
A static website generator for Emacs Org mode (Mirror)
- Host: GitHub
- URL: https://github.com/milouse/fronde
- Owner: milouse
- License: wtfpl
- Created: 2020-11-12T16:28:43.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T22:37:19.000Z (5 months ago)
- Last Synced: 2025-04-13T04:51:55.787Z (12 days ago)
- Topics: emacs, org-mode, ruby, static-site-generator
- Language: Ruby
- Homepage: https://etienne.pflieger.bzh/fronde/
- Size: 1.82 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.org
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.org
Awesome Lists containing this project
- awesome-starred - fronde - A static website generator for Emacs Org mode (Ruby)
README
#+title: Fronde
#+language: en
#+keywords: static website generator, ruby, gem, org mode, emacs
#+description: Fronde is a ruby gem, which helps you to manage your
#+description: static website generated with Org mode* What's fronde for?
#+attr_gmi: :alt A stylized picture of a tiger
#+attr_html: :alt A stylized picture of a tiger head :id tiger_head
[[file:./tigre.png]]Fronde is an opinionated static website generator for [[https://orgmode.org][Org]]. It helps you
convert Org mode files into websites, giving you full control over
the publication process.* Features
- Inherits all [[https://orgmode.org][Org mode features]] (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 [[https://en.wikipedia.org/wiki/Atom_(Web_standard)][ATOM feeds]]* Quick install
Fronde is a [[https://rubygems.org/][Ruby gem]]. You need a working Ruby environment to use it. We
recommend that you use [[https://rvm.io][RVM]] and a specific gemset. However fronde works
with a global ruby installation too.#+caption: Installation procedure with RVM
#+begin_src shell
rvm get latest
rvm install ruby-3.2.2
rvm use ruby-3.2.2@fronde --create
gem install fronde
#+end_srcNow you're ready to create your first fronde website.
#+begin_src shell
mkdir mywebite
cd mywebsite
fronde init -t "My first fronde website"
fronde build
fronde preview
#+end_src* Contributing
#+html:
Fronde is proudly following the [[https://www.contributor-covenant.org/][Contributor Covenant Code of
Conduct]]. You can read it here:[[./CODE_OF_CONDUCT.org][Code of Conduct]]
** Translations
You can fetch the yaml files directly from the [[./locales][source code tree]] and
send your changes as a pull request (see bellow) or by email, as you
prefer.** Code
The canonical repository is located at [[https://git.umaneti.net/fronde]].
A mirror also exists on [[https://github.com/milouse/fronde][Github]].Merge requests and issues are accepted both on framagit and github, or
by mail to the main author.** Support
#+html:
#+html:You can help me a lot by giving me some tip, either through [[https://liberapay.com/milouse][Liberapay]] or
[[https://paypal.me/milouse][Paypal]]. Thank you very much!* Going further
Please refer to the DOCUMENTATION.org file:
[[./DOCUMENTATION.org][Fronde Documentation]]
