tu-web-documentation/_config.yml at master · Taylor-University/tu-web-documentation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
title: Taylor University Web Documentation
description: Documentation for all developers and content contributors at Taylor University on how to contribute to the Taylor website within Taylor’s web environment
baseurl: "/tu-web-documentation" # the subpath of your site, e.g. /blog
url: "https://taylor-university.github.io" # the base hostname & protocol for your site, e.g. http://example.com

exclude: ["*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "README.md"]

# remote_theme: pmarsceill/just-the-docs

theme: just-the-docs

# defaults:
#   - scope:
#       path: ""
#     values:
#       layout: "default"

# Set a path/url to a logo that will be displayed instead of the title
logo: "https://www.taylor.edu/img/tu-logo-purple.svg"

# Enable or disable the site search
# Supports true (default) or false
search_enabled: true
search:
  # Split pages into sections that can be searched individually
  # Supports 1 - 6, default: 2
  heading_level: 2
  # Maximum amount of previews per search result
  # Default: 3
  previews: 3
  # Maximum amount of words to display before a matched word in the preview
  # Default: 5
  preview_words_before: 5
  # Maximum amount of words to display after a matched word in the preview
  # Default: 10
  preview_words_after: 10
  # Set the search token separator
  # Default: /[\s\-/]+/
  # Example: enable support for hyphenated search words
  tokenizer_separator: /[\s/]+/
  # Display the relative url in search results
  # Supports true (default) or false
  rel_url: true
  # Enable or disable the search button that appears in the bottom right corner of every page
  # Supports true or false (default)
  button: false

# Aux links for the upper right navigation
aux_links:
  "Theme Docs":
    - "//github.com/pmarsceill/just-the-docs"
  "Taylor Website":
    - "https://www.taylor.edu"

# Heading anchor links appear on hover over h1-h6 tags in page content
# allowing users to deep link to a particular heading on a page.
#
# Supports true (default) or false/nil
heading_anchors: true

# back_to_top: true
# back_to_top_text: "Back to top"

# Footer content appears at the bottom of every page's main content
footer_content: "Copyright &copy; 2020 Taylor University Web Team"

# Color scheme currently only supports "dark" or nil (default)
color_scheme: nil

# Google Analytics Tracking (optional)
# e.g, UA-1234567-89
# ga_tracking: UA-5555555-55

permalink: pretty

compress_html:
  clippings: all
  comments: all
  endings: all
  startings: []
  blanklines: false
  profile: false