mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-28 02:18:50 +00:00
89 lines
4.0 KiB
YAML
89 lines
4.0 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: Docs | Firezone
|
|
tagline: The official documentation for Firezone
|
|
email: support@firezone.dev
|
|
description: >- # this means to ignore newlines until "baseurl:"
|
|
Documentation site for Firezone's VPN and firewall server.
|
|
url: "https://docs.firezone.dev"
|
|
permalink: pretty
|
|
twitter_username: firezonehq
|
|
github_username: firezone
|
|
|
|
# Set a path/url to a logo that will be displayed instead of the title
|
|
logo: "/assets/images/firezone-logo-wordmark-dark.svg"
|
|
|
|
# Build settings
|
|
remote_theme: firezone/just-the-docs
|
|
color_scheme: fz
|
|
|
|
# Footer content
|
|
# appears at the bottom of every page's main content
|
|
|
|
footer_content: ""
|
|
|
|
# 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 on GitHub"
|
|
gh_edit_repository: "https://github.com/firezone/firezone" # the github URL for your repo
|
|
gh_edit_branch: "master" # 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
|
|
|
|
asset_urls:
|
|
architecture_diagram: "https://user-images.githubusercontent.com/52545545/147286088-08b0d11f-d81d-4622-8145-179071d2f0fb.png"
|
|
client_instructions: "https://user-images.githubusercontent.com/52545545/147296703-a7fa8fce-33bb-42ef-83b3-1b8e9047d1d5.gif"
|
|
|
|
# Aux links for the upper right navigation
|
|
aux_links:
|
|
"Ask a Question":
|
|
- "https://discourse.firez.one/new-topic?body=%23%23%20Describe%20the%20issue%0A%0AA%20clear%20and%20concise%20description%20of%20what%20the%20bug%20is.%20Code%20samples%20are%20helpful.%0A%0A%23%23%20Reproduction%20instructions%0A%0ATry%20to%20give%20as%20much%20context%20as%20you%20can!%20%0A%0A%23%23%20Expected%20behavior%0A%0ADescription%20of%20expected%20behavior.%0A%0A%23%23%20Screenshots%0A%0AIf%20applicable%2C%20add%20screenshots%20to%20help%20explain%20your%20problem.%0A%0A%23%23%20Environment%20Details%0A%0A-%20OS%3A%20%5Be.g.%20Ubuntu%2C%20Fedora%2C%20CentOS%5D%0A-%20VPC%3A%0A-%20Firebase%20Version%3A%20%0A%0A%23%23%20Other%20Info%0A%0AAdd%20any%20other%20context%20about%20the%20problem%20here.&category=category/subcategory&tags=docs"
|
|
"Join the Beta":
|
|
- "https://e04kusl9oz5.typeform.com/to/uD689MvN#source=docs"
|
|
|
|
# Plugins
|
|
plugins:
|
|
- jekyll-sitemap
|
|
|
|
# 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/
|