Split users’ documentation to dedicated folder
This commit is contained in:
parent
4123714f76
commit
0a3bcad7ec
10 changed files with 28 additions and 20 deletions
4
docs-users/assets/logo.svg
Normal file
4
docs-users/assets/logo.svg
Normal file
|
@ -0,0 +1,4 @@
|
|||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128" width="128" height="128">
|
||||
<path d="M36.5 6.2A64 64 0 0 0 64 128C14.5 81.8 3.1 24.8 36.5 6.2zM64 128A64 64 0 0 0 91.5 6.2c33.4 18.6 22 75.6-27.5 121.8z" fill="#fff"/>
|
||||
<path d="M87.7 33.8a23.7 23.7 0 1 1-47.4 0 23.7 23.7 0 0 1 47.4 0z" fill="#fff"/>
|
||||
</svg>
|
After Width: | Height: | Size: 321 B |
13
docs-users/index.md
Normal file
13
docs-users/index.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
# uMap developer documentation
|
||||
|
||||
!!! info "Developer docs"
|
||||
|
||||
This documentation is intended for developers or system administrators.
|
||||
|
||||
If you are looking for user documentation, have a look at [the OSM wiki page](http://wiki.openstreetmap.org/wiki/UMap#Tutorials).
|
||||
|
||||
uMap lets you create maps with OpenStreetMap layers in a minute, and embed them in your site.
|
||||
|
||||
- 🤗 Get started and [follow the installation guide](install.md).
|
||||
- 🤩 Want to contribute? [Read the contributing guidelines](contributing.md).
|
||||
- 🤔 Curious about umap internals? [Check the architecture overview](dev/overview.md).
|
5
docs-users/requirements.txt
Normal file
5
docs-users/requirements.txt
Normal file
|
@ -0,0 +1,5 @@
|
|||
# Force rtfd to use a recent version of mkdocs
|
||||
mkdocs==1.5.3
|
||||
pymdown-extensions==10.7.1
|
||||
mkdocs-material==9.5.16
|
||||
mkdocs-static-i18n==1.2.2
|
6
docs-users/stylesheets/extra.css
Normal file
6
docs-users/stylesheets/extra.css
Normal file
|
@ -0,0 +1,6 @@
|
|||
:root {
|
||||
--md-primary-fg-color: #323e56;
|
||||
}
|
||||
.md-typeset a {
|
||||
color: #7990be !important;
|
||||
}
|
20
mkdocs.yml
20
mkdocs.yml
|
@ -19,9 +19,6 @@ nav:
|
|||
- Deployment:
|
||||
- Docker: deploy/docker.md
|
||||
- Nginx: deploy/nginx.md
|
||||
- Support:
|
||||
- FAQ: support/faq.md
|
||||
- Errors: support/errors.md
|
||||
- Changelog: changelog.md
|
||||
theme:
|
||||
name: material
|
||||
|
@ -62,20 +59,3 @@ markdown_extensions:
|
|||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
combine_header_slug: true
|
||||
- attr_list
|
||||
plugins:
|
||||
- i18n:
|
||||
docs_structure: folder
|
||||
languages:
|
||||
- locale: en
|
||||
default: true
|
||||
name: English
|
||||
build: true
|
||||
- locale: fr
|
||||
name: Français
|
||||
build: true
|
||||
site_name: Documentation uMap
|
||||
nav_translations:
|
||||
Home: Accueil
|
||||
Support: Aide
|
||||
Errors: Erreurs
|
||||
|
|
Loading…
Reference in a new issue