-
Notifications
You must be signed in to change notification settings - Fork 920
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add comparison between SSG #247
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,6 +7,30 @@ An opinionated static site generator written in Rust. | |
Documentation is available on [its site](https://www.getgutenberg.io/documentation/getting-started/installation/) or | ||
in the `docs/content` folder of the repository. | ||
|
||
## Comparisons with other static site generators | ||
|
||
| | Gutenberg | Cobalt | Hugo | Pelican | | ||
|--------------------------|-----------|--------|------|---------| | ||
| Single binary | ✔ | ✔ | ✔ | ✕ | | ||
| Language | Rust | Rust | Go | Python | | ||
| Syntax highlighting | ✔ | ✔ | ✔ | ✔ | | ||
| Sass compilation | ✔ | ✕ | ✕ | ✔ | | ||
| Assets co-location | ✔ | ✔ | ✔ | ✔ | | ||
| i18n | ✕ | ✕ | ✔ | ✔ | | ||
| Image processing | ✕ | ✕ | ✔ | ✔ | | ||
| Search | ✕ | ✕ | ✕ | ✔ | | ||
| Sane template engine | ✔ | ✔ | ✕✕✕ | ✔ | | ||
| Themes | ✔ | ✕ | ✔ | ✔ | | ||
| Shortcodes | ✔ | ✕ | ✔ | ✔ | | ||
| Internal links | ✔ | ✕ | ✔ | ✔ | | ||
| Table of contents | ✔ | ✕ | ✔ | ✔ | | ||
| Automatic header anchors | ✔ | ✕ | ✔ | ✔ | | ||
| Aliases | ✔ | ✕ | ✔ | ✔ | | ||
| Pagination | ✔ | ✕ | ✔ | ✔ | | ||
| Custom taxonomies | ✕ | ✕ | ✔ | ✕ | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @epage anything I got wrong for Cobalt or a feature I missed? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In case you are interested in linking to the issues
Also could you clarify something for me. I assume the only place worth doing pagination is in a ToC, so why are they listed separately? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not going to link to issues to keep it short.
Hmm why would have pagination in a ToC? A ToC is like what I'm using for the left menu of https://tera.netlify.com/docs/installation/ for example. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ok, didn't look too closely at what a ToC is and assumed it was an index. |
||
| Data files | ✕ | ✔ | ✔ | ✕ | | ||
|
||
|
||
## Contributing | ||
As the documentation site is automatically built on commits to master, all development | ||
should happen on the `next` branch, unless it is fixing the current documentation. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should there be a row for listing supported text formats like markdown?
What about data files and supported formats?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point I'll add that.
Do you mean https://gohugo.io/templates/data-templates/ ? I've never used that, I'll need to read it first.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup, jekyll has it too.
I've not used it yet either, so I'm too familiar with use cases for it. I just saw it used elsewhere, saw it was trivial to implement with serde, and implemented it :).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have to say, even the examples in the Hugo and Jekyll docs make it look useless. I can see the
getJSON
orgetCSV
from Hugo being useful but it's orthogonal to the concept of data files. I'll add it for completeness though