Skip to content

Add GitHub Pages Jekyll schema#5693

Merged
hyperupcall merged 1 commit into
SchemaStore:masterfrom
Nick2bad4u:add-github-pages-jekyll-schema
May 16, 2026
Merged

Add GitHub Pages Jekyll schema#5693
hyperupcall merged 1 commit into
SchemaStore:masterfrom
Nick2bad4u:add-github-pages-jekyll-schema

Conversation

@Nick2bad4u
Copy link
Copy Markdown
Contributor

Summary

Adds a GitHub Pages-specific Jekyll configuration schema for _config.yml files used by sites built by GitHub Pages.

This schema builds on the existing generic jekyll.json schema and narrows the GitHub Pages-specific parts that are not valid or are hard-set in the Pages build environment:

  • supported plugins / legacy gems values
  • supported bundled theme values and remote_theme
  • supported Markdown processors and syntax highlighters
  • hard-set GitHub Pages values such as safe, lsi, incremental, gist.noscript, and selected kramdown values
  • disallowed config fields that GitHub Pages controls, such as source, destination, and plugins_dir

The catalog entry intentionally omits fileMatch because 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.json
  • npm 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

@hyperupcall
Copy link
Copy Markdown
Member

Thanks

@hyperupcall hyperupcall merged commit ec3f684 into SchemaStore:master May 16, 2026
5 checks passed
@Nick2bad4u
Copy link
Copy Markdown
Contributor Author

Thanks

No problem.

@Nick2bad4u Nick2bad4u deleted the add-github-pages-jekyll-schema branch May 16, 2026 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants