This repository has been archived by the owner on Dec 4, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 53
/
_config.yml
131 lines (101 loc) · 3.45 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
output: web
# this property is useful for conditional filtering of content that is separate from the PDF.
topnav_title: Portworx Documentation
# this appears on the top navigation bar next to the home button
site_title: ""
# this appears in the html browser tab for the site title (seen mostly by search engines, not users)
company_name: Portworx
# this appears in the footer
github_editme_path: https://github.com/portworx/px-docs/
# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.
# disqus_shortname: idrbwjekyll
# if you're using disqus for comments, add the shortname here. if not, leave this value blank.
host: 127.0.0.1
# the preview server used. Leave as is.
port: 4005
# 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.
exclude:
- .idea/
- .gitignore
- build/
- Gemfile
- Gemfile.lock
- node_modules/
# these are the files and directories that jekyll will exclude from the build
feedback_subject_line: Portworx Documentation Feedback
feedback_email: [email protected]
# used as a contact email for the Feedback link in the top navigation bar
# 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
# 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: home_sidebar
-
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: home_sidebar
# these are defaults used for the frontmatter for these file types
sidebars:
- home_sidebar
- mydoc_sidebar
- product1_sidebar
- product2_sidebar
- other
description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features."
# the description is used in the feed.xml file
# needed for sitemap.xml file only
url: https://docs.portworx.com
# Google services
google_analytics: UA-64247527-1
# Leadlander config
leadlander_id: 31806
# Endless thanks for this incredible Theme! http://idratherbewriting.com/documentation-theme-jekyll/
plugins:
- jekyll-redirect-from
- jekyll-sitemap
compress_html:
clippings: all
comments: all
endings: all
profile: false
startings: [head, body]
sass:
style: compressed