forked from ibexa/documentation-developer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
218 lines (217 loc) · 13.5 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
site_name: eZ Platform Developer Documentation
repo_url: https://github.com/ezsystems/developer-documentation
copyright: "Copyright 1999-2017 eZ Systems AS and others"
site_favicon: img/favicon.ico
pages:
- 'Documentation': 'index.md'
- Getting started:
- 'Get started with eZ Platform': 'getting_started/get_started_with_ez_platform.md'
- 'Requirements and system configuration': 'getting_started/requirements_and_system_configuration.md'
- Installation:
- 'Install eZ Platform': 'getting_started/install_ez_platform.md'
- 'Install using Composer': 'getting_started/install_using_composer.md'
- 'Install manually': 'getting_started/install_manually.md'
- 'Install using Docker': 'getting_started/install_using_docker.md'
- 'Starting eZ Platform': 'getting_started/starting_ez_platform.md'
- 'Set up directory permissions': 'getting_started/set_up_directory_permissions.md'
- 'Troubleshooting': 'getting_started/troubleshooting.md'
- Going deeper:
- 'eZ Platform features': 'getting_started/ez_platform_features.md'
- 'eZ Enterprise': 'getting_started/ez_enterprise.md'
- 'About Composer': 'getting_started/about_composer.md'
- Tutorials:
- 'Tutorials': 'tutorials/tutorials.md'
- eZ Platform Beginner tutorial:
- 'Building a bicycle route tracker in eZ Platform': 'tutorials/platform_beginner/building_a_bicycle_route_tracker_in_ez_platform.md'
- '1. Getting ready': 'tutorials/platform_beginner/1_getting_ready.md'
- '2. Creating your content model': 'tutorials/platform_beginner/2_creating_your_content_model.md'
- '3. Customizing the general layout': 'tutorials/platform_beginner/3_customizing_the_general_layout.md'
- '4. Displaying content of a ride': 'tutorials/platform_beginner/4_displaying_content_of_a_ride.md'
- '5. Displaying the list of rides on the homepage': 'tutorials/platform_beginner/5_displaying_the_list_of_rides_on_the_homepage.md'
- '6. Enabling Account Registration': 'tutorials/platform_beginner/6_enabling_account_registration.md'
- '7. Customize the User forms': 'tutorials/platform_beginner/7_customize_login_and_register_forms.md'
- eZ Enterprise Beginner tutorial:
- 'eZ Enterprise beginner tutorial - It's a dog's world!': 'tutorials/enterprise_beginner/ez_enterprise_beginner_tutorial_-_its_a_dogs_world.md'
- '1. Getting your starter website': 'tutorials/enterprise_beginner/1_getting_your_starter_website.md'
- '2. Preparing the Landing Page': 'tutorials/enterprise_beginner/2_preparing_the_landing_page.md'
- '3. Using existing blocks': 'tutorials/enterprise_beginner/3_using_existing_blocks.md'
- '4. Creating a custom block': 'tutorials/enterprise_beginner/4_creating_a_custom_block.md'
- Field Type Creation Tutorial:
- 'Creating a Tweet Field Type': 'tutorials/field_type/creating_a_tweet_field_type.md'
- '1. Create the bundle': 'tutorials/field_type/1_create_the_bundle.md'
- '2. Implement the Tweet\Value Class': 'tutorials/field_type/2_implement_the_tweet_value_class.md'
- '3. Implement the Tweet\Type Class': 'tutorials/field_type/3_implement_the_tweet_type_class.md'
- '4. Register the Field Type as a service': 'tutorials/field_type/4_register_the_field_type_as_a_service.md'
- '5. Implement the legacy storage engine': 'tutorials/field_type/5_implement_the_legacy_storage_engine_converter.md'
- '6. Introduce a template': 'tutorials/field_type/6_introduce_a_template.md'
- '7. Add content and edit views': 'tutorials/field_type/7_add_content_and_edit_views.md'
- '8. Add a validation': 'tutorials/field_type/8_add_a_validation.md'
- Extending Admin UI:
- 'Extending Admin UI': 'tutorials/extending_admin_ui/extending_admin_ui.md'
- '1. Creating a bundle': 'tutorials/extending_admin_ui/1_creating_a_bundle.md'
- '2. Creating a Dashboard tab': 'tutorials/extending_admin_ui/2_creating_a_dashboard_tab.md'
- '3. Creating a content list': 'tutorials/extending_admin_ui/3_creating_a_content_list.md'
- '4. Filtering the content list': 'tutorials/extending_admin_ui/4_filtering_the_content_list.md'
- '5. Creating a UDW tab': 'tutorials/extending_admin_ui/5_creating_a_udw_tab.md'
- '6. Creating a custom tag': 'tutorials/extending_admin_ui/6_adding_a_custom_tag.md'
- API:
- REST API guide:
- 'REST API guide': 'api/rest_api_guide.md'
- 'REST API usage': 'api/general_rest_usage.md'
- 'Extending the REST API': 'api/extending_the_rest_api.md'
- 'JavaScript client': 'api/js_client.md'
- 'REST API reference': 'api/rest_api_reference.md'
- Public PHP API:
- 'Public PHP API': 'api/public_php_api.md'
- 'Customization': 'api/public_php_api_customization.md'
- 'Browsing, finding, viewing': 'api/public_php_api_browsing.md'
- 'Managing Content': 'api/public_php_api_managing_content.md'
- 'Locations': 'api/public_php_api_locations.md'
- Field Type:
- 'Field Type API': 'api/field_type_api.md'
- 'Reference': 'api/field_type_reference.md'
- 'REST API interaction': 'api/field_type_REST.md'
- 'Public API interaction': 'api/field_type_public.md'
- 'Schema': 'api/field_type_setting_schema.md'
- 'Template': 'api/field_type_template.md'
- 'Registration': 'api/field_type_registration.md'
- 'Testing': 'api/field_type_testing.md'
- 'Storage': 'api/field_type_storage.md'
- 'Search': 'api/field_type_search.md'
- Guide:
- Introduction:
- 'Architecture': 'guide/architecture.md'
- 'Bundles': 'guide/bundles.md'
- 'Content model': 'guide/content_model.md'
- 'Configuration': 'guide/configuration.md'
- Content rendering:
- 'Content rendering': 'guide/content_rendering.md'
- 'Controllers': 'guide/controllers.md'
- 'Templates': 'guide/templates.md'
- 'Design engine': 'guide/design_engine.md'
- 'Landing Page rendering': 'guide/landing_page_rendering.md'
- 'Twig functions reference': 'guide/twig_functions_reference.md'
- Content management:
- 'Images': 'guide/images.md'
- 'File management': 'guide/file_management.md'
- 'URL management': 'guide/url_management.md'
- 'User management': 'guide/user_management.md'
- 'User-generated content': 'guide/user_generated_content.md'
- Permissions:
- 'Permissions': 'guide/permissions.md'
- 'Limitations': 'guide/limitations.md'
- 'Custom Policies': 'guide/custom_policies.md'
- Search:
- 'Search': 'guide/search.md'
- 'Solr search engine': 'guide/solr.md'
- 'Other search engines': 'guide/search_engines.md'
- Multisite:
- 'Multisite': 'guide/multisite.md'
- 'SiteAccess': 'guide/siteaccess.md'
- 'Internationalization': 'guide/internationalization.md'
- Repository:
- 'Repository': 'guide/repository.md'
- 'SignalSlots': 'guide/signalslots.md'
- Cache:
- 'HTTP cache': 'guide/http_cache.md'
- 'Persistence cache': 'guide/persistence_cache.md'
- 'Clustering': 'guide/clustering.md'
- DevOps:
- 'DevOps': 'guide/devops.md'
- 'Performance': 'guide/performance.md'
- 'Environments': 'guide/environments.md'
- 'Sessions': 'guide/sessions.md'
- 'Security': 'guide/security.md'
- Extending eZ Platform:
- 'Extending eZ Platform': 'guide/extending_ez_platform.md'
- 'Extending modules': 'guide/extending_modules.md'
- 'Extending the Online Editor': 'guide/extending_online_editor.md'
- 'Extending Landing Page': 'guide/extending_landing_page.md'
- 'Extending the Form Builder': 'guide/extending_form_builder.md'
- 'Service container': 'guide/service_container.md'
- 'Personalization': 'guide/personalization.md'
- 'Best practices': 'guide/best_practices.md'
- Cookbook:
- 'Adding new Field Types': 'cookbook/adding_new_field_types.md'
- 'Authenticating a user with multiple user providers': 'cookbook/authenticating_a_user_with_multiple_user_providers.md'
- 'Converting request paremeters into API objects': 'cookbook/converting_request_parameters_into_api_objects.md'
- 'Creating content with binary attachments via REST API': 'cookbook/creating_content_with_binary_attachments_via_rest_api.md'
- 'Displaying children of a Content item': 'cookbook/displaying_children_of_a_content_item.md'
- 'Displaying content with simple templates': 'cookbook/displaying_content_with_simple_templates.md'
- 'Executing long-running console commands': 'cookbook/executing_long_running_console_commands.md'
- 'Exposing Siteaccess-aware configuration for your bundle': 'cookbook/exposing_siteaccess_aware_configuration_for_your_bundle.md'
- 'Importing settings from a bundle': 'cookbook/importing_settings_from_a_bundle.md'
- 'Injecting parameters in content views': 'cookbook/injecting_parameters_in_content_views.md'
- 'Listening to core events': 'cookbook/listening_to_core_events.md'
- 'Making cross-origin HTTP requests': 'cookbook/making_cross_origin_http_requests.md'
- 'Paginating API search results': 'cookbook/paginating_api_search_results.md'
- 'Retrieving root Location': 'cookbook/retrieving_root_location.md'
- 'Sending notifications': 'cookbook/sending_notifications.md'
- 'Setting up Amazon AWS S3 clustering': 'cookbook/setting_up_amazon_aws_s3_clustering.md'
- 'Setting up multi-language SiteAccesses and corresponding translations': 'cookbook/setting_up_multi_language_siteaccesses.md'
- 'Using RouteReference': 'cookbook/using_routereference.md'
- Resources and community:
- 'Resources': 'community_resources/resources.md'
- 'Professional training services': 'community_resources/professional_training_services.md'
- 'Contributing': 'community_resources/contributing.md'
- Migrating to eZ Platform:
- 'Migrating from eZ Publish Platform': 'migrating/migrating_from_ez_publish_platform.md'
- 'Migrating from eZ Publish': 'migrating/migrating_from_ez_publish.md'
- Releases:
- 'Updating eZ Platform': 'releases/updating_ez_platform.md'
- 'eZ Platform v2.1.0': 'releases/ez_platform_v2.1.0.md'
- 'eZ Platform v2.0.0': 'releases/ez_platform_v2.0.0.md'
- 'eZ Platform v1.13.0 LTS': 'releases/ez_platform_v1.13.0_lts.md'
- 'eZ Platform v1.12.0': 'releases/ez_platform_v1.12.0.md'
- 'eZ Platform v1.11.0': 'releases/ez_platform_v1.11.0.md'
- 'eZ Platform v1.10.0': 'releases/ez_platform_v1.10.0.md'
- 'eZ Platform v1.9.0': 'releases/ez_platform_v1.9.0.md'
- 'eZ Platform v1.8.0': 'releases/ez_platform_v1.8.0.md'
- 'eZ Platform v1.7.0 LTS': 'releases/ez_platform_v1.7.0_lts.md'
- 'eZ Platform v1.6.0': 'releases/ez_platform_and_ez_enterprise_v1.6.0.md'
- eZ Enterprise release notes:
- 'eZ Enterprise v1.5.0': 'releases/ez_enterprise_v1.5.0_release_notes.md'
- 'eZ Enterprise v1.4.0': 'releases/ez_enterprise_v1.4_release_notes.md'
- 'eZ Studio 2016.04': 'releases/ez_studio_2016.04_release_notes.md'
- 'eZ Studio 16.02': 'releases/ez_studio_16.02_release_notes.md'
- 'eZ Studio 15.12.1': 'releases/ez_studio_15.12.1_release_notes.md'
- 'eZ Studio 15.12': 'releases/ez_studio_15.12_release_notes.md'
- eZ Platform release notes:
- 'eZ Platform v1.5.1': 'releases/ez_platform_1.5.1_release_notes.md'
- 'eZ Platform v1.5.0': 'releases/ez_platform_v1.5.0_release_notes.md'
- 'eZ Platform v1.4.2': 'releases/ez_platform_1.4.2_release_notes.md'
- 'eZ Platform v1.4.0': 'releases/ez_platform_v1.4.0_release_notes.md'
- 'eZ Platform 2016.04': 'releases/ez_platform_2016.04_release_notes.md'
- 'eZ Platform 16.02': 'releases/ez_platform_16.02_release_notes.md'
- 'eZ Platform 15.12.1': 'releases/ez_platform_15.12.1_release_notes.md'
- 'eZ Platform 15.12': 'releases/ez_platform_15.12_release_notes.md'
- 'Earlier releases': 'releases/earlier_releases.md'
- 'References': 'references.md'
#theme: material
theme_dir: material
extra_css: [fonts/MavenPro.css, css/custom.css]
extra_javascript: [js/jquery.min.js, js/custom.js]
markdown_extensions:
- markdown.extensions.admonition
- markdown.extensions.codehilite:
guess_lang: false
linenums: true
- markdown.extensions.def_list
- markdown.extensions.footnotes
- markdown.extensions.meta
- markdown.extensions.toc(permalink=true)
- pymdownx.arithmatex
- pymdownx.betterem(smart_enable=all)
- pymdownx.caret
- pymdownx.critic
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist(custom_checkbox=true)
- pymdownx.tilde
- pymdownx.details
#extra:
# font:
# text: 'Maven Pro'