1a9ab968fe
Justification for this feature is added in the docs.
Precedent for the precise syntax: Hugo.
Hugo puts this syntax behind a preference named headerIds, and automatic
header ID generation behind a preference named autoHeaderIds, with both
enabled by default. I have not implemented a switch to disable this.
My suggestion for a workaround for the improbable case of desiring a
literal “{#…}” at the end of a header is to replace `}` with `}`.
The algorithm I have used is not identical to [that
which Hugo uses][0], because Hugo’s looks to work at the source level,
whereas here we work at the pulldown-cmark event level, which is
generally more sane, but potentially limiting for extremely esoteric
IDs.
Practical differences in implementation from Hugo (based purely on
reading [blackfriday’s implementation][0], not actually trying it):
- I believe Hugo would treat `# Foo {#*bar*}` as a heading with text
“Foo” and ID `*bar*`, since it is working at the source level; whereas
this code turns it into a heading with HTML `Foo {#<em>bar</em>}`, as
it works at the pulldown-cmark event level and doesn’t go out of its
way to make that work (I’m not familiar with pulldown-cmark, but I get
the impression that you could make it work Hugo’s way on this point).
The difference should be negligible: only *very* esoteric hashes would
include magic Markdown characters.
- Hugo will automatically generate an ID for `{#}`, whereas what I’ve
coded here will yield a blank ID instead (which feels more correct to
me—`None` versus `Some("")`, and all that).
In practice the results should be identical.
Fixes #433.
[0]:
|
||
|---|---|---|
| .github | ||
| ci | ||
| completions | ||
| components | ||
| docs | ||
| src | ||
| sublime_syntaxes | ||
| sublime_themes | ||
| test_site | ||
| test_site_i18n | ||
| .editorconfig | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| appveyor.yml | ||
| build.rs | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| EXAMPLES.md | ||
| is-ehh.svg | ||
| is-no.svg | ||
| is-yes.svg | ||
| LICENSE | ||
| netlify.toml | ||
| README.md | ||
| rustfmt.toml | ||
| snapcraft.yaml | ||
zola (né Gutenberg)
A fast static site generator in a single binary with everything built-in.
Documentation is available on its site or
in the docs/content folder of the repository and the community can use its forum.
Comparisons with other static site generators
| Zola | Cobalt | Hugo | Pelican | |
|---|---|---|---|---|
| Single binary |  |
|
|
 |
| Language | Rust | Rust | Go | Python |
| Syntax highlighting | |
|
|
|
| Sass compilation | |
|
|
|
| Assets co-location | |
|
|
|
| Multilingual site |  |
|
|
|
| Image processing | |
|
|
|
| Sane & powerful template engine | |
|
|
|
| Themes | |
|
|
|
| Shortcodes | |
|
|
|
| Internal links | |
|
|
|
| Link checker | |
|
|
|
| Table of contents | |
|
|
|
| Automatic header anchors | |
|
|
|
| Aliases | |
|
|
|
| Pagination | |
|
|
|
| Custom taxonomies | |
|
|
|
| Search | |
|
|
|
| Data files | |
|
|
|
| LiveReload | |
|
|
|
| Netlify support | |
|
|
|
| Breadcrumbs | |
|
|
|
| Custom output formats | |
|
|
|
Supported content formats
- Zola: markdown
- Cobalt: markdown
- Hugo: markdown, asciidoc, org-mode
- Pelican: reStructuredText, markdown, asciidoc, org-mode, whatever-you-want
explanations
Hugo gets for the template engine because while it is probably the most powerful template engine in the list, after Jinja2, it personally drives me insane, to the point of writing my own template engine and static site generator. Yes, this is a bit biased.
Zola gets for the multi-language support as it only has a basic support and does not offer (yet) things like i18n in templates.
Pelican notes
Many features of Pelican are coming from plugins, which might be tricky to use because of version mismatch or lacking documentation. Netlify supports Python and Pipenv but you still need to install your dependencies manually.