_config.yml 4.75 KB
Newer Older
Patrick Marsceill's avatar
Patrick Marsceill committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole site, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing these 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
# '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.github_repo }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
16
17
title: WIN Wednesdays and WIPs
description: Guidance for booking of WIN Wednesdays and WIPs
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
18
baseurl: "/pages/cassag/WIN-Wednesdays-and-WIPs" # Set this to /pages/<group or username>/<project name>
19
url: "https://open.win.ox.ac.uk" # Leave this alone if publishing on WIN Pages site
Patrick Marsceill's avatar
Patrick Marsceill committed
20

Patrick Marsceill's avatar
Patrick Marsceill committed
21
permalink: pretty
22
23
24
25
26
27
28
29
30
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json",  "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"
, "docs/tests/"
]

# Regression tests
# By default, the pages in /docs/tests are excluded when the ste is built.
# To include them, comment-out the relevant line above.
# Uncommenting the following line doesn't work - see https://github.com/jekyll/jekyll/issues/4791
# include: ["docs/tests/"]
Patrick Marsceill's avatar
Patrick Marsceill committed
31

32
# Set a path/url to a logo that will be displayed instead of the title
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
33
logo: ../assets/images/logo-WIN.png
34

35
# Enable or disable the site search
36
# Supports true (default) or false
37
search_enabled: true
38
search:
39
  # Split pages into sections that can be searched individually
40
41
  # Supports 1 - 6, default: 2
  heading_level: 2
42
  # Maximum amount of previews per search result
Silvio Giebl's avatar
Silvio Giebl committed
43
  # Default: 3
44
  previews: 2
45
46
  # Maximum amount of words to display before a matched word in the preview
  # Default: 5
47
  preview_words_before: 3
48
49
  # Maximum amount of words to display after a matched word in the preview
  # Default: 10
50
  preview_words_after: 3
51
  # Set the search token separator
52
  # Default: /[\s\-/]+/
53
  # Example: enable support for hyphenated search words
54
  tokenizer_separator: /[\s/]+/
55
56
  # Display the relative url in search results
  # Supports true (default) or false
57
58
  rel_url: true
  # Enable or disable the search button that appears in the bottom right corner of every page
59
  # Supports true or false (default)
60
  button: false
61

62
63
64
# Enable or disable heading anchors
heading_anchors: true

Patrick Marsceill's avatar
Patrick Marsceill committed
65
# Aux links for the upper right navigation
Patrick Marsceill's avatar
Patrick Marsceill committed
66
aux_links:
67
68
  # "Join us on Slack or by Email":
  #   - "https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/contact/"
69
  "View on GitLab":
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
70
    - "//git.fmrib.ox.ac.uk/cassag/WIN-Wednesdays-and-WIPs"
Patrick Marsceill's avatar
Patrick Marsceill committed
71

72
73
74
# Makes Aux links open in a new tab. Default is false
aux_links_new_tab: false

75
# Sort order for navigation links
76
77
# nav_sort: case_insensitive # default, equivalent to nil
nav_sort: case_sensitive # Capital letters sorted before lowercase
Patrick Marsceill's avatar
Patrick Marsceill committed
78

79
# Footer content
Patrick Marsceill's avatar
Patrick Marsceill committed
80
# appears at the bottom of every page's main content
81
82
83
84
85

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

Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
86
footer_content: "Copyright &copy; 2020, University of Oxford. All rights reserved. Distributed under a <a href=\"https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/LICENSE\">CC-BY-4.0 license.</a>"
Patrick Marsceill's avatar
Patrick Marsceill committed
87

Patrick Marsceill's avatar
Patrick Marsceill committed
88
# Footer last edited timestamp
Patrick Marsceill's avatar
Patrick Marsceill committed
89
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
90
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
Patrick Marsceill's avatar
Patrick Marsceill committed
91

92
93


Patrick Marsceill's avatar
Patrick Marsceill committed
94
95
# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
96
gh_edit_link_text: "Edit this page on GitLab"
97
gh_edit_repository: "https://git.fmrib.ox.ac.uk/cassag/WIN-Wednesdays-and-WIPs" # the github URL for your repo
Patrick Marsceill's avatar
Patrick Marsceill committed
98
gh_edit_branch: "master" # the branch that your docs is served from
99
# gh_edit_source: docs # the source that your files originate from
Patrick Marsceill's avatar
Patrick Marsceill committed
100
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
Patrick Marsceill's avatar
Patrick Marsceill committed
101

102
# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
103
color_scheme: win
Patrick Marsceill's avatar
Patrick Marsceill committed
104
105
106
107

# Google Analytics Tracking (optional)
# e.g, UA-1234567-89
ga_tracking: UA-2709176-10
Patrick Marsceill's avatar
Patrick Marsceill committed
108
ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true/nil by default)
109
110

plugins:
Silvio Giebl's avatar
Silvio Giebl committed
111
112
  - jekyll-seo-tag

PLanCompS's avatar
PLanCompS committed
113
114
115
116
117
kramdown:
  syntax_highlighter_opts:
    block:
      line_numbers: false

Silvio Giebl's avatar
Silvio Giebl committed
118
119
120
121
122
compress_html:
  clippings: all
  comments: all
  endings: all
  startings: []
123
  blanklines: false
Patrick Marsceill's avatar
Patrick Marsceill committed
124
  profile: false
PLanCompS's avatar
PLanCompS committed
125
126
  # ignore:
  #   envs: all