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.

Sign up for GitHub

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

Significantly improve the README #1373

Closed
wants to merge 6 commits into from
+149 −35
Closed

Significantly improve the README #1373

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a7c3c71
Significantly improve the README
Feb 18, 2021
36e4d9d
Link to MSRV + getzola.org example + more docs links
Feb 22, 2021
b69afd8
Areas to improve
Feb 22, 2021
8c385f9
Configurable error/warn levels
Feb 22, 2021
7379cba
Internal links clarification
Feb 22, 2021
e8d51ed
Multilingual clarification
Feb 22, 2021
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
Prev Previous commit
Next Next commit
Configurable error/warn levels
southerntofu committed Feb 22, 2021
commit 8c385f9ca2e5363bb8d7e2f64f83ba5918f8f04a
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -42,6 +42,7 @@ zola may or may not be the right tool for you. If you would like to see at a gla
| Search | [![ehh]](https://www.getzola.org/documentation/content/search/) | ![no] | ![no] | ![yes] |
| Data files | [![yes]](https://www.getzola.org/documentation/templates/overview/#load-data) | ![yes] | ![yes] | ![no] |
| LiveReload | [![yes]](https://www.getzola.org/documentation/getting-started/cli-usage/#serve) | ![no] | ![yes] | ![yes] |
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not a bit fan of splitting the tables. I've heard a few people liking having all the "features" listed in one list so they scan for what they need/use to see which tools is the best for them.

Copy link
Contributor Author

@southerntofu southerntofu Feb 22, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

people liking having all the "features" listed in one list

I agree a single-page comparison is really useful. But personally i found one huge disorganized table was really confusing when looking for a specific feature. Don't you think it's a lot more clear when the features support table is split like this while still residing on the same page? I started a topic on the forums about it to collect more feedback.

| Configurable error/warn levels | ![no] | ![no] | ![yes] | ? |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I moved the "warn/error on broken links" here in the high-level overview and made more clear it's about error/warning management not about links. Is it better?


**Notes:**

@@ -59,7 +60,6 @@ zola may or may not be the right tool for you. If you would like to see at a gla
| HTML shortcodes | [![yes]](https://www.getzola.org/documentation/content/shortcodes/) | ![no] | ![yes] | ![yes] |
| Format-specific shortcodes | [![yes]](https://www.getzola.org/documentation/content/shortcodes/) | ? | ? | ? |
| Internal links | [![ehh]](https://www.getzola.org/documentation/content/linking/) | ![no] | ![yes] | ![yes] |
| Warn or error for broken links | [![no]](https://github.com/getzola/zola/issues/977#issuecomment-759725671) | ![no] | [![yes]](https://gohugo.io/content-management/cross-references/) | ? |
| Custom taxonomies | [![yes]](https://www.getzola.org/documentation/content/taxonomies/) | ![no] | ![yes] | ![no] |
| Multiple static mounts | [![no]](https://github.com/getzola/zola/issues/499) | ![no] | [![yes]](https://gohugo.io/hugo-modules/configuration/#module-config-mounts) | ? |