vagrant-libvirt/docs/_config.yml
Darragh Bailey 844e2bb989
Update docs source path (#1754)
Update docs to fix edit link to refer to the correct path.

Fixes: #1752
2023-07-18 23:11:57 +01:00

86 lines
3.1 KiB
YAML

# 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.
#
# If you need help with YAML syntax, here are some quick references for you:
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
# https://learnxinyminutes.com/docs/yaml/
#
# 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: Vagrant Libvirt Documentation
description: >- # this means to ignore newlines until "baseurl:"
Create and manage Vagrant machines using Libvirt/QEMU
baseurl: "/vagrant-libvirt" # the subpath of your site, e.g. /blog
url: "https://vagrant-libvirt.github.io" # the base hostname & protocol for your site, e.g. http://example.com
logo: "/assets/images/logo.png"
# Footer last edited timestamp
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub"
gh_edit_repository: "https://github.com/vagrant-libvirt/vagrant-libvirt" # the github URL for your repo
gh_edit_branch: "main" # the branch that your docs is served from
gh_edit_source: docs # the source that your files originate from
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
# default theme is empty to skip using the default style sheet and instead load both light
# and dark using media queries to select based on whether the user prefers light or dark mode.
#color_scheme: "default"
# Build settings
remote_theme: just-the-docs/just-the-docs@v0.3.3
#theme: just-the-docs
plugins:
- jekyll-assets
- jekyll-feed
- jekyll-remote-theme
- jekyll-toc
assets:
raw_precompile: [
"images/logo.png",
]
sources:
- _assets
toc:
max_level: 3
# Exclude from processing.
# The following items will not be processed, by default.
# Any item listed under the `exclude:` key here will be automatically added to
# the internal "default list".
#
# Excluded items can be processed by explicitly listing the directories or
# their entries' file path in the `include:` list.
#
# exclude:
# - .sass-cache/
# - .jekyll-cache/
# - gemfiles/
# - Gemfile
# - Gemfile.lock
# - node_modules/
# - vendor/bundle/
# - vendor/cache/
# - vendor/gems/
# - vendor/ruby/
keep_files:
- .nojekyll
- .git
- favicon.ico