-
Notifications
You must be signed in to change notification settings - Fork 59
/
_config.yml
122 lines (107 loc) · 3.08 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
title: Documenting APIs
description: A guide for technical writers and engineers working with APIs
site_logo_file: learnapidoclogo-01.svg
language: english
sidebar: docapis
media: https://s3.us-west-1.wasabisys.com/idbwmedia.com/images/api
# Link to home
url: https://idratherbewriting.com
baseurl: /learnapidoc
destination: _site
port: 4000
highlighter: rouge
exclude:
- ebooks
- pdf
format: web
plugins:
- jekyll-mentions
- jekyll-redirect-from
- jekyll-paginate
# comment out jekyll-seo in order for algolia reindex to work
- jekyll-seo
markdown: kramdown
kramdown:
input: GFM
auto_ids: true
hard_wrap: false
syntax_highlighter: rouge
collections:
docs:
output: false
sass:
style: compressed
defaults:
-
scope:
path: ""
type: pages
values:
layout: default
topnav: topnav
-
scope:
path: ""
type: docs
values:
layout: default
topnav: topnav
progress: true
-
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
####### Algolia configuration ###########
algolia:
application_id: 7JEKBAXL1Y
index_name: learnapidocs
search_only_api_key: 268324bcfa734077d7983ed51a671760
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/*
nodes_to_index: 'p,.description'
####### jekyll seo tag configuration #######
title: Documenting APIs
tagline: A guide for technical writers and engineers learning how to document APIs
description: Online course about creating API documentation, mostly focusing on REST APIs but covering strategies for developer documentation in general. 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