_config.yml

title: PixelScript
description: Documentation for PixelScript, a hot-reloadable JavaScript and TypeScript runtime for Minecraft servers.
url: https://pixelib.github.io
baseurl: /pixelscript-docs

theme: just-the-docs

# just-the-docs renders through its "default" layout; apply it to every page
# so individual articles do not each have to declare it.
defaults:
  - scope:
      path: ""
      type: pages
    values:
      layout: default
      # Social preview card, unless a page overrides it with its own `image`.
      image: /assets/branding/social-card.png

plugins:
  - jekyll-seo-tag
  - jekyll-relative-links
  - jekyll-sitemap

# Rewrites relative .md links to their permalinks, so the same link works
# both on github.com and on the published site.
relative_links:
  enabled: true
  collections: false

# Brand assets live in assets/branding/, copied from pixelib/pixelscript's
# branding/ directory. `logo` feeds jekyll-seo-tag's structured data; the
# sidebar lockup is rendered by _includes/title.html.
logo: /assets/branding/pixelscript-mark.svg

# just-the-docs
# `pixelscript` is the stock dark scheme re-tinted with the brand palette,
# defined in _sass/color_schemes/pixelscript.scss.
color_scheme: pixelscript
search_enabled: true
search:
  heading_level: 3
  previews: 2
heading_anchors: true

aux_links:
  Website: https://pixelib.dev/projects/pixelscript
  Downloads: https://license-platform.pixelib.dev/artifacts
aux_links_new_tab: true

back_to_top: true
back_to_top_text: Back to top

footer_content: >-
  PixelScript is a Pixelib project.
  Found a mistake in these docs?
  <a href="https://github.com/pixelib/pixelscript-docs/issues">Open an issue</a>.

exclude:
  - Gemfile
  - Gemfile.lock
  - vendor
  - README.md
  - LICENSE
  - .github