README.org

Ox-Zola

Ox-zola is an Org exporter backend that streamlines Emacs users’ conversion from Org mode to Markdown, caring for both the body and the TOML frontmatter in a way that’s compatible with the static site generator Zola.

It started as a fork of the famous ox-hugo exporter, but it now is a different package that runs on top of ox-hugo itself.

This way, you can receive ox-hugo updates without being restrained by the progress of this package. Even so, I suggest pinning ox-hugo to the most recent working version to avoid breaking changes after updates.

Being this package built like a layer on top of ox-hugo, most of the stuff you can do with ox-hugo is possible with ox-zola too; so, I suggest reading the ox-hugo documentation to have a grasp of how the entire exporter works.

Usually, people use a single static site generator, but if you have different websites that happen to be generated with Zola and Hugo, you’re covered. ox-zola doesn’t break ox-hugo!

If something doesn’t go the right way, remember that you can open an issue and we can work together for solving the problem. Enhancement requests are appreciated too.

Installation

Since this package was born for my personal use and it’s not perfect yet, I didn’t make it available on Melpa. However, you can install it directly from this repository.

Install with straight:

(straight-use-package
 '(ox-zola :host github :repo "gicrisf/ox-zola"
   :files (:defaults "*.el" "backend" "stylesheets")
   :includes ox-hugo))

Install with use-package:

(use-package ox-zola
    :ensure t
    :config
    (require 'ox-hugo))

If you’re on Doom Emacs like me, you can install with the package! macro:

;; Remember, org-hugo is required
(package! ox-hugo)
(package! ox-zola :recipe (:host github :repo "gicrisf/ox-zola"))

Features

• [X] Custom frontmatters parameters for Zola
• [X] Lastmod/updated tags for Zola
• [X] Taxonomies for Zola
• [X] Zola shortcodes
• [X] Exports with images
• [X] Avoid breaking ox-hugo functions while ox-zola is installed.
• [X] Differentiate front-matter items for Zola and Hugo in the same org drawer

Donate

Did you find this package useful? Why don’t you help me keep awake by buying me a coffee?

License

Open sourced under the GPL-3.0 license.