-
Notifications
You must be signed in to change notification settings - Fork 799
/
Copy pathmkdocs-test.yml
174 lines (173 loc) · 6.69 KB
/
mkdocs-test.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
site_name: n8n Docs
site_url: https://docs.n8n.io/
site_description: Documentation for n8n, a workflow automation platform.
# Must be the docs repo for the edit page buttons to work
repo_url: https://github.com/n8n-io/n8n-docs
edit_uri: edit/main/docs/
validation:
nav:
omitted_files: info
not_found: warn
absolute_links: ignore
links:
not_found: warn
absolute_links: relative_to_docs
unrecognized_links: info
theme:
name: material
custom_dir: _overrides
favicon: _images/favicon.ico
font: false
language: custom
logo: _images/n8n-docs-icon.svg
palette:
scheme: light
features:
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/#announcement-bar
- announce.dismiss
# https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions
- content.action.edit
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-annotations
- content.code.annotate
# https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#linked-content-tabs
- content.tabs.link
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-copy-button
- content.code.copy
# https://squidfunk.github.io/mkdocs-material/reference/tooltips/#improved-tooltips
- content.tooltips
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/?h=footer#navigation
- navigation.footer
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
- navigation.indexes
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-path
- navigation.path
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections
- navigation.sections
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=navigation+tabs#navigation-tabs
- navigation.tabs
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#back-to-top-button
- navigation.top
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=navigation+tabs#anchor-tracking
- navigation.tracking
copyright: >
<a href="#__consent">Change cookie settings</a>
extra:
analytics:
provider: google
property: G-0SC4FF2FH9
consent:
title: Cookie consent
description: >-
We use cookies and other tracking technologies to improve your browsing experience,
to analyze our website traffic, assist our marketing efforts and to understand where
our visitors are coming from. <br /><a href="https://n8n.io/legal/" target=_blank>Privacy policy</a>
# https://squidfunk.github.io/mkdocs-material/reference/#setting-the-page-status
status:
beta: This feature is in beta
# https://squidfunk.github.io/mkdocs-material/customization/?h=#additional-css
extra_css:
- _extra/css/extra.css
- _extra/css/macro-styles.css
- _extra/css/templates-widget.css
- _extra/css/workflow-demo.css
- _extra/css/feedback.css
# https://squidfunk.github.io/mkdocs-material/customization/?h=#additional-javascript
extra_javascript:
- _extra/javascript/extra.js
watch:
- _glossary
- _snippets
markdown_extensions:
# used for https://squidfunk.github.io/mkdocs-material/reference/tooltips/
- abbr
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=attr#attribute-lists
# attr_list is required for several other features. Always enable.
- attr_list
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#automatic-previews
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html
- md_in_html
- meta
- pymdownx.blocks.admonition:
types:
- note
- info
- tip
- question
- warning
- danger
# custom types
- details
- pymdownx.details
# https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight
- pymdownx.highlight:
linenums: true
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#inlinehilite
- pymdownx.inlinehilite
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#keys
- pymdownx.keys
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#snippets
- pymdownx.snippets:
auto_append:
- _glossary/main.md
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences Superfences is required for several other features. Always enable.
- pymdownx.superfences:
# https://squidfunk.github.io/mkdocs-material/reference/diagrams/
custom_fences:
- name: mermaid
class: mermaid
format:
!!python/name:pymdownx.superfences.fence_code_format
# https://facelessuser.github.io/pymdown-extensions/extensions/superfences/#preserve-tabs
preserve_tabs: true
- pymdownx.tasklist:
custom_checkbox: true
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tabbed
- pymdownx.tabbed:
alternate_style: true
- sane_lists
- tables
# https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages
- toc:
permalink: "#"
plugins:
# You need the info plugin for bug reports to Material theme
# But DO NOT ENABLE IT NORMALLY
# It causes Netlify builds to fail
# - info
# Search is built in, but must be enabled when you add other plugins
- search
- exclude:
glob:
# - integrations/builtin/*
# https://squidfunk.github.io/mkdocs-material/reference/images/#lightbox
- glightbox:
touchNavigation: false
loop: false
effect: zoom
slide_effect: none
width: auto
height: auto
zoomable: false
draggable: false
auto_caption: false
caption_position: bottom
# https://mkdocs-macros-plugin.readthedocs.io/en/latest/
- macros:
# https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#including-external-yaml-files
include_yaml:
- _yaml/data-functions.yml
j2_block_start_string: "[[%"
j2_block_end_string: "%]]"
j2_variable_start_string: "[["
j2_variable_end_string: "]]"
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/
- tags:
enabled: true
# https://squidfunk.github.io/mkdocs-material/plugins/privacy/
# This is enabled to automatically add `target="_blank"` to external links.
# Specifically, we needed some way to open nav links to external locations
# (like the main site) in new tabs
- privacy:
assets: false
INHERIT: ./nav.yml