-
Notifications
You must be signed in to change notification settings - Fork 5
/
_config.yml
158 lines (125 loc) · 5.13 KB
/
_config.yml
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
output: web
# this property is useful for conditional filtering of content that is separate from the PDF.
##### IOOS edit: replace this field with the documentation site name to appear on the top navigation bar next to the home button #####
topnav_title: Insert Your Documentation Site Name
site_title: IOOS GitHub Documentation
# this appears in the html browser tab for the site title (seen mostly by search engines, not users)
company_name: US IOOS
# this appears in the footer
host: 127.0.0.1
# the preview server used. Leave as is.
port: 4000
# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006.
# Reading Files
include:
- .htaccess
#- _pages
exclude:
- .idea/
- .gitignore
- Gemfile*
- theme/pages
#- theme/posts
- theme/Dockerfile
- theme/Gemfile
- theme/Gemfile.lock
- theme/search.json
- theme/update.sh
- theme/pdf-*
#- theme/
##### IOOS edit: replace this field with the documentation site name to be included in feedback email subject line #####
feedback_subject_line: Insert Your Documentation Site Name
##### IOOS edit: replace this field with the contact email to submit to via the feedback link #####
feedback_email: data.ioos@noaa.gov
# feedback_disable: true
# if you uncomment the previous line, the Feedback link gets removed
# feedback_text: "Need help?"
# if you uncomment the previous line, it changes the Feedback text
# feedback_link: "http://helpy.io/"
# if you uncomment the previous line, it changes where the feedback link points to
highlighter: rouge
# library used for syntax highlighting
markdown: kramdown
kramdown:
input: GFM
auto_ids: true
hard_wrap: false
syntax_highlighter: rouge
# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways
collections:
tooltips:
output: false
docs:
output: true
# using /docs/:name causes many link/path failures in hard-coded paths or values
# written into the templates (search, nav menu, etc). Instead just output :name
#permalink: /docs/:name
permalink: :name:output_ext
# collections are declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output unless you change output to true
defaults:
-
scope:
path: ""
type: "pages"
values:
layout: "page"
comments: true
search: true
sidebar: sidebar_ioos
topnav: topnav_ioos
-
scope:
path: ""
type: "docs"
values:
layout: "page"
comments: true
search: true
sidebar: sidebar_ioos
topnav: topnav_ioos
-
scope:
path: ""
type: "tooltips"
values:
layout: "page"
comments: true
search: true
tooltip: true
-
scope:
path: ""
type: "posts"
values:
layout: "post"
comments: true
search: true
sidebar: sidebar_ioos
topnav: topnav_ioos
# these are defaults used for the frontmatter for these file types
sidebars:
- sidebar_ioos
description: "A Jekyll-based documentation theme for data management documentation, software and other technical documentation needs. This is a skeleton repository for IOOS technical documentation projects to use as a starting point to develop new pages for the https://ioos.github.io site."
# the description is used in the feed.xml file
#disqus_shortname: idrbwjekyll
# if you're using disqus for comments, add the shortname here. if not, leave this value blank.
################################################################################################################
# IOOS EDIT HERE! Added settings for IOOS (replace 'ioos-documentation-jekyll-skeleton' with your GitHub repo name):#
################################################################################################################
# url/baseurl: modify baseurl so that url + baseurl combine to point to the full GitHub repo URL the site will be served from (replace 'your-documentation-repo-name')
# repository: modify to point to the GitHub repo shorthand name (replace 'your-documentation-repo-name')
# github_editme_path: provide the basepath to the branch containing source files for this site (replace 'your-documentation-repo-name'). 'blob/gh-pages/_docs' is standard and should remain as is
url : "https://ioos.github.io"
#baseurl : "/your-documentation-repo-name"
baseurl : "/ioos-documentation-jekyll-skeleton"
#repository : "ioos/your-documentation-repo-name"
repository : "ioos/ioos-documentation-jekyll-skeleton"
#github_editme_path : "ioos/your-documentation-repo-name/blob/gh-pages/_docs"
github_editme_path : "ioos/ioos-documentation-jekyll-skeleton/blob/gh-pages/_docs"
#Setup/config for 'ioos_documentation_theme_jekyll' git submodule (do not alter):
source : .
destination : _site
plugins_dir : theme/_plugins
layouts_dir : theme/_layouts
data_dir : _data
includes_dir : theme/_includes