📝 docs: clarify instructions for listing recent posts #418
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for tabi-demo ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
welpo
added
documentation
- Update README with clearer instructions for setting up post listings - Align documentation in "Mastering tabi" post with README - Improve explanations for root and subdirectory post serving options - Add warnings about mutually exclusive settings - Add warning when paginator is set without pages, but extra section has pages.
welpo
force-pushed
the
docs/clarify-post-listing-options
branch
from
3e62e66
to
d08b533
Compare
welpo
added a commit
that referenced
this pull request
Oct 20, 2024
welpo
added a commit
that referenced
this pull request
Oct 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Updated documentation to clarify instructions for listing recent posts on the main page, aiming to avoid confusion regarding the use of
paginate_byandsection_path. Changes were made to the README and the "Mastering tabi" post.Adds warning when conflicting settings are set.
Related issue
The lack of clarity in the docs was evidenced in #417.
Changes
Documentation:
/) and subdirectory (e.g.,/blog) configurations.New warning:
paginate_byis set without posts, butsection_pathcontains posts.Screenshots
Warning message that appears on the main page when a conflicting configuration is detected:
This warning is displayed when:
paginate_byandsection_pathare set in_index.md.paginate_byis ineffective).section_path.Type of change
Checklist
theme.tomlwith a sane default for the featureconfig.tomlcommentstheme.tomlcomments