Fix GitHub Pages documentation by adding .nojekyll #425
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
GitHub Pages uses Jekyll by default, which ignores directories starting with underscores. This causes CSS and JS assets in _build and _assets directories to not be served. Adding .nojekyll file tells GitHub Pages to serve the site as static HTML without Jekyll processing. Fixes #423
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.
Problem
The documentation site at https://policyengine.github.io/policyengine-us-data is not displaying correctly - CSS and JavaScript assets are not loading, resulting in a broken layout with no styling.
Root Cause
GitHub Pages uses Jekyll by default to process sites. Jekyll ignores directories that start with underscores (like
_build,_assets, etc.), which prevents CSS and JS files from being served.Solution
.nojekyllfile to tell GitHub Pages to serve the site as static HTML without Jekyll processing.nojekyllfile is created in the_build/htmldirectory during documentation buildsTesting
The fix ensures that all assets in underscore-prefixed directories will be properly served by GitHub Pages.
Fixes #423