Update README.md

This commit is contained in:
Vincent Prouillet 2018-08-04 15:39:21 +02:00 committed by GitHub
parent 3db404c9f9
commit f0ba604075
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -10,7 +10,7 @@ in the `docs/content` folder of the repository.
## Comparisons with other static site generators ## Comparisons with other static site generators
| | Gutenberg | Cobalt | Hugo | Pelican | | | Gutenberg | Cobalt | Hugo | Pelican |
|--------------------------|-----------|--------|------|---------| |:-------------------------------:|:---------:|--------|------|---------|
| Single binary | ✔ | ✔ | ✔ | ✕ | | Single binary | ✔ | ✔ | ✔ | ✕ |
| Language | Rust | Rust | Go | Python | | Language | Rust | Rust | Go | Python |
| Syntax highlighting | ✔ | ✔ | ✔ | ✔ | | Syntax highlighting | ✔ | ✔ | ✔ | ✔ |
@ -18,7 +18,7 @@ in the `docs/content` folder of the repository.
| Assets co-location | ✔ | ✔ | ✔ | ✔ | | Assets co-location | ✔ | ✔ | ✔ | ✔ |
| i18n | ✕ | ✕ | ✔ | ✔ | | i18n | ✕ | ✕ | ✔ | ✔ |
| Image processing | ✔ | ✕ | ✔ | ✔ | | Image processing | ✔ | ✕ | ✔ | ✔ |
| Sane template engine | ✔ | ✔ | ✕✕✕ | ✔ | | Sane & powerful template engine | ✔ | ~ | ~ | ✔ |
| Themes | ✔ | ✕ | ✔ | ✔ | | Themes | ✔ | ✕ | ✔ | ✔ |
| Shortcodes | ✔ | ✕ | ✔ | ✔ | | Shortcodes | ✔ | ✕ | ✔ | ✔ |
| Internal links | ✔ | ✕ | ✔ | ✔ | | Internal links | ✔ | ✕ | ✔ | ✔ |
@ -33,14 +33,22 @@ in the `docs/content` folder of the repository.
| LiveReload | ✔ | ✕ | ✔ | ✔ | | LiveReload | ✔ | ✕ | ✔ | ✔ |
| Netlify support | ✔ | ✕ | ✔ | ✕ | | Netlify support | ✔ | ✕ | ✔ | ✕ |
Supported content formats:
### Supported content formats
- Gutenberg: markdown - Gutenberg: markdown
- Cobalt: markdown - Cobalt: markdown
- Hugo: markdown, asciidoc, org-mode - Hugo: markdown, asciidoc, org-mode
- Pelican: reStructuredText, markdown, asciidoc, org-mode, whatever-you-want - Pelican: reStructuredText, markdown, asciidoc, org-mode, whatever-you-want
Note that many features of Pelican are coming from plugins, which might be tricky ### Template engine explanation
Cobalt gets `~` as, while based on [Liquid](https://shopify.github.io/liquid/), the Rust library doesn't implement all its features but there is no documentation on what is and isn't implemented. The errors are also cryptic. Liquid itself is not powerful enough to do some of things you can do in Jinja2, Go templates or Tera.
Hugo gets `~`. It is probably the most powerful template engine in the list after Jinja2 (hard to beat python code in templates) but personally drives me insane, to the point of writing my own template engine and static site generator. Yes, this is a bit biased.
### 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 to use because of version mismatch or lacking documentation. Netlify supports Python
and Pipenv but you still need to install your dependencies manually. and Pipenv but you still need to install your dependencies manually.