You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 3.3KB

2 years ago
3 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. # zola (né Gutenberg)
  2. [![Build Status](https://dev.azure.com/getzola/zola/_apis/build/status/getzola.zola?branchName=master)](https://dev.azure.com/getzola/zola/_build/latest?definitionId=1&branchName=master)
  3. A fast static site generator in a single binary with everything built-in.
  4. Documentation is available on [its site](https://www.getzola.org/documentation/getting-started/installation/) or
  5. in the `docs/content` folder of the repository and the community can use [its forum](https://zola.discourse.group).
  6. ## Comparisons with other static site generators
  7. | | Zola | Cobalt | Hugo | Pelican |
  8. |:--------------------------------|:------:|:------:|:------:|:-------:|
  9. | Single binary | ![yes] | ![yes] | ![yes] | ![no] |
  10. | Language | Rust | Rust | Go | Python |
  11. | Syntax highlighting | ![yes] | ![yes] | ![yes] | ![yes] |
  12. | Sass compilation | ![yes] | ![yes] | ![yes] | ![yes] |
  13. | Assets co-location | ![yes] | ![yes] | ![yes] | ![yes] |
  14. | Multilingual site | ![ehh] | ![no] | ![yes] | ![yes] |
  15. | Image processing | ![yes] | ![no] | ![yes] | ![yes] |
  16. | Sane & powerful template engine | ![yes] | ![yes] | ![ehh] | ![yes] |
  17. | Themes | ![yes] | ![no] | ![yes] | ![yes] |
  18. | Shortcodes | ![yes] | ![no] | ![yes] | ![yes] |
  19. | Internal links | ![yes] | ![no] | ![yes] | ![yes] |
  20. | Link checker | ![yes] | ![no] | ![no] | ![yes] |
  21. | Table of contents | ![yes] | ![no] | ![yes] | ![yes] |
  22. | Automatic header anchors | ![yes] | ![no] | ![yes] | ![yes] |
  23. | Aliases | ![yes] | ![no] | ![yes] | ![yes] |
  24. | Pagination | ![yes] | ![no] | ![yes] | ![yes] |
  25. | Custom taxonomies | ![yes] | ![no] | ![yes] | ![no] |
  26. | Search | ![yes] | ![no] | ![no] | ![yes] |
  27. | Data files | ![yes] | ![yes] | ![yes] | ![no] |
  28. | LiveReload | ![yes] | ![no] | ![yes] | ![yes] |
  29. | Netlify support | ![yes] | ![no] | ![yes] | ![no] |
  30. | ZEIT Now support | ![yes] | ![no] | ![yes] | ![yes] |
  31. | Breadcrumbs | ![yes] | ![no] | ![no] | ![yes] |
  32. | Custom output formats | ![no] | ![no] | ![yes] | ![no] |
  33. ### Supported content formats
  34. - Zola: markdown
  35. - Cobalt: markdown
  36. - Hugo: markdown, asciidoc, org-mode
  37. - Pelican: reStructuredText, markdown, asciidoc, org-mode, whatever-you-want
  38. ### ![ehh] explanations
  39. Hugo gets ![ehh] 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.
  40. Zola gets ![ehh] for multi-language support as it only has a basic support and does not (yet) offer things like i18n in templates.
  41. ### Pelican notes
  42. Many features of Pelican come from plugins, which might be tricky to use because of a version mismatch or inadequate documentation. Netlify supports Python and Pipenv but you still need to install your dependencies manually.
  43. [yes]: ./is-yes.svg
  44. [ehh]: ./is-ehh.svg
  45. [no]: ./is-no.svg