_config.yml

# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.

# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
title: LittleKt
description: A Kotlin multiplatform WebGPU 2D game framework that works on Desktop (JVM), Mobile, and Browser. It works on Windows, MacOS, Linux, Android, and Web.

text_skin: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
highlight_theme: tomorrow-night-bright # "default" (default), "tomorrow", "tomorrow-night", "tomorrow-night-eighties", "tomorrow-night-blue", "tomorrow-night-bright"

# Build settings
markdown: kramdown

## => Author and Social
##############################
author:
    type: organization # "person" (default), "organization"
    name: LittleKt
    url:
    avatar:
    bio: >
        LittleKt is a multiplatform 2D game framework written in Kotlin using WebGPU.
    email:
    facebook:
    twitter:
    weibo:
    googleplus:
    telegram:
    medium:
    zhihu:
    douban:
    linkedin:
    github: littlektframework/littlekt
    discord: https://discord.gg/8VCZEQVBvt
    npm:

## => GitHub Repository (if the site is hosted by GitHub)
##############################
repository: littlektframework/littlektframework.github.io
repository_tree: master

## => Paths
##############################
paths:
    root: # title link url, "/" (default)
    home: # home layout url, "/" (default)
    archive: # "/archive.html" (default)
    rss: # "/feed.xml" (default)

## => Post
##############################
## excerpt
excerpt_separator: <!--more-->

## => Markdown Enhancements
##############################
## Mathjax
mathjax: # false (default), true
mathjax_autoNumber: # false (default), true

## Mermaid
mermaid: # false (default), true

## Chart
chart: # false (default), true

## => Paginate
##############################
paginate: 8
paginate_path: /page:num # don't change this unless for special need

## => Sources
##############################
sources: # bootcdn (default), unpkg

## => Sharing
##############################
sharing:
    provider: false # false (default), "addtoany", "addthis", "custom"

    ## AddThis
    addthis:
        id: # AddThis pubid, e.g. ra-5xxxxxxxxxxx

## => Comments
##############################
comments:
    provider: false # false (default), "disqus", "gitalk", "valine", "custom"

    ## Disqus
    disqus:
        shortname: # the Disqus shortname for the site

    ## Gitalk
    # please refer to https://github.com/gitalk/gitalk for more info.
    gitalk:
        clientID: # GitHub Application Client ID
        clientSecret: # GitHub Application Client Secret
        repository: # GitHub repo
        owner: # GitHub repo owner
        admin: # GitHub repo owner and collaborators, only these guys can initialize GitHub issues, IT IS A LIST.

    ## Valine
    # please refer to https://valine.js.org/en/ for more info.
    valine:
        app_id: # LeanCloud App id
        app_key: # LeanCloud App key
        placeholder: # Prompt information
        visitor: # false (default)
        meta: # "[nick, mail, link]" (default) nickname, E-mail, Personal-site

## => Pageview
##############################
pageview:
    provider: false # false (default), "leancloud", "custom"

    ## Leancloud
    leancloud:
        app_id: # LeanCloud App id
        app_key: # LeanCloud App key
        app_class: # LeanCloud App class

## => Search
##############################
search:
    provider: false # "default" (default), false, "google", "custom"

    ## Google Custom Search Engine
    google:
        custom_search_engine_id: # Google Custom Search Engine ID

## => Analytics
##############################
analytics:
    provider: false # false (default), "google", "custom"

    ## Google Analytics
    google:
        tracking_id: # Google Analytics id for the site
        anonymize_ip: false # Anonymize IP tracking for Analytics

# Outputting
permalink: /:categories/:title/

collections:
    docs:
        output: true
        permalink: /:collection/:path/

include:
    - _pages

exclude:
    - CHANGELOG.md
    - HOW_TO_RELEASE.md
    - Gemfile
    - Gemfile.lock
    - LICENSE
    - README-*.md
    - README.md
    - gulpfile.js
    - jekyll-text-theme.gemspec
    - package-lock.json
    - package.json
    # - /docs
    - /node_modules
    # - /screenshots
    # - /test
    - /vendor
    - /_posts
    - /index.html

# Exclude from processing.
# The following items will not be processed, by default. Create a custom list
# to override the default setting.
# exclude:
#   - Gemfile
#   - Gemfile.lock
#   - node_modules
#   - vendor/bundle/
#   - vendor/cache/
#   - vendor/gems/
#   - vendor/ruby/

# Plugins (previously gems:)
plugins:
    - jekyll-paginate
    - jekyll-sitemap
    - jekyll-gist
    - jekyll-feed
    - jemoji
    - jekyll-include-cache
    - jekyll-github-metadata

footer:
    links:
        - label: "GitHub"
          icon: "fab fa-fw fa-github"
          url: "https://github.com/littlektframework/littlekt"

defaults:
    # _posts
    - scope:
          path: ""
          type: posts
      values:
          layout: article
          comment: false
          sharing: true
    # _pages
    - scope:
          path: "_pages"
          type: pages
      values:
          layout: page
          comment: false
    # _wiki
    - scope:
          path: "_docs"
      values:
          layout: article
          nav_key: docs
          aside:
              toc: true
          show_edit_on_github: true
          show_date: false
          sidebar:
              nav: "docs"