From 0a3bcad7ece5de5442dbb245042199182e01e9af Mon Sep 17 00:00:00 2001 From: David Larlet Date: Fri, 26 Apr 2024 18:12:09 -0400 Subject: [PATCH] =?UTF-8?q?Split=20users=E2=80=99=20documentation=20to=20d?= =?UTF-8?q?edicated=20folder?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs-users/assets/logo.svg | 4 ++++ {docs => docs-users}/fr/index.md | 0 {docs => docs-users}/fr/support/errors.md | 0 {docs => docs-users}/fr/support/faq.md | 0 docs-users/index.md | 13 +++++++++++++ docs-users/requirements.txt | 5 +++++ docs-users/stylesheets/extra.css | 6 ++++++ {docs => docs-users}/support/errors.md | 0 {docs => docs-users}/support/faq.md | 0 mkdocs.yml | 20 -------------------- 10 files changed, 28 insertions(+), 20 deletions(-) create mode 100644 docs-users/assets/logo.svg rename {docs => docs-users}/fr/index.md (100%) rename {docs => docs-users}/fr/support/errors.md (100%) rename {docs => docs-users}/fr/support/faq.md (100%) create mode 100644 docs-users/index.md create mode 100644 docs-users/requirements.txt create mode 100644 docs-users/stylesheets/extra.css rename {docs => docs-users}/support/errors.md (100%) rename {docs => docs-users}/support/faq.md (100%) diff --git a/docs-users/assets/logo.svg b/docs-users/assets/logo.svg new file mode 100644 index 00000000..fa32dc37 --- /dev/null +++ b/docs-users/assets/logo.svg @@ -0,0 +1,4 @@ + + + + diff --git a/docs/fr/index.md b/docs-users/fr/index.md similarity index 100% rename from docs/fr/index.md rename to docs-users/fr/index.md diff --git a/docs/fr/support/errors.md b/docs-users/fr/support/errors.md similarity index 100% rename from docs/fr/support/errors.md rename to docs-users/fr/support/errors.md diff --git a/docs/fr/support/faq.md b/docs-users/fr/support/faq.md similarity index 100% rename from docs/fr/support/faq.md rename to docs-users/fr/support/faq.md diff --git a/docs-users/index.md b/docs-users/index.md new file mode 100644 index 00000000..b1cbb2e0 --- /dev/null +++ b/docs-users/index.md @@ -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). diff --git a/docs-users/requirements.txt b/docs-users/requirements.txt new file mode 100644 index 00000000..579cd976 --- /dev/null +++ b/docs-users/requirements.txt @@ -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 diff --git a/docs-users/stylesheets/extra.css b/docs-users/stylesheets/extra.css new file mode 100644 index 00000000..ded19ade --- /dev/null +++ b/docs-users/stylesheets/extra.css @@ -0,0 +1,6 @@ +:root { + --md-primary-fg-color: #323e56; +} +.md-typeset a { + color: #7990be !important; +} \ No newline at end of file diff --git a/docs/support/errors.md b/docs-users/support/errors.md similarity index 100% rename from docs/support/errors.md rename to docs-users/support/errors.md diff --git a/docs/support/faq.md b/docs-users/support/faq.md similarity index 100% rename from docs/support/faq.md rename to docs-users/support/faq.md diff --git a/mkdocs.yml b/mkdocs.yml index 4de298c6..032e0449 100644 --- a/mkdocs.yml +++ b/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