/
mkdocs.yml
299 lines (293 loc) · 13.8 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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
site_name: Orchard Core Documentation
theme:
name: material
custom_dir: src/docs/theme
logo: assets/images/orchard-logo.png
favicon: assets/images/favicon.png
features:
- navigation.footer
- header.autohide
- navigation.instant
- navigation.tabs
- content.tabs.link
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: green
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
accent: green
toggle:
icon: material/toggle-switch
name: Switch to light mode
static_templates:
- 404.html
extra:
social:
- icon: fontawesome/solid/leaf
link: https://orchardcore.net
- icon: fontawesome/brands/github-alt
link: https://github.com/OrchardCMS/OrchardCore
- icon: fontawesome/brands/twitter
link: https://twitter.com/OrchardCMS
# Repository
repo_name: OrchardCMS/OrchardCore
repo_url: https://github.com/OrchardCMS/OrchardCore
edit_uri: edit/main/src/
# Options
docs_dir: src/docs
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn
# Add files here that are intentionally not in the navigation and thus omitted_files shouldn't warn about them.
not_in_nav: |
samples/
releases/2.0.0.md
# Extensions
markdown_extensions:
- markdown.extensions.admonition
- markdown.extensions.codehilite
- markdown.extensions.def_list
- markdown.extensions.footnotes
- markdown.extensions.meta
# - mdx_truly_sane_lists:
# nested_indent: 2
# truly_sane: True
- pymdownx.b64
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist
- pymdownx.tilde
- toc:
permalink: true
# - markdown.extensions.nl2br
plugins:
- search
- git-authors
- git-revision-date-localized
- exclude:
glob:
# Excluding the large node folder with all its MD files. We can't exclude everything apart from docs because there are links to e.g. C# files too.
- "*node_modules*"
- redirects:
redirect_maps:
'topics/docs-contributions/README.md': 'guides/contributing/contributing-documentation.md'
# Page tree
nav:
- About Orchard Core: README.md
- Getting started:
- Create a CMS Web application: getting-started/README.md
- Test drive Orchard Core: getting-started/test-drive-orchard-core.md
- Configure Preview package source: getting-started/preview-package-source.md
- Recipes and Starter Themes: getting-started/starter-recipes.md
- Code Generation Templates: getting-started/templates/README.md
- Create a Theme: getting-started/theme.md
- Glossary:
- Terms and Concepts: glossary/README.md
- How-to guides:
- Follow the Guides: guides/README.md
- Create a modular application: guides/create-modular-application-mvc/README.md
- Create a website: guides/create-cms-application/README.md
- Leverage CSPROJ meta information: guides/leverage-csproj-meta-info/README.md
- Create a Decoupled CMS site: guides/decoupled-cms/README.md
- Create a webshop using the Commerce module: https://commerce.orchardcore.net/en/latest/guides/create-webshop/
- Add an admin menu: guides/add-admin-menu/README.md
- Implement Full Text search: guides/implement-fulltext-search/README.md
- Install localization files: guides/install-localization-files/README.md
- Integrate Facebook plugins: guides/integrate-facebook-plugins/README.md
- Run code on startup: guides/run-code-on-startup/README.md
- Create a custom admin theme: guides/create-admin-theme/README.md
- Customize encoding settings: guides/encoding-settings/README.md
- Understanding Content Definitions Stores: guides/content-definitions/README.md
- Change password configuration: guides/password-configuration/README.md
- Change lockout configuration: guides/lockout-configuration/README.md
- Microsoft Entra ID (Azure AD) integration: guides/microsoft-entra-id-integration/README.md
- Create a Liquid Widget: guides/create-liquid-widget/README.md
- Query Content Items Based on Taxonomy: guides/query-content-items-based-on-taxonomy/README.md
- Contributing:
- Contributing to Orchard Core: guides/contributing/README.md
- Opening and managing issues: guides/contributing/managing-issues.md
- Contributing code: guides/contributing/contributing-code.md
- Contributing documentation: guides/contributing/contributing-documentation.md
- Reviewing pull requests: guides/contributing/reviewing-pull-requests.md
- Benchmarking: guides/contributing/benchmarking.md
- Gulp pipeline: guides/gulp-pipeline/README.md
- Key Topics:
- Manage your Content: topics/content-management/README.md
- Content Relationships: topics/content-relationships/README.md
- Customize the Display: topics/display/README.md
- Localize your site: topics/localize/README.md
- Handle the Media: topics/media/README.md
- Navigate between pages: topics/navigation/README.md
- Query and Search data: topics/search/README.md
- Secure your application: topics/security/README.md
- Data: topics/data/README.md
- Configuration: topics/configuration/README.md
- Workflows: topics/workflows/README.md
- Publishing a new release: topics/publishing-releases/README.md
- Using Docker: topics/docker/README.md
- Using local NuGet packages: topics/local-nuget-packages/README.md
- Managing the Orchard Core Red Hat Ecosystem Catalog certification: topics/red-hat-ecosystem-catalog-certification/README.md
- Reference:
- reference/README.md
- CMS Modules:
- Content Types: reference/modules/ContentTypes/README.md
- Content Parts:
- Add Parts to your Content: reference/modules/ContentParts/README.md
- Title: reference/modules/Title/README.md
- Autoroute: reference/modules/Autoroute/README.md
- Alias: reference/modules/Alias/README.md
- Html: reference/modules/Html/README.md
- Markdown: reference/modules/Markdown/README.md
- List: reference/modules/Lists/README.md
- Flow: reference/modules/Flow/README.md
- Bag: reference/modules/Flow/BagPart.md
- Publish Later: reference/modules/PublishLater/README.md
- SEO Meta: reference/modules/Seo/README.md
- Content Fields: reference/modules/ContentFields/README.md
- Content Preview: reference/modules/ContentPreview/README.md
- Content Localization: reference/modules/ContentLocalization/README.md
- Layers: reference/modules/Layers/README.md
- Widgets: reference/modules/Widgets/README.md
- Forms: reference/modules/Forms/README.md
- Templates: reference/modules/Templates/README.md
- Placements: reference/modules/Placements/README.md
- Themes: reference/modules/Themes/README.md
- Liquid: reference/modules/Liquid/README.md
- Media:
- Media: reference/modules/Media/README.md
- Media Slugify: reference/modules/Media.Slugify/README.md
- Media Amazon S3: reference/modules/Media.AmazonS3/README.md
- Media Azure: reference/modules/Media.Azure/README.md
- ReCaptcha: reference/modules/ReCaptcha/README.md
- Resources: reference/modules/Resources/README.md
- Rules: reference/modules/Rules/README.md
- Search, Indexing, Querying:
- Azure AI Search: reference/modules/AzureAISearch/README.md
- Elasticsearch: reference/modules/Elasticsearch/README.md
- Indexing: reference/modules/Indexing/README.md
- Lucene: reference/modules/Lucene/README.md
- SQL Indexing: reference/modules/SQLIndexing/README.md
- Queries: reference/modules/Queries/README.md
- Shortcodes: reference/modules/Shortcodes/README.md
- Sitemaps: reference/modules/Sitemaps/README.md
- SMS: reference/modules/Sms/README.md
- Spatial: reference/modules/Spatial/README.md
- XML-RPC: reference/modules/XmlRpc/README.md
- Menu: reference/modules/Menu/README.md
- Navigation: reference/modules/Navigation/README.md
- Admin: reference/modules/Admin/README.md
- Admin Dashboard: reference/modules/AdminDashboard/README.md
- Admin Menu: reference/modules/AdminMenu/README.md
- Taxonomies: reference/modules/Taxonomies/README.md
- Authentication:
- Microsoft: reference/modules/Microsoft.Authentication/README.md
- Facebook: reference/modules/Facebook/README.md
- X (Twitter): reference/modules/X/README.md
- GitHub: reference/modules/GitHub/README.md
- Google: reference/modules/Google/README.md
- Users:
- Overview: reference/modules/Users/README.md
- Custom User Settings: reference/modules/Users/CustomUserSettings/README.md
- Notifications: reference/modules/Notifications/README.md
- Ticket store: reference/modules/Users/TicketStore.md
- Home Route: reference/modules/HomeRoute/README.md
- Feeds: reference/modules/Feeds/README.md
- Commerce: https://commerce.orchardcore.net/en/latest
- Core Modules:
- Audit Trail: reference/modules/AuditTrail/README.md
- Auto Setup: reference/modules/AutoSetup/README.md
- Features: reference/modules/Features/README.md
- Contents: reference/modules/Contents/README.md
- Configuration: reference/core/Configuration/README.md
- Cors: reference/modules/Cors/README.md
- Custom Settings: reference/modules/CustomSettings/README.md
- Deployment: reference/modules/Deployment/README.md
- Placement: reference/core/Placement/README.md
- Data: reference/core/Data/README.md
- Data Migrations: reference/modules/Migrations/README.md
- Diagnostics: reference/modules/Diagnostics/README.md
- Dynamic Cache: reference/modules/DynamicCache/README.md
- Email: reference/modules/Email/README.md
- SMTP Provider: reference/modules/Email.Smtp/README.md
- Azure Email Provider: reference/modules/Email.Azure/README.md
- GraphQL: reference/modules/Apis.GraphQL/README.md
- GraphQL queries: reference/core/Apis.GraphQL.Abstractions/README.md
- Health Check: reference/modules/HealthChecks/README.md
- HTTPS: reference/modules/Https/README.md
- Key Vault (Azure): reference/core/KeyVault.Azure/README.md
- Localization: reference/modules/Localize/README.md
- Logging Serilog: reference/core/Logging.Serilog/README.md
- Mini Profiler: reference/modules/MiniProfiler/README.md
- Modules: reference/core/Modules/README.md
- OpenId: reference/modules/OpenId/README.md
- Razor Helpers: reference/core/Razor/README.md
- Recipes: reference/modules/Recipes/README.md
- Redis: reference/modules/Redis/README.md
- Remote Deployment: reference/modules/Deployment.Remote/README.md
- Response Compression: reference/modules/ResponseCompression/README.md
- Roles: reference/modules/Roles/README.md
- Sanitizer: reference/core/Sanitizer/README.md
- Scripting: reference/modules/Scripting/README.md
- Security: reference/modules/Security/README.md
- Setup: reference/modules/Setup/README.md
- Shells: reference/core/Shells/README.md
- Tenants: reference/modules/Tenants/README.md
- Workflows: reference/modules/Workflows/README.md
- DataProtection (Azure Storage): reference/modules/DataProtection.Azure/README.md
- Background Tasks: reference/modules/BackgroundTasks/README.md
- Reverse Proxy: reference/modules/ReverseProxy/README.md
- Resources:
- Learning: resources/README.md
- Tutorials: resources/tutorials/README.md
- Development Tools: resources/development-tools/README.md
- Meeting: resources/meeting/README.md
- Branding: resources/branding/README.md
- Libraries: resources/libraries/README.md
- Owners: resources/owners/README.md
- Workshops: resources/workshops/README.md
- Releases:
- 1.8.3: releases/1.8.3.md
- 1.8.2: releases/1.8.2.md
- 1.8.1: releases/1.8.1.md
- 1.8.0: releases/1.8.0.md
- 1.7.2: releases/1.7.2.md
- 1.7.1: releases/1.7.1.md
- 1.7.0: releases/1.7.0.md
- 1.6.0: releases/1.6.0.md
- 1.5.0: releases/1.5.0.md
- 1.4.0: releases/1.4.0.md
- 1.3.0: releases/1.3.0.md
- 1.2.2: releases/1.2.2.md
- 1.2.1: releases/1.2.1.md
- 1.2.0: releases/1.2.0.md
- 1.1.0: releases/1.1.0.md
- 1.0.0: releases/1.0.0.md
- 1.0.0-rc2: releases/1.0.0-rc2.md
- 1.0.0-rc1: releases/1.0.0-rc1.md
- 1.0.0-beta3: releases/1.0.0-beta3.md
- 1.0.0-beta2: releases/1.0.0-beta2.md
- 1.0.0-beta1: releases/1.0.0-beta1.md
- Community:
- Overview: community/README.md
- Contributors:
- Our wonderful contributors: community/contributors/README.md
- Contributors Map: community/contributors/Map.md
- Honorable Members:
- Jean-Thierry Kéchichian: community/jean-thierry/README.md
- Jean-Thierry Kéchichian Community Award: community/jean-thierry-community-award/README.md