Skip to content

Instantly share code, notes, and snippets.

@briandominick
Last active March 11, 2024 18:24
Show Gist options
  • Star 95 You must be signed in to star a gist
  • Fork 8 You must be signed in to fork a gist
  • Save briandominick/e5754cc8438dd9503d936ef65fffbb2d to your computer and use it in GitHub Desktop.
Save briandominick/e5754cc8438dd9503d936ef65fffbb2d to your computer and use it in GitHub Desktop.
Static Site Generators with AsciiDoc Support

There are 28 static site generators that support AsciiDoc sourcing.

Application AsciiDoc Support Source Templates Web Notes

11ty

plugin

Node.js

Liquid, Nunjucks, Handlebars, Mustache, EJS, Haml, Pug

  • MIT License

Antora

native

Node.js

Handlebars

  • Maintained by lead contributors to the Asciidoctor project.

  • Mozilla Public License 2.0

AsciiBinder

native

Ruby

Tilt, ERB

  • Maintainers now recommend Antora!

  • MIT License

asciidoc-site-generator

native

Node.js

Handlebars

  • MIT License

Astro

plugin

JavaScript

Astro (JSX-like)

  • MIT License

AweStruct

native

Ruby

Haml

  • MIT License

Cryogen

native

Clojure

Selmer

  • Eclipse Public License 1.0

Dev-Mind Website

native

NodeJS

Handlebars, Gulp

  • MIT License

DocPad

plugin

Coffeescript

Eco, Jade, Haml

  • MIT License

Docsify

plugin

JavaScript

Markdown

  • MIT License

Grain

native

Groovy

Groovy

  • Apache License 2.0

Gatsby

plugin

React JS

JSX

  • MIT License

Gollum Wiki

native

Ruby

Mustache

  • MIT License

Hexo

plugin

NodeJS

Swig, EJS, Haml, Jade, Pug

  • MIT License

Hugo

native

Go

Go

  • Apache License 2.0

JBake

native

Java

Freemarker, Groovy, Thymeleaf, Jade, Pebble

  • Apache License 2.0

Jekyll

plugin

Ruby

Liquid

  • Plugin maintained by Asciidoctor.

  • MIT License

Metalsmith

plugin

JavaScript

Handlebars

  • MIT License

Middleman

native

Ruby

ERB, Haml

  • Plugin maintained by Asciidoctor.

  • MIT License

Nanoc

native

Ruby

ERB

  • MIT License

Nikola

plugin

Python

Mako, Jinja2

  • MIT License

Nuxt

plugin

Vue.js

Vue

  • MIT License

Orchid

plugin

Java

Pebble

  • MIT License

Pelican

native

Python

Jinja2

  • Uses legacy AsciiDoc for conversion.

  • GNU Affero General Public License 3.0

PzdcDoc

native

Java

Jinja2

  • Apache License 2.0

Shitty SSG

native

Go

Go

  • MIT License

Spring REST Docs

native

Gradle

Mustache

  • Apache License 2.0

SvelteKit

plugin

JavaScript

Svelte

  • MIT License

@benelog
Copy link

benelog commented Apr 12, 2019

Jbake also supports AsciiDoc.

@schauder
Copy link

The link for jekyll is wrong, it should be https://jekyllrb.com/

@briandominick
Copy link
Author

Thanks @schauder, and what an awesome entry, @benelog. Updated and alphabetized.

@benelog
Copy link

benelog commented May 4, 2019

Thank you for the update.
I found one more, Orchid supports AsciiDoc.

@briandominick
Copy link
Author

I am working on a way to source this in YAML and convert with AsciiDoc. The tooling is not quite ready, but I found some new SSGs and wanted to get them added before Write the Docs Portland, so we can show off the growth and reach of AsciiDoc! So I used the tool to generate this and will eventually automate publishing this Gist on update. I'll be releasing it all shortly.

@briandominick
Copy link
Author

I just added GitBook but immediately removed it when someone noted that the currently supported version does not support AsciiDoc. Bummer.

@mojavelinux
Copy link

Awestruct is now defunct (despite the fact that it's still used for asciidoctor.org).

The Middleman plugin is also maintained by Asciidoctor atm.

@bbatsov
Copy link

bbatsov commented Jun 13, 2019

@briandominick
Copy link
Author

Very cool @bbatsov -- I've added it. First Clojure and Selmer entries!

@kito99
Copy link

kito99 commented Sep 5, 2019

Are any of these good for blogs other than cryogen?

@Pingvin235
Copy link

pzdcdoc.org - it is not exactly site, but more documentation book. Extended AsciiDoctor, written on Java.

@korbendallaskoop
Copy link

Awesome list, thanks Brian
Grain seems to be stale if not defunct, groovy no more
https://github.com/sysgears/grain/issues
https://github.com/sysgears/grain/graphs/code-frequency

@shomodj
Copy link

shomodj commented Jun 17, 2020

https://github.com/gollum/gollum#markups is a wiki with optional asciidoc support

@ojn
Copy link

ojn commented Jan 20, 2021

This is a good one https://github.com/Dev-Mind/devmind-website
actually one of the best static site generators with asciidoc support (Asciidoctor.js) I found yet, the author is very humble and states "it is a Node module for Asciidoctor.js and Handlebars using Gulp". In my opinion it deserves to be a full fledged SSG with themes, plugins and everything.

@korbendallaskoop
Copy link

came across Hexo while checking the https://gitlab.com/pages SSGs

"....Hexo support posts written in any format, so long the corresponding renderer plugin is installed. It can be in markdown, ejs, swig, nunjucks, pug, asciidoc, etc. Regardless of the format used, those three code block syntax will always be available."

https://hexo.io/docs/syntax-highlight#How-to-use-code-block-in-posts

@hahaleyile
Copy link

Awesome!

@patrickdung
Copy link

For Pelican plugin, by default, it supports legacy asciidoc and asciidoctor.
It would use asciidoc if it is installed.
If you want to use asciidoctor then just uninstall asciidoc and then install asciidoctor only.

https://github.com/getpelican/pelican-plugins/blob/master/asciidoc_reader/asciidoc_reader.py#L44

@ioannisstavrakakis
Copy link

Is there a mistake on Antora? Should the source language be JavaScript (based on https://jamstack.org/generators/antora/)?

@kurt-krueckeberg
Copy link

Very helpful. Thanks!

@childnode
Copy link

JBake supports also pebble now https://jbake.org/docs/latest/#templates_directory

Application AsciiDoc Support Source Lang Template Lang
docToolChain native Groovy arc42

is wrong in my eyes since

  • it is not native, it uses asciidoctor or other generators with asciidoc support
  • srcLang is java to me since it uses jbake, perhaps there are bash / powershell scripts around that ..
  • Template Lang is defined by jbake

Application AsciiDoc Support Source Lang Template Lang
Hugo plugin

I don't see that there is an optional plugin but you have to just install the asciidoc command, then the converter can be called for .adoc ?! can't it?
^^ what is the definition of "native" and "plugin" here?

@brettaufheber
Copy link

Nice list, I would like to ask whether this app can be part of this list.

Application AsciiDoc Support Source Lang Template Lang Web Resources Notes
asciidoc-site-generator native (asciidoctor) JavaScript (Node.js) Handlebars Source GitHub A website generator with very small footprint.

@ahus1
Copy link

ahus1 commented Mar 22, 2023

The links for Shitty SSG seem broken to me. The new link might be https://codeberg.org/ewintr/shitty-ssg

@clawson
Copy link

clawson commented Jun 29, 2023

The links for Shitty SSG seem broken to me. The new link might be https://codeberg.org/ewintr/shitty-ssg

That link is broken too. I found this one: https://ewintr.nl/shitty-ssg/

@atharvashukla
Copy link

Thank you! This is really helpful

@briandominick
Copy link
Author

I have just posted a major update to this matrix. I removed a couple of tools and added several. I also made lots of corrections to the info and formatting, as well as adding FOSS licenses for each. I intend to release the source code for the YAML I use to maintain all of this data, as well as the template I use to parse it into AsciIDoc, as soon as I can get the rest of its parent repo ready for public release. Happy to take comments, suggestions, additions, etc.

NOTE: I removed LiquiDoc and docToolChain because I believe they are more like frameworks than SSGs themselves. I am going to create/add a file for frameworks and other integrations at some point.

@Malix-off
Copy link

Malix-off commented Mar 9, 2024

Next step (and a very important one) would be Astro

@osbyrne
Copy link

osbyrne commented Mar 9, 2024

Next step (and a very important one) would be Astro

I second this proposal

@lizhongyue248
Copy link

Next step (and a very important one) would be Astro

+1

@briandominick
Copy link
Author

Added Astro, by sudden popular demand.

@robb-romans
Copy link

Added Astro, by sudden popular demand.

💯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment