Skip to content
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

Merged
merged 3 commits into from
Mar 12, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 | ✔ | ✕ | ✔ | ✔ |
Copy link

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?

Copy link
Collaborator Author

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?

Good point I'll add that.

What about data files and supported formats?

Do you mean https://gohugo.io/templates/data-templates/ ? I've never used that, I'll need to read it first.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean https://gohugo.io/templates/data-templates/ ? I've never used that, I'll need to read it first.

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 :).

Copy link
Collaborator Author

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 or getCSV from Hugo being useful but it's orthogonal to the concept of data files. I'll add it for completeness though

| Custom taxonomies | ✕ | ✕ | ✔ | ✕ |
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@epage anything I got wrong for Cobalt or a feature I missed?

Copy link

Choose a reason for hiding this comment

The 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?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not going to link to issues to keep it short.

I assume the only place worth doing pagination is in a ToC, so why are they listed separately?

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.
Pagination is for pages like a blog or sometimes for taxonomies like the tags/some-tag list pages where you list all pages.

Copy link

Choose a reason for hiding this comment

The 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.
Expand Down