-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathmkdocs.yml
233 lines (224 loc) · 9.53 KB
/
mkdocs.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
site_name: Flotiq Developer Documentation
site_url: https://flotiq.com/docs/
#repo_url: https://github.com/flotiq/flotiq-docs/
edit_uri: https://github.com/flotiq/flotiq-docs/edit/master/docs/
copyright: Copyright © 2019 onwards <a target="_blank" href="https://www.flotiq.com/">Flotiq<a>
dev_addr: 0.0.0.0:4000
theme:
name: material
logo: /docs/API/images/f.png
favicon: /docs/API/images/favicon-32x32.png
custom_dir: theme
language: en
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: '#0083FC'
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
accent: custom
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.top
- content.action.edit
- content.action.view
- search.suggest
- search.highlight
- content.code.copy
plugins:
- alias:
verbose: true
use_anchor_titles: true
- search
- awesome-pages
- glightbox
- include_dir_to_nav:
file_pattern: '\d.*\.md$'
- git-revision-date-localized:
fallback_to_build_date: true
- markdownextradata:
jinja_options:
variable_start_string: "<<"
variable_end_string: ">>"
- tags:
tags_file: tags.md
extra_css:
- https://cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/default.min.css
- https://cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/nord.min.css
- https://flotiq-form-generator-styles.s3.amazonaws.com/styles.css
- 'css/flotiq.css'
# - https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.30.0/codemirror.min.css
markdown_extensions:
- markdown.extensions.extra
- admonition
- attr_list
- codehilite
- meta
- toc:
permalink: true
title: On this page
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_div_format
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- theme/.icons
- pymdownx.tabbed:
alternate_style: true
- footnotes
extra_javascript:
- https://unpkg.com/[email protected]/dist/mermaid.min.js
- https://cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/highlight.min.js
- https://unpkg.com/was-it-helpful@latest/dist/build.js
- 'js/flotiq.js'
#- https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.30.0/codemirror.min.js
#- https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.30.0/mode/javascript/javascript.min.js
extra:
analytics:
provider: custom
social:
- icon: fontawesome/brands/discord
link: https://discord.com/invite/FwXcHnX
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/channel/UC4wpV-D9mIt1JjN_g_iyXXw
- icon: custom/twitter
link: https://twitter.com/flotiq
- icon: fontawesome/brands/github-alt
link: https://github.com/flotiq
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/flotiq/
plan_names:
free: 'Free'
paid_1: 'Basic'
paid_2: 'Growth'
paid_3: 'Custom'
nav:
- 'Home': index.md
- API:
- 'Getting Started with API': API/get-started.md
- 'API access & scoped keys': API/index.md
- 'Working with Content Types':
- 'Overview': API/content-types.md
- 'Creating new Content Types': API/content-type/creating-ctd.md
- 'Updating Content Types': API/content-type/updating-ctd.md
- 'Listing Content Types': API/content-type/listing-ctd.md
- 'Getting single Content Type': API/content-type/getting-ctd.md
- 'Deleting Content Type': API/content-type/deleting-ctd.md
- 'Working with Content Objects':
- 'Overview': API/content-objects.md
- 'Creating new Content Objects': API/content-type/creating-co.md
- 'Updating Content Objects': API/content-type/updating-co.md
- 'Listing Content Objects': API/content-type/listing-co.md
- 'Getting single Content Object': API/content-type/getting-co.md
- 'Deleting Content Objects': API/content-type/deleting-co.md
- 'Listing deleted Content Objects': API/content-type/listing-deleted-co.md
- 'Dynamic Content API': API/dynamic-content-api.md
- 'GraphQL': API/graph-ql.md
- 'Generating SDKs':
- 'Overview': API/generate-package.md
- 'SDK NodeJS': API/generate-package/sdk-nodejs.md
- 'Open API schema': API/open-api-schema.md
- 'Full-text search': API/search.md
- 'Working with media':
- 'Media library': API/media-library.md
- 'Transformations': API/variants.md
- 'Workflows': 'API/workflow/content-publishing-workflow.md'
- Dashboard:
- 'Overview': panel/index.md
- 'Spaces and Organization': panel/spaces.md
- 'Content types': panel/content-types.md
- 'Flotiq Forms': panel/flotiq-forms-add-forms-to-websites.md
- 'Predefined Content Types': panel/predefined-content-types.md
- 'Content objects': panel/content-objects.md
- 'Media library': panel/media-library.md
- 'Users': panel/users.md
- 'User Roles': panel/user-roles.md
- Webhooks:
- 'Overview': panel/webhooks/index.md
- 'Async CO webhooks': panel/webhooks/async-co-webhook.md
- 'CTD webhooks': panel/webhooks/ctd-webhook.md
- 'Async examples': panel/webhooks/examples.md
- 'Sync webhooks': panel/webhooks/sync.md
- 'Sync examples': panel/webhooks/sync-examples.md
- 'Hosted webhooks': panel/webhooks/hosted-webhook.md
- Available Plugins:
- 'Gatsby Cloud': panel/Plugins/Gatsby-cloud-integration.md
- 'Netlify': panel/Plugins/Netlify-integration.md
- 'Custom Links': panel/Plugins/Custom-links.md
- 'Slug': panel/Plugins/Slug.md
- UI Plugins Development:
- 'Getting started': panel/PluginsDevelopment/plugins.md
- 'Examples': panel/PluginsDevelopment/plugin-examples.md
- 'Faq & Troubleshooting': panel/PluginsDevelopment/plugin-faq-and-troubleshooting.md
- Plugins API Reference: panel/PluginsDevelopment/PluginDocs/
- CLI:
- 'Overview': CLI/index.md
- 'Migrating Flotiq data between Spaces': CLI/migrating-data-between-spaces.md
- 'Starting new project with Gatsby and Flotiq': CLI/starting-new-project-gatsby.md
- 'Starting new project with Next.js and Flotiq': CLI/starting-new-project-nextjs.md
- 'Migrate WordPress blog content to Flotiq': CLI/wordpress-importer.md
- 'Migrate content from Contentful to Flotiq': CLI/contentful-importer.md
- 'Purging data from Flotiq account': CLI/purge.md
- 'Migrating Flotiq data to and from MS Excel': CLI/excel-data-migration.md
- Flotiq Universe:
- 'Overview': Universe/index.md
- Deployment:
- 'Overview': Universe/deployment/overview.md
- 'NextJS project to Vercel': Universe/deployment/vercel-nextjs.md
- 'Gatsby project to Vercel': Universe/deployment/vercel-gatsby.md
- 'NextJS project to Netlify': Universe/deployment/netlify-nextjs.md
- 'Gatsby project to Netlify': Universe/deployment/netlify-gatsby.md
- 'Gatsby': Universe/gatsby.md
- 'NextJS': Universe/nextjs.md
- 'Meta-API': Universe/metaapi.md
- 'Postman': Universe/postman.md
- 'Scully': Universe/scully.md
- 'WordPress': Universe/wordpress.md
- 'Zapier': Universe/zapier.md
# - 'Netlify': Universe/netlify.md
- 'Heroku': Universe/heroku.md
- 'Bubble': Universe/bubble.md
- 'Pabbly': Universe/pabbly.md
- 'n8n': Universe/n8n.md
- Deep dives:
- 'Overview': Deep-Dives/index.md
- 'Hooking React TodoMVC with Flotiq': Deep-Dives/todomvc-react-headless-cms.md
- 'Angular 9 with Flotiq SDK': Deep-Dives/angular-headless-cms.md
- 'Mobile product showcase application': Deep-Dives/mobile-expo-product-showcase.md # TO UPDATE
- 'Building a blog': Deep-Dives/Building-a-blog-in-3-minutes.md
- 'Building a contact form': Deep-Dives/Headless-CMS-Contact-Forms.md
- 'Building a banner rotator': Deep-Dives/building-a-banner-rotator-with-an-admin-interface.md
- 'Building a store locator': Deep-Dives/storing-location-data-headless-cms.md
- 'Complex data structures': Deep-Dives/jamstack-recipes-website-complex-data-structures.md
- 'Importing from WordPress': Deep-Dives/wordpress-import.md
- 'E-commerce with Snipcart & Gatsby': Deep-Dives/node-js-ecommerce-snipcart-gatsby-demo.md
- 'Full-text search': Deep-Dives/search-api-deepdive.md
- 'Multilingual content': Deep-Dives/multilingual-content.md
- 'Securing JAMstack APIs': Deep-Dives/securing-write-api-access.md
- 'Meta-API': Deep-Dives/metaapi.md
- 'Custom domains in Heroku': Deep-Dives/add-a-custom-domain-to-heroku-for-free.md
- 'Use Netlify, Zapier and Gatsby to instantly deploy your Flotiq content': 'Deep-Dives/netlify-zapier-gatsby-serverless-deployment-pipeline.md'
- 'Use Next.js, Typescript and OpenAPI with Flotiq content': 'Deep-Dives/nextjs-react-typescript-openapi.md'
- 'Upload media example app': Deep-Dives/upload-media.md
- 'Build headless no-code website Divhunt': Deep-Dives/divhunt.md
- 'Build headless no-code website Webstudio': Deep-Dives/webstudio.md
- Flotiq Mobile Expo: Flotiq-Mobile-Expo/overview.md
- FAQ: faq.md
- Tags: tags.md
- 'Contact us': '../contact'