-
Notifications
You must be signed in to change notification settings - Fork 27
/
Copy path_config.yml
249 lines (219 loc) · 6.61 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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# BLOG SETTINGS
title: "I'd Rather Be Writing - Tom Johnson"
name: "I'd Rather Be Writing Blog"
description: Technical writing blog focusing on the latest trends, news, and other topics in the field of technical communication.
host: 127.0.0.1
port: 4000
feedback_email: tomjoht@gmail.com
sidebar_accordion: true
output: web
paginate: 15
timezone: America/Los_Angeles
blog_logo_file: bloglogo_bloglogo.svg
media: https://s3.us-west-1.wasabisys.com/idbwmedia.com/images
# API DOC SETTINGS
api_title: Documenting APIs
api_description: A guide for technical writers and engineers working with APIs
api_site_logo_file: learnapidoclogo-01.svg
# bloglogo_apidoclogo.svg
api_language: english
api_sidebar: docapis
api_media: https://s3.us-west-1.wasabisys.com/idbwmedia.com/images/api
# Link to home
url: https://idratherbewriting.com
baseurl:
destination: _site
highlighter: rouge
exclude:
- ebooks
- pdf
- _site
- vendor
- _drafts
format: web
plugins:
- jekyll-sitemap
- jekyll-mentions
- jekyll-redirect-from
- jekyll-paginate
- jekyll-seo
markdown: kramdown
kramdown:
input: GFM
auto_ids: true
hard_wrap: false
syntax_highlighter: rouge
# Permalink style
permalink: /:year/:month/:day/:title/
# Collections
collections:
docs:
output: true
slides:
output: true
smartphones:
output: true
zamm:
output: true
ai:
output: true
# Sass styles
sass:
style: compressed
# Defaults for frontmatter values
defaults:
-
scope:
path: ""
type: "pages"
values:
layout: default
topnav: topnav
comments: true
search: true
-
scope:
path: ""
type: "posts"
values:
layout: default
topnav: topnav
comments: true
search: true
author: <a href='/aboutme/'>Tom Johnson</a>
-
scope:
path: "_docs"
type: docs
values:
layout: default
sidebar: docapis
topnav: topnav
progress: true
permalink: /docs:path.html
collection: docs
-
scope:
path: "assets/files"
type: "pages"
values:
permalink: "/assets/files/:basename.html"
-
scope:
path: "_slides"
type: slides
values:
layout: slides
permalink: /slides:path.html
-
scope:
path: "_smartphones"
type: smartphones
values:
layout: default
sidebar: sidebar_smartphones
topnav: topnav
progress: true
permalink: /docs:path.html
collection: smartphones
-
scope:
path: "_zamm"
type: zamm
values:
layout: default
sidebar: sidebar_zamm
topnav: topnav
progress: true
permalink: /docs:path.html
collection: zamm
-
scope:
path: "_ai"
type: ai
values:
layout: default
sidebar: sidebar_ai
topnav: topnav
progress: true
permalink: /docs:path.html
collection: ai
-
scope:
path: "images"
values:
image: true
########## UI text ###############
uistring:
tableofcontents: Table of Contents
log_doc_issue: Log Doc Issue
breadcrumb:
home: Home
documentation: Documentation
expandall: Expand All
collapseall: Collapse All
title: Learn API Doc # Displays as site title on top nav bar and on site metadata
description: A guide for technical writers and engineers learning how to document APIs # Displays as site description meta
github_edit_button_text: Edit on GitHub
products: Products
docindex_product: Product
docindex_startpage: Starting page
## itunes feed settings
podcast_url: https://www.idratherbewriting.com
podcast_album_art: https://s3.us-west-1.wasabisys.com/idbwmedia.com/images/idratherbewritinglogo.png
podcast_title: I'd Rather Be Writing Podcast
podcast_owner: Tom Johnson
podcast_email: tomjoht@gmail.com
podcast_explicit: "No"
podcast_author: Tom Johnson
podcast_description: Topics and issues for technical writers. Improve your technical communication role. Empower users with better documentation.
podcast_summary: A technical writing podcast about the latest trends and practices in the field of technical communication. Technical communication includes topics like technical writing (software help), AI, information architecture, usability, API documentation, information design, web design, illustration, DITA, structured authoring, content strategy, visual communication, and more. If you're a technical writer or interested in technical writing, this is the one of few podcasts in this niche. I also have a blog at https://idratherbewriting.com where the podcasts and other blog topics are published. For an index of all podcasts, see https://idratherbewriting.com/podcasts.
podcast_subtitle: Technical writing trends, innovations, and news. Content original from idratherbewriting.com. Hosted by Tom Johnson.
####### Algolia configuration ###########
algolia:
application_id: XUM0ZBII9L
index_name: idratherbewriting
search_only_api_key: aa11df1f45809fcdfb5b7bc89a301682
files_to_exclude:
- ./toc.html
- _docs/pdf_frontmatter/*
- _docs/introduction_to_rest_apis/tocstart.html
- _docs/introduction_to_rest_apis/tocstart_fulldetails.md
- _docs/activities_pdf/*
- _docs/slides/*
- _drafts
- .idea
- _site
- vendor
- redirects/*
- pages/category-archives/*
- pages/date-based-archives/*
- _slides/*
- _slides/trends_stc19/index.html
nodes_to_index: 'p,.description'
eventbrite_public_token: FUQRFCCTNLYIUXJZQCSV
####### jekyll seo tag configuration #######
title: "I'd Rather Be Writing Blog and API doc course"
tagline: "Technical writing blog focusing on the latest trends, news, and other topics in the field of technical communication."
description: "Stay updated with best practices for technical writers. Includes an API documentation course for technical writers and engineers learning how to document APIs. The course includes sections on what an API is, API reference documentation, OpenAPI specification and Swagger, docs-as-code publishing and workflows, conceptual topics, tutorials, API documentation jobs, and more."
url: https://idratherbewriting.com
author:
twitter: tomjohnson
twitter:
username: tomjohnson
card: summary
logo: https://s3.us-west-1.wasabisys.com/idbwmedia.com/images/idratherbewriting-site-logo.png
social:
name: Tom Johnson
links:
- https://twitter.com/tomjohnson
- https://www.facebook.com/tomidbw
- https://www.linkedin.com/in/tomjoht/
- https://github.com/tomjoht
facebook:
app_id: 247143161970549
publisher: 3968842976464
webmaster_verifications:
google: i1qwK1LFgKEQHUtpm8o7OOOeK9i54NUQwKR4vXRqlFs
bing: 352636FE6BAFC693A6938983FC6A227E
lang: en_US