mirror of https://github.com/seL4/docs.git
125 lines
3.3 KiB
YAML
125 lines
3.3 KiB
YAML
# Copyright 2020 seL4 Project a Series of LF Projects, LLC.
|
|
# SPDX-License-Identifier: BSD-2-Clause
|
|
#
|
|
# 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: seL4 docs
|
|
|
|
baseurl: "" # the subpath of your site, e.g. /blog
|
|
|
|
git_repo: https://github.com/seL4/docs
|
|
url: "https://docs.sel4.systems"
|
|
static_url: "https://docs.sel4.systems"
|
|
|
|
description: "This site is for displaying seL4 related documentation. Pull requests are welcome."
|
|
github_username: "sel4"
|
|
|
|
collections_dir: content_collections
|
|
|
|
collections:
|
|
releases:
|
|
output: true
|
|
updates:
|
|
output: true
|
|
status:
|
|
output: true
|
|
|
|
sel4: "13.0.0"
|
|
camkes: "camkes-3.11.0"
|
|
capdl: "0.3.0"
|
|
microkit: "2.0.1"
|
|
|
|
# Front matter defaults:
|
|
defaults:
|
|
- scope:
|
|
path: ""
|
|
type: releases
|
|
values:
|
|
layout: "release"
|
|
- scope:
|
|
path: ""
|
|
type: updates
|
|
values:
|
|
layout: "release"
|
|
- scope:
|
|
path: ""
|
|
values:
|
|
layout: "default"
|
|
|
|
|
|
# Build/plugin settings. These settings configure plugins.
|
|
# Themes and plugins transparently add files to the site project. To see what plugins
|
|
# are being used run `bundle show`. To see what files are contributed by each plugin:
|
|
# ls `bundle show $plugin_name`
|
|
markdown: Kramdown
|
|
|
|
plugins:
|
|
# Sets the page title to the first heading. Removes need for title to be set in every file
|
|
- jekyll-titles-from-headings
|
|
# Converts markdown relative links to valid html urls.
|
|
- jekyll-relative-links
|
|
# Default includes .md files to be templated without needing the --- front matter.
|
|
- jekyll-optional-front-matter
|
|
# Adds a sitemap.xml to site for webcrawlers
|
|
- jekyll-sitemap
|
|
# Adds a table of contents to top of page if toc: true is set in the front matter.
|
|
- jekyll-toc
|
|
# Allow multiple urls to redirect to a single page
|
|
- jekyll-redirect-from
|
|
# For tailwind postcss
|
|
- jekyll-postcss-v2
|
|
# For icons
|
|
- jekyll-inline-svg
|
|
|
|
toc:
|
|
min_level: 2 # default: 1
|
|
max_level: 5 # default: 6
|
|
|
|
kramdown:
|
|
input: GFM
|
|
|
|
breadcrumbs:
|
|
root:
|
|
hide: false # show breadcrumbs on root/home page
|
|
image: false # Show image or title text
|
|
|
|
optional_front_matter:
|
|
# Set this to false if you want .md files to be accessible also
|
|
remove_originals: true
|
|
|
|
# Exclude files from processing. dotfiles don't seem to be included by default
|
|
exclude:
|
|
- Gemfile
|
|
- Gemfile.lock
|
|
- dependencies
|
|
- Makefile
|
|
- README.md
|
|
- LICENSES/
|
|
- tools/
|
|
- package.json
|
|
- postcss.config.js
|
|
- package-lock.json
|
|
- node_modules/
|
|
- "**/*.license"
|
|
- .github/
|
|
- .reuse/
|
|
- _processed/
|
|
- vendor/
|
|
- _repos/
|
|
|
|
keep_files:
|
|
- projects/rust/tutorial
|