Jekyll (SchemaStore) JSON Schema

Type	object
File match	`_config.yml`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/jekyll/latest.json
Source	https://www.schemastore.org/jekyll.json

Validate with Lintel

npx @lintel/lintel check

Type: object

Properties

source string

A directory to read files from for the current site https://jekyllrb.com/docs/configuration/options/#global-configuration

Default: "."

destination string

A directory to write files to for the current site https://jekyllrb.com/docs/configuration/options/#global-configuration

Default: "./_site"

safe boolean

Whether to enable non-whitelisted plugins and symbolic links for the current site https://jekyllrb.com/docs/configuration/options/#global-configuration

Default: false

disable_disk_cache boolean

Whether to disable caching to disk for the current site https://jekyllrb.com/docs/configuration/options/#global-configuration

ignore_theme_config boolean

Whether to ignore a theme configuration for the current site https://jekyllrb.com/docs/configuration/options/#global-configuration

exclude string[]

Excluded directories and files from the conversion for the current site https://jekyllrb.com/docs/configuration/options/#global-configuration

Default:

[
  "Gemfile",
  "Gemfile.lock",
  "node_modules",
  "vendor/bundle/",
  "vendor/cache/",
  "vendor/gems/",
  "vendor/ruby/"
]

uniqueItems=true

include string[]

Included directories and files in the conversion for the current site https://jekyllrb.com/docs/configuration/options/#global-configuration

Default:

[
  ".htaccess"
]

uniqueItems=true

keep_files string[]

Keeped files when clobbering for the current site https://jekyllrb.com/docs/configuration/options/#global-configuration

Default:

[
  ".git",
  ".svn"
]

uniqueItems=true

timezone timezone | null

Copy of definition from https://www.schemastore.org/base.json#/definitions/nullable-timezone

encoding string

An encoding for the current site https://jekyllrb.com/docs/configuration/options/#global-configuration

Default: "UTF-8"

Values: "ASCII-8BIT" "UTF-8" "utf-8" "US-ASCII" "UTF-16BE" "UTF-16LE" "UTF-32BE" "UTF-32LE" "UTF-16" "UTF-32" "UTF8-MAC" "EUC-JP" "Windows-31J" "Big5" "Big5-HKSCS" "Big5-UAO" "CESU-8" "CP949" "Emacs-Mule" "EUC-KR" "EUC-TW" "GB18030" "GBK" "ISO-8859-1" "ISO-8859-2" "ISO-8859-3" "ISO-8859-4" "ISO-8859-5" "ISO-8859-6" "ISO-8859-7" "ISO-8859-8" "ISO-8859-9" "ISO-8859-10" "ISO-8859-11" "ISO-8859-13" "ISO-8859-14" "ISO-8859-15" "ISO-8859-16" "KOI8-R" "KOI8-U" "Shift_JIS" "Windows-1250" "Windows-1251" "Windows-1252" "Windows-1253" "Windows-1254" "Windows-1257" "IBM437" "IBM737" "IBM775" "CP850" "IBM852" "CP852" "IBM855" "CP855" "IBM857" "IBM860" "IBM861" "IBM862" "IBM863" "IBM864" "IBM865" "IBM866" "IBM869" "Windows-1258" "GB1988" "macCentEuro" "macCroatian" "macCyrillic" "macGreek" "macIceland" "macRoman" "macRomania" "macThai" "macTurkish" "macUkraine" "CP950" "CP951" "IBM037" "stateless-ISO-2022-JP" "eucJP-ms" "CP51932" "EUC-JIS-2004" "GB2312" "GB12345" "ISO-2022-JP" "ISO-2022-JP-2" "CP50220" "CP50221" "Windows-1256" "Windows-1255" "TIS-620" "Windows-874" "MacJapanese" "UTF-7" "UTF8-DoCoMo" "SJIS-DoCoMo" "UTF8-KDDI" "SJIS-KDDI" "ISO-2022-JP-KDDI" "stateless-ISO-2022-JP-KDDI" "UTF8-SoftBank" "SJIS-SoftBank"

defaults object[]

The front matter defaults https://jekyllrb.com/docs/configuration/options/#global-configuration

plugins_dir string | string[]

Plugin directories for the current site https://jekyllrb.com/docs/configuration/options/#build-command-options

layouts_dir string | string[]

Layout directories for the current site https://jekyllrb.com/docs/configuration/options/#build-command-options

show_drafts boolean | null

Copy of definition from https://www.schemastore.org/base.json#/definitions/nullable-boolean

future boolean

Whether to publish posts or collection documents with a future date for the current site https://jekyllrb.com/docs/configuration/options/#build-command-options

Default: false

unpublished boolean

Whether to publish posts that were marked as unpublished for the current site https://jekyllrb.com/docs/configuration/options/#build-command-options

Default: false

lsi boolean

Whether to produce an index for related posts for the current site https://jekyllrb.com/docs/configuration/options/#build-command-options

Default: false

limit_posts integer

A number of posts to publish for the current site https://jekyllrb.com/docs/configuration/options/#build-command-options

Default: 0

force_polling boolean

Whether to use polling for the current site https://jekyllrb.com/docs/configuration/options/#build-command-options

quiet boolean

Whether to hide a normal output while building for the current site https://jekyllrb.com/docs/configuration/options/#build-command-options

Default: false

verbose boolean

Whether to write a verbose output while building for the current site https://jekyllrb.com/docs/configuration/options/#build-command-options

Default: false

incremental boolean

Whether to enable the experimental incremental build feature for the current site https://jekyllrb.com/docs/configuration/options/#build-command-options

Default: false

profile boolean

Whether to render profile generation to help identify performance bottlenecks for the current site https://jekyllrb.com/docs/configuration/options/#build-command-options

strict_front_matter boolean

Whether to fail build if there is a YAML syntax error in a page's front matter for the current site https://jekyllrb.com/docs/configuration/options/#build-command-options

Default: false

baseurl string

A base URL for the current site https://jekyllrb.com/docs/configuration/options/#build-command-options

Default: ""

port integer

A port to listen on for the current site https://jekyllrb.com/docs/configuration/options/#serve-command-options

Default: 4000

min=0max=65535

host string

A hostname to listen on for the current site https://jekyllrb.com/docs/configuration/options/#serve-command-options

Default: "localhost"

livereload boolean

Whether to reload pages on the browser when its content was changed for the current site https://jekyllrb.com/docs/configuration/options/#serve-command-options

Default: false

livereload_ignore string[]

File glob patterns for LiveReload to ignore for the current site https://jekyllrb.com/docs/configuration/options/#serve-command-options

uniqueItems=true

livereload_min_delay integer

A minimum delay before automatically reloading page for the current site https://jekyllrb.com/docs/configuration/options/#serve-command-options

min=0

livereload_max_delay integer

A maximum delay before automatically reloading page for the current site https://jekyllrb.com/docs/configuration/options/#serve-command-options

min=0

open_url boolean

Whether to open a site's URL in the browser for the current site https://jekyllrb.com/docs/configuration/options/#serve-command-options

detach boolean

Whether to detach a server from a terminal for the current site https://jekyllrb.com/docs/configuration/options/#serve-command-options

Default: false

skip_initial_build boolean

Whether to skip an initial site build which occurs before the server is started for the current site https://jekyllrb.com/docs/configuration/options/#serve-command-options

Default: false

show_dir_listing boolean

Whether to show directory listing instead of an index file for the current site https://jekyllrb.com/docs/configuration/options/#serve-command-options

Default: false

collections string[] | object

The collections to group several site pages https://jekyllrb.com/docs/collections/

collections_dir string

A directory where to store collections for the current site https://jekyllrb.com/docs/collections/#setup

Default: "."

minLength=1

data_dir string

A directory to store data files for the current site https://jekyllrb.com/docs/configuration/default/

Default: "_data"

minLength=1

includes_dir string

An includes directory for the current site https://jekyllrb.com/docs/configuration/default/

Default: "_includes"

minLength=1

markdown_ext string

Markdown extensions for the current site https://jekyllrb.com/docs/configuration/default/

Default: "markdown,mkdown,mkdn,mkd,md"

Examples: "markdown", "mkdown", "mkdn", "mkd", "md"

minLength=1

whitelist string[]

Whitelisted plugins for the current site https://jekyllrb.com/docs/configuration/default/

Default:

[]

uniqueItems=true

plugins string[]

Enabled plugins for the current site https://jekyllrb.com/docs/configuration/default/

Default:

[]

uniqueItems=true

markdown string

A markdown processor for the current site https://jekyllrb.com/docs/configuration/default/

Default: "kramdown"

minLength=1

highlighter string

A syntax highlighter for the current site https://jekyllrb.com/docs/configuration/default/

Default: "rouge"

minLength=1

excerpt_separator string

A post excerpt separator for the current site https://jekyllrb.com/docs/configuration/default/

Default:

"

"

permalink string

The global permalink format https://jekyllrb.com/docs/permalinks/#global

Default: "date"

Examples: "/:year", "/:short_year", "/:month", "/:i_month", "/:short_month", "/:day", "/:i_day", "/:y_day", "/:w_year", "/:week", "/:w_day", "/:short_day", "/:long_day", "/:hour", "/:minute", "/:second", "/:title", "/:slug", "/:categories", "/:slugified_categories", "date", "pretty", "ordinal", "weekdate", "none", "/:categories/:year/:month/:day/:title:output_ext", "/:categories/:year/:month/:day/:title/", "/:categories/:year/:y_day/:title:output_ext", "/:categories/:year/:week/:short_day/:title:output_ext", "/:categories/:title:output_ext"

paginate_path string

A destination of the pagination pages for the current site https://jekyllrb.com/docs/configuration/default/

Default: "/page:num"

minLength=1

kramdown object

kramdown options https://kramdown.gettalong.org/documentation.html

33 nested properties

input string

The selected kramdown processor https://jekyllrb.com/docs/configuration/markdown/

Default: "GFM"

hard_wrap boolean

Enable/disable interpreting line breaks literally https://github.com/kramdown/parser-gfm#options

Default: false

gfm_quirks string[]

Enabled GFM quirks https://github.com/kramdown/parser-gfm#options

Default:

[
  "paragraph_end"
]

uniqueItems=true

gfm_emojis boolean

Enable/disable rendering emoji amidst GFM https://github.com/kramdown/parser-gfm#options

Default: false

gfm_emoji_opts object

Configuration for rendering emoji amidst GFM https://github.com/kramdown/parser-gfm#options

Default:

{}

1 nested properties

asset_path string

Remote location of emoji assets

Default: "https://github.githubassets.com/images/icons/emoji"

auto_id_prefix string

The prefix used for automatically generated header IDs https://kramdown.gettalong.org/converter/html.html

Default: ""

auto_id_stripping boolean

Strip/leave all formatting from header text for automatic ID generation https://kramdown.gettalong.org/converter/html.html

Default: false

auto_ids boolean

Enable/disable automatic header ID generation https://kramdown.gettalong.org/converter/html.html

Default: true

entity_output string

The entity output https://kramdown.gettalong.org/converter/html.html

Default: "as_char"

Values: "as_char" "as_input" "numeric" "symbolic"

footnote_backlink string

The text that should be used for the footnote backlinks https://kramdown.gettalong.org/converter/html.html

Default: "↩"

footnote_backlink_inline string

Enable/disable inlining of the footnote backlink https://kramdown.gettalong.org/converter/html.html

Default: false

footnote_nr integer

The number of the first footnote https://kramdown.gettalong.org/converter/html.html

Default: 1

footnote_prefix string

The prefix for footnote IDs https://kramdown.gettalong.org/options.html

Default: ""

forbidden_inline_options string[]

The options that may not be set using the {::options} extension https://kramdown.gettalong.org/options.html

Default:

[
  "template"
]

uniqueItems=true

header_offset integer

The output offset for headers https://kramdown.gettalong.org/options.html

Default: 0

min=0

html_to_native boolean

Enable/disable HTML elements to native elements conversion https://kramdown.gettalong.org/parser/kramdown.html

Default: false

latex_headers string

The LaTeX commands for different header levels https://kramdown.gettalong.org/options.html

Default: "section,subsection,subsubsection,paragraph,subparagraph,subparagraph"

Examples: "section", "subsection", "subsubsection", "paragraph", "subparagraph"

line_width integer

The line width when outputting the document https://kramdown.gettalong.org/options.html

Default: 72

min=0

link_defs string | object

The pre-defined link definitions

Default:

{}

math_engine string

The math engine https://kramdown.gettalong.org/converter/html.html

Default: "mathjax"

math_engine_opts object

The math engine options https://kramdown.gettalong.org/converter/html.html

Default:

{}

parse_block_html boolean

Enable/disable processing kramdown syntax in block HTML tags https://kramdown.gettalong.org/parser/kramdown.html

Default: false

parse_span_html boolean

Enable/disable processing kramdown syntax in span HTML tags https://kramdown.gettalong.org/parser/kramdown.html

Default: true

remove_block_html_tags boolean

Enable/disable removing block HTML tags https://kramdown.gettalong.org/options.html

Default: true

remove_line_breaks_for_cjk boolean

Leave/remove line breaks between CJK characters https://kramdown.gettalong.org/converter/html.html

Default: false

remove_span_html_tags boolean

Enable/disable removing span HTML tags https://kramdown.gettalong.org/options.html

Default: false

smart_quotes string

The HTML entity names or code points for smart quote output https://kramdown.gettalong.org/converter/html.html

Default: "lsquo,rsquo,ldquo,rdquo"

Examples: "lsquo,rsquo", "ldquo,rdquo"

syntax_highlighter string | null

The syntax highlighter https://kramdown.gettalong.org/converter/html.html

Default: "rouge"

minLength=1

syntax_highlighter_opts object

The syntax highlighter options https://kramdown.gettalong.org/converter/html.html

Default:

{}

template string

The name of an ERB template file that should be used to wrap the output or the ERB template itself https://kramdown.gettalong.org/converter/html.html

Default: ""

toc_levels string | array

The levels that are used for the table of contents https://kramdown.gettalong.org/converter/html.html

transliterated_header_ids boolean

Enable/disable transliterating header text before generating the ID https://kramdown.gettalong.org/converter/html.html

Default: false

typographic_symbols object

The mapping from typographical symbol to output characters https://kramdown.gettalong.org/converter/html.html

7 nested properties

hellip string

Typographical symbol https://kramdown.gettalong.org/converter/html.html

mdash string

Typographical symbol https://kramdown.gettalong.org/converter/html.html

ndash string

Typographical symbol https://kramdown.gettalong.org/converter/html.html

laquo string

Typographical symbol https://kramdown.gettalong.org/converter/html.html

raquo string

Typographical symbol https://kramdown.gettalong.org/converter/html.html

laquo_space string

Typographical symbol https://kramdown.gettalong.org/converter/html.html

raquo_space string

Typographical symbol https://kramdown.gettalong.org/converter/html.html

liquid object

Liquid options https://jekyllrb.com/docs/configuration/liquid/

3 nested properties

error_mode string

The response to errors https://jekyllrb.com/docs/configuration/liquid/

Default: "warn"

Values: "lax" "warn" "strict"

strict_filters boolean

Enable/disable non-existing filters catch https://jekyllrb.com/docs/configuration/liquid/

Default: false

strict_variables boolean

Enable/disable non-assigned variables catch https://jekyllrb.com/docs/configuration/liquid/

Default: false

sass object

Sass options https://github.com/jekyll/jekyll-sass-converter#configuration-options

9 nested properties

style string

The style of CSS-output https://github.com/jekyll/jekyll-sass-converter#configuration-options

Default: "expanded"

Values: "compressed" "expanded"

sass_dir string

The path with Sass partials https://github.com/jekyll/jekyll-sass-converter#configuration-options

Default: "_sass"

load_paths string[]

The additional paths with Sass partials https://github.com/jekyll/jekyll-sass-converter#configuration-options

Default:

[]

uniqueItems=true

fatal_deprecations string[]

An array of deprecations or versions to treat as fatal. https://github.com/jekyll/jekyll-sass-converter#configuration-options

Default:

[]

uniqueItems=true

future_deprecations string[]

An array of active deprecations to ignore. https://github.com/jekyll/jekyll-sass-converter#configuration-options

Default:

[]

uniqueItems=true

silence_deprecations string[]

An array of future deprecations to opt into early. https://github.com/jekyll/jekyll-sass-converter#configuration-options

Default:

[]

uniqueItems=true

sourcemap string

Control when source maps shall be generated https://github.com/jekyll/jekyll-sass-converter#configuration-options

Default: "always"

Values: "never" "always" "development"

quiet_deps boolean

If true, Sass does not print warnings that are caused by dependencies https://github.com/jekyll/jekyll-sass-converter#configuration-options

Default: false

verbose boolean

If true, Sass prints every deprecation warning it encounters https://github.com/jekyll/jekyll-sass-converter#configuration-options

Default: false

webrick object

WEBrick options https://docs.ruby-lang.org/en/2.4.0/WEBrick.html

1 nested properties

headers object

The custom headers for this site https://docs.ruby-lang.org/en/2.4.0/WEBrick.html

rdiscount object

RDiscount options https://rdoc.info/github/davidfstr/rdiscount/RDiscount

1 nested properties

extensions string[]

The enabled extensions https://rdoc.info/github/davidfstr/rdiscount/RDiscount

uniqueItems=true

redcarpet object

Redcarpet options https://github.com/vmg/redcarpet

1 nested properties

extensions string[]

The enabled extensions https://github.com/vmg/redcarpet#and-its-like-really-simple-to-use

uniqueItems=true

Definitions

nullable-boolean boolean | null

Copy of definition from https://www.schemastore.org/base.json#/definitions/nullable-boolean

nullable-timezone timezone | null

Copy of definition from https://www.schemastore.org/base.json#/definitions/nullable-timezone

global-permalink string

The global permalink format https://jekyllrb.com/docs/permalinks/#global

Examples:

"/:year"
"/:short_year"
"/:month"
"/:i_month"
"/:short_month"
"/:day"
"/:i_day"
"/:y_day"
"/:w_year"
"/:week"
"/:w_day"
"/:short_day"
"/:long_day"
"/:hour"
"/:minute"
"/:second"
"/:title"
"/:slug"
"/:categories"
"/:slugified_categories"
"date"
"pretty"
"ordinal"
"weekdate"
"none"
"/:categories/:year/:month/:day/:title:output_ext"
"/:categories/:year/:month/:day/:title/"
"/:categories/:year/:y_day/:title:output_ext"
"/:categories/:year/:week/:short_day/:title:output_ext"
"/:categories/:title:output_ext"

collection-permalink string

The collection permalink format https://jekyllrb.com/docs/permalinks/#collections

Examples:

"/:collection"
"/:path"
"/:name"
"/:title"
"/:output_ext"
"/blog/:title"