-
Notifications
You must be signed in to change notification settings - Fork 44
/
_config.yml
204 lines (155 loc) · 6.16 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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
############# SITE PROPERTIES #############
# localhost port (can be anything)
port: 4000
# used with localization. change to "japanese" or "german" if localizing.
language: english
# the output. in the _config_pdf.yml, this is "pdf". you can create conditions based on this property (such as navtab content that should appear in web but not pdf).
format: web
# the little icon that appears in the browser window's tab
favicon: assets/favicon.ico
############# TOP NAVIGATION BAR ################
# use a logo image in your nav bar.
use_logo: true
# logo image to use. logo images are constrained at 50px in height.
logo: assets/companylogo.png
# use text title instead. text title read from uistring.title in ui strings section.
use_text_title: false
# make search bar appear in top nav?
search_in_topnav: true
# make search bar appear in sidebar?
search_in_sidebar: false
# in responsive view, show sidebar toggle button?
toggle-sidebar-button: true
# in responsive view, show navbar toggle button?
navbar-toggle: true
############# AUTOMATED LINKS #############
# the links.html script requires you to list your sidebars here. this is if you're using managed links (see jekyllhowto-content-and-formatting.html#automatedlinks)
sidebars:
- generic
- jekyllhowto
# determines whether the links.html script uses the jurl or hurl values in the sidebar data file
link_type: jurl
############# FEEDBACK BUTTON #############
# show feedback button in top nav bar?
show_feedback: true
# email address feedback gets sent to
feedback_email: someemail@gmail.com
# note: to customize the auto-completed body text, overwrite it by adding _includes/feedback.html in your own theme.
############# GITHUB BUTTON #############
# inserts github link in top nav bar (recommended)
github_button_location_top_navbar: true
# inserts github link below page title
github_button_location_below_title: false
# inserts github link at bottom of page (least visible)
github_button_location_page_bottom: false
# link to your github repo. replace <organization> (if applicable) and <repo name> and <branch name>. Note that the github link will be {{site.github_editme_path}}/{{page.path}}
github_editme_path: https://github.com/<organization>/<repo name>/blob/<branch name>
############# EXCLUDE LIST #############
# these folders or files will not be included in the output. you can use wildcards with asterisks.
exclude:
- Config
- s3_website
- _config_*
- Gemfile*
- serve_*
- build_*
- gem_*
- prince-list.txt
- jekyll-theme-doc-project*
- pdf
- mobi
############# IMAGE PATHS #############
# if you want the images to be prefaced with a specific path, insert it here. Don't include a trailing slash at the end.
# the image include will insert this path before the image file name and will also add a /.
image_path: images
audio_path: audio
############# DEFAULTS #############
# you can define default frontmatter values here. you can narrow the type down with subfolders (e.g., docs/myfolder).
# you might want to list your sidebar and product as default frontmatter values
# with translation, change topnav, footer (and sidebar) to use topnav_ja, footer_ja, generic_ja etc. for Japanese, or _de for german. you must have corresponding
# data files with those _ja or _de file names. Read more in jekyllhowto-localization.html.
defaults:
-
scope:
path: ""
type: pages
values:
layout: default
topnav: topnav
footer: footer
-
scope:
path: ""
type: docs
values:
layout: default
topnav: topnav
footer: footer
-
scope:
path: ""
type: search
values:
layout: default
topnav: topnav
footer: footer
type: search
sidebar: jekyllhowto
-
scope:
path: "images"
values:
image: true
############# COMMENTS #############
# show Disqus comments after pages
show_disqus_comments: false
# shortname for configuring Disqus
disqus_shortname:
############# GOOGLE ANALYTICS #############
# include Google Analytics?
show_google_analytics: false
# Google Analytics tracking code number (not the whole code snippet -- just UA-123456 or so)
# To adjust the google analytics code snippet, see the _includes/google_analytics.html code in the gem
google_analytics_code:
############# Breadcrumb ############
# you can modify the breadcrumb in _includes/breadcrumb.html
# Display breadcrumbs at all?
breadcrumb_display: true
# Display Home path in breadcrumb?
breadcrumb_home_display: true
# Url for Home path to point to
breadcrumb_home_url: http://yourcompanysite.com
########## MARKDOWN PROCESS AND FILTER ##########
# leave these settings as is unless you want to use something other than kramdown Markdown
highlighter: rouge
markdown: kramdown
kramdown:
input: GFM
auto_ids: true
hard_wrap: false
syntax_highlighter: rouge
########## SASS SETTINGS ##########
# used to define sass settings. leave as is.
sass:
style: compressed
############# COLLECTIONS #############
# used to define collections used in project. leave as is.
collections:
docs:
output: true
########## UI text ###############
# The UI text is separated into strings defined here to facilitate translation. Grouping them here also consolidates all UI text.
# Translate these for Japanese and German outputs.
uistring:
title: Jekyll Doc Project theme # title to appear in nav bar and page meta
description: Description of the site # Displays as site description meta tag for site
copyright: 2017 Your Company, Inc. # appears in footer
breadcrumb_home_name: Home # display name for "Home" path in the breadcrumb
tableofcontents: Table of Contents # text that appears before in-page table of contents
expandall: Expand All # appears as text in sidebar to expand all levels
collapseall: Collapse All # appears as text in sidebar to collapse all levels
search_placeholder_text: Search ... # appears as placeholder in search field
no_search_results_found: No matches found. Try using other keywords?
feedback_link_name: Feedback # name of Feedback link
feedback_subject_line: Feedback about docs # Auto-filled Subject link of email
github_edit_button_text: Edit on GitHub # text for github button