forked from geosolutions-it/MapStore2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
207 lines (206 loc) · 9.28 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
site_name: MapStore
site_url: 'https://mapstore.geosolutionsgroup.com'
copyright: <b><a href="https://mapstore.geosolutionsgroup.com" target="_blank">MapStore©</a></b> is Free and Open Source software and is licensed under the Simplified BSD License.
use_directory_urls: true
theme:
name: 'material'
highlightjs: true
icon:
logo: 'img/mapstore2-logo.png'
repo: 'fontawesome/brands/github-alt'
favicon: 'img/favicon.ico'
custom_dir: 'docs/theme'
language: 'en'
features:
- header.autohide
- navigation.instant
- navigation.top
- navigation.tabs
- navigation.tabs.sticky
- navigation.path
- navigation.indexes
- navigation.footer
- content.code.copy
logo: 'img/mapstore2-logo.png'
company_url: 'http://www.geo-solutions.it'
company_logo: 'img/geosolutions-brand.png'
company_contacts: 'GeoSolutions | [email protected] '
palette:
primary: 'teal'
accent: 'teal'
extra:
repo_icon: 'github'
social:
- type: 'github'
icon: 'fontawesome/brands/github'
link: 'https://github.com/geosolutions-it'
- type: 'twitter'
icon: 'fontawesome/brands/x-twitter'
link: 'https://twitter.com/geosolutions_it'
- type: 'linkedin'
icon: 'fontawesome/brands/linkedin'
link: 'https://it.linkedin.com/company/geosolutions-s-a-s-'
extra_javascript:
- 'https://code.jquery.com/jquery-3.3.1.min.js'
- 'https://unpkg.com/[email protected]/dist/mermaid.min.js'
extra_css:
- 'theme/css/extra.css'
repo_name: 'geosolutions-it/MapStore2'
repo_url: 'https://github.com/geosolutions-it/MapStore2/'
edit_uri: ''
docs_dir: 'docs'
markdown_extensions:
- admonition
- markdown.extensions.attr_list
- codehilite:
linenums: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_div_format
nav:
- Home:
- Home: 'index.md' # To include in pdf
- Quick Start: 'quick-start.md'
- User Guide:
- Home Page Overview: 'user-guide/home-page.md'
- Managing Users and Groups:
- Overview: 'user-guide/managing-users-and-groups.md'
- Managing Users: 'user-guide/managing-users.md'
- Managing Groups: 'user-guide/managing-groups.md'
- Managing Contexts:
- Overview: 'user-guide/managing-contexts.md'
- Application Context: 'user-guide/application-context.md'
- Extension Library: 'user-guide/extension-library.md'
- Map Catalog: 'user-guide/map-catalog.md'
- Map Templates: 'user-guide/map-templates.md'
- Resources Properties: 'user-guide/resources-properties.md'
- Sharing Resources: 'user-guide/share.md'
- Exploring Maps:
- Overview: 'user-guide/exploring-maps.md'
- Table of Contents: 'user-guide/toc.md'
- Managing Layer Settings: 'user-guide/layer-settings.md'
- Filtering Layers: 'user-guide/filtering-layers.md'
- Attribute Table: 'user-guide/attributes-table.md'
- Widgets: 'user-guide/widgets.md'
- Export Layer Data: 'user-guide/export-data.md'
- MapStore Toolbars: 'user-guide/mapstore-toolbars.md'
- Printing a Map: 'user-guide/print.md'
- Importing and Exporting Files: 'user-guide/import.md'
- Catalog Services: 'user-guide/catalog.md'
- Performing Measurements: 'user-guide/measure.md'
- Annotations: 'user-guide/annotations.md'
- Map Views: 'user-guide/map-views.md'
- Street View: 'user-guide/street-view.md'
- Longitudinal Profile: 'user-guide/longitudinal-profile.md'
- GeoProcessing Tool: 'user-guide/geoprocessing-tool.md'
- Navigation Toolbar: 'user-guide/navigation-toolbar.md'
- Background Selector: 'user-guide/background.md'
- Timeline: 'user-guide/timeline.md'
- Footer: 'user-guide/footer.md'
- Exploring Dashboards:
- Overview: 'user-guide/exploring-dashboards.md'
- Adding widgets: 'user-guide/adding-widgets.md'
- Connecting widgets: 'user-guide/connecting-widgets.md'
- Exploring Stories:
- Overview: 'user-guide/exploring-stories.md'
- Story Settings: 'user-guide/story-setting.md'
- Title Section: 'user-guide/title-section.md'
- Banner Section: 'user-guide/banner-section.md'
- Paragraph Section: 'user-guide/paragraph-section.md'
- Immersive Section: 'user-guide/immersive-section.md'
- GeoCarousel Section: 'user-guide/geocarousel-section.md'
- Media Section: 'user-guide/media-section.md'
- Web Page section: 'user-guide/web-section.md'
- Text Editor Toolbar: 'user-guide/text-editor-toolbar.md'
- Image Toolbar: 'user-guide/content-image-toolbar.md'
- Video Toolbar: 'user-guide/content-video-toolbar.md'
- Map Toolbar: 'user-guide/content-map-toolbar.md'
- Web Page Toolbar: 'user-guide/content-web-toolbar.md'
- Media Editor: 'user-guide/media-editor-window.md'
- Configure the map: 'user-guide/configure-map.md'
- Developer Guide:
- Requirements: 'developer-guide/requirements.md'
- Quick Setup and Run: 'developer-guide/index.md'
- Main Scripts: 'developer-guide/main-scripts.md'
- Infrastructure: 'developer-guide/infrastructure-and-general-architecture.md'
- Developing with MapStore:
- Introduction: 'developer-guide/developing-with-mapstore-2-intro.md'
- Folders Structure: 'developer-guide/project-structure.md'
- Developing and Debugging: 'developer-guide/developing.md'
- Building and Deploying: 'developer-guide/building-and-deploying.md'
- Front End Technologies: 'developer-guide/reactjs-and-redux-introduction.md'
- Plugins architecture: 'developer-guide/plugins-architecture.md'
- Internationalization: 'developer-guide/internationalization.md'
- Custom dependencies: 'developer-guide/custom-dependencies.md'
- Styling and theming: 'developer-guide/customize-theme.md'
- Working with Extensions: 'developer-guide/extensions.md'
- Printing Module: 'developer-guide/printing-module.md'
- How to use CDN: 'developer-guide/how-to-use-a-cdn.md'
- FAQ: 'developer-guide/dev-faq.md'
- Guidelines:
- Code Conventions: 'developer-guide/code-conventions.md'
- Documentation: 'developer-guide/documentation-guidelines.md'
- Migration: 'developer-guide/mapstore-migration-guide.md'
- Release: 'developer-guide/release.md'
- How to:
- Dev How To: 'developer-guide/dev-how-to.md'
- Writing Plugins: 'developer-guide/plugins-howto.md'
- Writing Epics: 'developer-guide/writing-epics.md'
- Writing Actions and Reducers: 'developer-guide/writing-actions-reducers.md'
- Configuration:
- Configuration Files: 'developer-guide/configuration-files.md'
- Application Configuration: 'developer-guide/local-config.md'
- Configuring plugins: 'developer-guide/plugins-documentation.md'
- Map Configuration: 'developer-guide/maps-configuration.md'
- Externalize Configuration: 'developer-guide/externalized-configuration.md'
- Configuration of Application Context Manager: 'developer-guide/context-editor-config.md'
- Filters: 'developer-guide/LayerFilter.md'
- Styles: 'developer-guide/vector-style.md'
- Database Setup: 'developer-guide/database-setup.md'
- Integrations:
- Users:
- LDAP: 'developer-guide/integrations/users/ldap.md'
- OpenID Connect: 'developer-guide/integrations/users/openId.md'
- Keycloak: 'developer-guide/integrations/users/keycloak.md'
- Keycloak-SSO: 'developer-guide/integrations/users/keycloak-sso-impl.md'
- General:
- GeoServer: 'developer-guide/integrations/geoserver.md'
- Authentication: 'developer-guide/integrations/auth.md'
- Infrastructure: 'developer-guide/integrations/infrastructure-setups.md'
- Projects:
- MapStore Projects: 'developer-guide/mapstore-projects.md'
- Project Creation Script: 'developer-guide/project-creation-script.md'
- Advanced Project Customization: 'developer-guide/advanced-project-customization.md'
- Communicating with MapStore:
- API usage: 'developer-guide/API-usage.md'
- MapViewer query parameters: 'developer-guide/map-query-parameters.md'
plugins:
- search
# kroki is used to support mermaid charts in also in pdf.
# See https://kroki.io/.
- kroki: # https://pypi.org/project/mkdocs-kroki-plugin/
FencePrefix: ''
# HttpMethod set to POST pre-loads the images.
# USing GET the charts will be generated on the fly, so the rendering will be slower, but
# when not visualizing the charts, no request will be made to the kroki server.
HttpMethod: 'POST'
FileTypeOverrides:
mermaid: png
- with-pdf: # https://pypi.org/project/mkdocs-with-pdf/
author: GeoSolutionsGroup
copyright: 'MapStore©'
#
#cover: false
#back_cover: true
cover_logo: 'img/mapstore2-logo.png'
cover_title: MapStore Documentation
cover_subtitle: User Guide and Developer Guide
toc_level: 3
output_path: pdf/mapstore_documentation.pdf
enabled_if_env: ENABLE_PDF_EXPORT
debug_html: false # set to true to log the html content of the pdf on the console on build
show_anchors: true
verbose: false # set to true to log the pdf generation steps in detail
custom_template_path: 'docs/print_template' # includes custom styles.scss for pdf