From 3dc67994ec7bb5d1fdd3c6d990f46dc480fa9a96 Mon Sep 17 00:00:00 2001 From: Simon Poole Date: Sun, 26 Jan 2025 09:14:40 +0000 Subject: [PATCH] Migrate theme to slightly customized mkdocs material Besides working better, this should allow us to support a multi-lingual site in the future. --- documentation/docs/favicon.ico | Bin 0 -> 1150 bytes documentation/docs/help/en/Privacy.md | 7 +- documentation/docs/index.md | 9 +-- documentation/docs/stylesheets/extra.css | 10 +++ documentation/docs/tutorials/faq.md | 5 ++ documentation/docs/tutorials/screenshots.md | 5 ++ documentation/mkdocs.yml | 36 ++++++++-- .../overrides/partials/copyright.html | 16 +++++ documentation/overrides/partials/header.html | 65 ++++++++++++++++++ 9 files changed, 144 insertions(+), 9 deletions(-) create mode 100644 documentation/docs/favicon.ico create mode 100644 documentation/docs/stylesheets/extra.css create mode 100644 documentation/overrides/partials/copyright.html create mode 100644 documentation/overrides/partials/header.html diff --git a/documentation/docs/favicon.ico b/documentation/docs/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..0d7463e113cfce4b184075fac0431d00a1df3a6c GIT binary patch literal 1150 zcmbVM+fEZv6g?)!XP$ia(NFUyOcVqo-eQ6p1tV&RMq{)V5V2qtp%p=)seqW7Y0|6La?3hlLQh^t z<{K^yr`LtA62t9-m7zY!Z?kM_4%1OL z<`N!sC4-n~FrVGge(8f6yhwe;xSS_yj@RQ2j](https://play.google.com/store/apps/details?id=de.blau.android) -[Amazon AppStore](https://www.amazon.com/Simon-Poole-vespucci/dp/B00P71C3AW) +[Google Play](https://play.google.com/store/apps/details?id=de.blau.android) +[Amazon AppStore](https://www.amazon.com/Simon-Poole-vespucci/dp/B00P71C3AW) Vespucci is the first [OpenStreetMap](//openstreetmap.org) editor for Android, continuously improved and developed since 2009. It supports the full OpenStreetMap data model including lots of less known quirks and can be used, if necessary, completely offline. diff --git a/documentation/docs/stylesheets/extra.css b/documentation/docs/stylesheets/extra.css new file mode 100644 index 0000000000..a9c7ca3898 --- /dev/null +++ b/documentation/docs/stylesheets/extra.css @@ -0,0 +1,10 @@ +:root > * { + --md-typeset-a-color: var(--md-primary-fg-color); + +// Footer color shades + --md-footer-fg-color: hsla(0, 0%, 100%, 1); + --md-footer-fg-color--light: hsla(0, 0%, 100%, 0.7); + --md-footer-fg-color--lighter: hsla(0, 0%, 100%, 0.45); + --md-footer-bg-color: hsla(0, 0%, 0%, 0.67); + --md-footer-bg-color--dark: hsla(0, 0%, 0%, 0.32); +} diff --git a/documentation/docs/tutorials/faq.md b/documentation/docs/tutorials/faq.md index 829d931de9..43f3ff6d91 100644 --- a/documentation/docs/tutorials/faq.md +++ b/documentation/docs/tutorials/faq.md @@ -1,3 +1,8 @@ +--- +hide: + - navigation +--- + # Frequently Asked Questions diff --git a/documentation/docs/tutorials/screenshots.md b/documentation/docs/tutorials/screenshots.md index e74741229b..99f2308431 100644 --- a/documentation/docs/tutorials/screenshots.md +++ b/documentation/docs/tutorials/screenshots.md @@ -1,3 +1,8 @@ +--- +hide: + - navigation +--- + # Videos ### Downloading and installing presets diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml index add226ab9b..8be785a660 100644 --- a/documentation/mkdocs.yml +++ b/documentation/mkdocs.yml @@ -1,22 +1,50 @@ site_name: Vespucci site_dir: /var/www/site +site_url: http://172.16.2.51/ site_description: 'Main site for Vespucci the Android OpenStreetMap Editor' theme: - name: flatly - custom_dir: flatly-custom + name: material favicon: favicon.ico + logo: vespucci_logo_small.png + custom_dir: overrides + palette: + primary: blue grey + accent: deep orange + features: + - navigation.tracking + - navigation.tabs + - navigation.tabs.sticky + markdown_extensions: - pymdownx.tilde - toc: permalink: "#" toc_depth: 4 +copyright: 'Generated for' extra: - version: 20.2.0 + version: 20.2 project: Vespucci + # alternate: + #- name: English + # link: /help/en/ + # lang: en + #- name: Deutsch + # link: /help/de/ + # lang: de + social: + - icon: fontawesome/brands/mastodon + link: https://en.osm.town/@vespucci_editor + name: 'Vespucci on Mastodon' + - icon: fontawesome/brands/github + link: https://github.com/MarcusWolschon/osmeditor4android/ + name: 'Vespucci on Github' + - icon: fontawesome/solid/paper-plane + link: mailto:info@vespucci.io +extra_css: + - stylesheets/extra.css exclude_docs: | !.well-known nav: -- Vespucci: 'index.md' - Introduction: - 'Introduction': 'help/en/Introduction.md' - 'Features': 'tutorials/features.md' diff --git a/documentation/overrides/partials/copyright.html b/documentation/overrides/partials/copyright.html new file mode 100644 index 0000000000..43fc8c5d39 --- /dev/null +++ b/documentation/overrides/partials/copyright.html @@ -0,0 +1,16 @@ +{#- + This file was automatically generated - do not edit +-#} +
+ {% if config.copyright %} +
+ {{ config.copyright }} {{ config.extra.project }} {{ config.extra.version }} +
+ {% endif %} + {% if not config.extra.generator == false %} + Made with + + Material for MkDocs + + {% endif %} +
diff --git a/documentation/overrides/partials/header.html b/documentation/overrides/partials/header.html new file mode 100644 index 0000000000..0e6180f4e5 --- /dev/null +++ b/documentation/overrides/partials/header.html @@ -0,0 +1,65 @@ +{#- + This file was automatically generated - do not edit +-#} +{% set class = "md-header" %} +{% if "navigation.tabs.sticky" in features %} + {% set class = class ~ " md-header--shadow md-header--lifted" %} +{% elif "navigation.tabs" not in features %} + {% set class = class ~ " md-header--shadow" %} +{% endif %} +
+ +