Merge pull request #593 from bdjnk/readme

use svg icon in comparison table, tighten notes prose
2019-04-11 19:17:48 +02:00 · 2019-04-11 19:17:48 +02:00 · 83477e757a
parent f1a3045059 101550324f
commit 83477e757a
4 changed files with 39 additions and 31 deletions
--- a/README.md
+++ b/README.md
@ -1,4 +1,5 @@
 # zola (né Gutenberg)
+
 [![Build Status](https://travis-ci.com/getzola/zola.svg?branch=master)](https://travis-ci.com/getzola/zola)
 [![Build status](https://ci.appveyor.com/api/projects/status/i0ufvx2sdm2cmawo/branch/master?svg=true)](https://ci.appveyor.com/project/Keats/zola/branch/master)

@ -10,31 +11,30 @@ in the `docs/content` folder of the repository and the community can use [its fo
 ## Comparisons with other static site generators

 |                                 | Zola                 | Cobalt               | Hugo                 | Pelican              |
-|:-------------------------------:|:---------:|--------|------|---------|
-| Single binary                   |     ✔     |    ✔   |   ✔  |    ✕    |
+|:--------------------------------|:--------------------:|:--------------------:|:--------------------:|:--------------------:|
+| Single binary                   | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) | ![no](./is-no.svg)   |
 | 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           |     ✕     |    ✕   |   ✔  |    ?    |
-
+| Syntax highlighting             | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) |
+| Sass compilation                | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) |
+| Assets co-location              | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) |
+| Multilingual site               | ![yes](./is-yes.svg) | ![no](./is-no.svg)   | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) |
+| Image processing                | ![yes](./is-yes.svg) | ![no](./is-no.svg)   | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) |
+| Sane & powerful template engine | ![yes](./is-yes.svg) | ![ehh](./is-ehh.svg) | ![ehh](./is-ehh.svg) | ![yes](./is-yes.svg) |
+| Themes                          | ![yes](./is-yes.svg) | ![no](./is-no.svg)   | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) |
+| Shortcodes                      | ![yes](./is-yes.svg) | ![no](./is-no.svg)   | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) |
+| Internal links                  | ![yes](./is-yes.svg) | ![no](./is-no.svg)   | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) |
+| Link checker                    | ![yes](./is-yes.svg) | ![no](./is-no.svg)   | ![no](./is-no.svg)   | ![yes](./is-yes.svg) |
+| Table of contents               | ![yes](./is-yes.svg) | ![no](./is-no.svg)   | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) |
+| Automatic header anchors        | ![yes](./is-yes.svg) | ![no](./is-no.svg)   | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) |
+| Aliases                         | ![yes](./is-yes.svg) | ![no](./is-no.svg)   | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) |
+| Pagination                      | ![yes](./is-yes.svg) | ![no](./is-no.svg)   | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) |
+| Custom taxonomies               | ![yes](./is-yes.svg) | ![no](./is-no.svg)   | ![yes](./is-yes.svg) | ![no](./is-no.svg)   |
+| Search                          | ![yes](./is-yes.svg) | ![no](./is-no.svg)   | ![no](./is-no.svg)   | ![yes](./is-yes.svg) |
+| Data files                      | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) | ![no](./is-no.svg)   |
+| LiveReload                      | ![yes](./is-yes.svg) | ![no](./is-no.svg)   | ![yes](./is-yes.svg) | ![yes](./is-yes.svg) |
+| Netlify support                 | ![ehh](./is-ehh.svg) | ![no](./is-no.svg)   | ![yes](./is-yes.svg) | ![no](./is-no.svg)   |
+| Breadcrumbs                     | ![yes](./is-yes.svg) | ![no](./is-no.svg)   | ![no](./is-no.svg)   | ![yes](./is-yes.svg) |
+| Custom output formats           | ![no](./is-no.svg)   | ![no](./is-no.svg)   | ![yes](./is-yes.svg) | ![no](./is-no.svg)   |

 ### Supported content formats

@ -45,11 +45,10 @@ in the `docs/content` folder of the repository and the community can use [its fo

 ### 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.
+Cobalt gets ![ehh](./is-ehh.svg) because, while based on [Liquid](https://shopify.github.io/liquid/), the Rust library doesn't implement all its features and there is no documentation on what is and isn't implemented; the errors are cryptic; and 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.
+Hugo gets ![ehh](./is-ehh.svg) 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.

 ### 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.
+
+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.
--- a/is-ehh.svg
+++ b/is-ehh.svg
@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" style="fill:#dbab09" width="16" height="16" viewBox="0 0 24 24">
+  <circle cx="12" cy="12" r="8"/>
+</svg>
--- a/is-no.svg
+++ b/is-no.svg
@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" style="fill:#cb2431" width="16" height="16" viewBox="0 0 24 24">
+  <path d="M23 20.168l-8.185-8.187 8.185-8.174-2.832-2.807-8.182 8.179-8.176-8.179-2.81 2.81 8.186 8.196-8.186 8.184 2.81 2.81 8.203-8.192 8.18 8.192z"/>
+</svg>
--- a/is-yes.svg
+++ b/is-yes.svg
@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" style="fill:#28a745" width="16" height="16" viewBox="0 0 24 24">
+  <path d="M9 21.035l-9-8.638 2.791-2.87 6.156 5.874 12.21-12.436 2.843 2.817z"/>
+</svg>