Add GitHub Pages Jekyll schema#5693
Merged
hyperupcall merged 1 commit intoMay 16, 2026
Merged
Conversation
Member
|
Thanks |
Contributor
Author
No problem. |
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
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
Adds a GitHub Pages-specific Jekyll configuration schema for
_config.ymlfiles used by sites built by GitHub Pages.This schema builds on the existing generic
jekyll.jsonschema and narrows the GitHub Pages-specific parts that are not valid or are hard-set in the Pages build environment:plugins/ legacygemsvaluesthemevalues andremote_themesafe,lsi,incremental,gist.noscript, and selectedkramdownvaluessource,destination, andplugins_dirThe catalog entry intentionally omits
fileMatchbecause the existing generic Jekyll schema already claims_config.yml; using the same broad filename would create an ambiguous association. Users can opt into this stricter schema with a YAML language-server schema directive when they need GitHub Pages validation.Sources
Validation
node .\cli.js check --schema-name=github-pages-jekyll.jsonnpm run prettier -- --cache --ignore-unknown .\src\schemas\json\github-pages-jekyll.json .\src\api\json\catalog.json .\src\schema-validation.jsonc .\src\test\github-pages-jekyll\_config.yml .\src\test\github-pages-jekyll\remote-theme.yml .\src\negative_test\github-pages-jekyll\hardcoded-values.yml .\src\negative_test\github-pages-jekyll\unsupported-plugin.yml .\src\negative_test\github-pages-jekyll\unsupported-source.yml .\src\negative_test\github-pages-jekyll\unsupported-theme.yml