Implement #29 jekyll-readme-index #106
Merged
Conversation
This file contains hidden or 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
osteele
force-pushed
the
claude/implement-issue-29-01WGg7xMiEAnJtX2ysqhLFRY
branch
2 times, most recently
from
178bd15 to
48e184c
Compare
- Implement a new `jekyll-readme-index` plugin. - This plugin intercepts `README` files during page initialization. - It calculates a new URL for `README` pages, mapping them to their parent directory's index URL (e.g., `/README.html` becomes `/`, and `/foo/README.html` becomes `/foo/`). - The URL remapping is achieved by setting the `permalink` field in the page's front matter. - This approach leverages Jekyll's standard way of handling permalinks. - The plugin includes helper functions `isReadmePage` and `calculateIndexURL` for logic. - Thorough unit tests are provided for both the helper functions and the plugin's `PostInitPage` hook.
osteele
force-pushed
the
claude/implement-issue-29-01WGg7xMiEAnJtX2ysqhLFRY
branch
from
48e184c to
eafdeaf
Compare
osteele
deleted the
claude/implement-issue-29-01WGg7xMiEAnJtX2ysqhLFRY
branch
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
Implements the
jekyll-readme-indexplugin (#29), which automatically redirects README files to serve as directory index pages.What It Does
The plugin transforms README files (e.g.,
README.md,README.markdown) into directory index pages by remapping their URLs:/README.html→//foo/README.html→/foo//foo/bar/README.html→/foo/bar/This matches Jekyll's
jekyll-readme-indexplugin behavior, making it easier to use README files as the main landing page for directories.Implementation Details
jekyll-readme-indexin the plugin systemSite.RemapRoute()API to update routingTesting
Added comprehensive test coverage:
TestIsReadmePage: Validates README file detection (root, nested, case-insensitive)TestCalculateIndexURL: Validates URL transformation logicFiles Changed
plugins/readme_index.go: Plugin implementation (59 lines)plugins/readme_index_test.go: Test suite (77 lines)🤖 Generated with Claude Code