Skip to content

Commit

Permalink
Migrate theme to slightly customized mkdocs material
Browse files Browse the repository at this point in the history
Besides working better, this should allow us to
support a multi-lingual site in the future.
  • Loading branch information
simonpoole committed Jan 26, 2025
1 parent fa1fc69 commit 3dc6799
Show file tree
Hide file tree
Showing 9 changed files with 144 additions and 9 deletions.
Binary file added documentation/docs/favicon.ico
Binary file not shown.
7 changes: 6 additions & 1 deletion documentation/docs/help/en/Privacy.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
hide:
- navigation
---

# Privacy statement

Vespucci is a collaboratively developed app for editing OpenStreetMap data via its editing API. The developers do not collect, store or otherwise process any personal data related to your usage of the app, you should however be aware of the following:
Expand All @@ -15,4 +20,4 @@ Vespucci is a collaboratively developed app for editing OpenStreetMap data via i
* Recording a GPX track, or starting location based auto-download, will lead to a service continuously updating your current position, including when you navigate away from the app for example by starting a different application. If GPX recording is enabled the location information will be stored on your device until you explicitly clear it or de-install the app. Such location access will stop if you either turn recording or auto-download off, or exit the app. No location information is made available to the Vespucci developers or other third parties. It is at your sole discretion how to use the recorded location data, for example if you upload it to OpenStreetMap or if you use it simply for private documentation. A notification is persistently displayed as long as the service is actively using location data.
* Background and overlay layers are generally operated by third parties over which we have no control. Links to their privacy policies are provided if available. A one time metadata retrieval call per session is required for use of the Bing orthoimagery layer, this happens in an asynchronous fashion when imagery is being configured regardless if you are using the Bing layer or not. You can disable this behaviour by removing the Bing key from the configuration, see the FAQs for more information.

If you have questions with respect to this document, please feel free to contact us at [email protected]
If you have questions with respect to this document, please feel free to contact us at [email protected]
9 changes: 5 additions & 4 deletions documentation/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
notoc: true
icon: "/vespucci_logo_small.png"
hide:
- navigation
- toc
---

# Welcome to Vespucci

[<img src="badge_google-play.png" style="margin-top:30px;" height="75" width="252" alt="Google Play">](https://play.google.com/store/apps/details?id=de.blau.android)
[<img src="badge_amazon-appstore.png" style="margin-top:30px;margin-left:20px;" height="75" width="256" alt="Amazon AppStore">](https://www.amazon.com/Simon-Poole-vespucci/dp/B00P71C3AW)
[<img src="badge_google-play.png" style="margin-top:30px;height: auto; width: 20%;min-width: 150px;max-width: 252px;max-height: 75px;" alt="Google Play">](https://play.google.com/store/apps/details?id=de.blau.android)
[<img src="badge_amazon-appstore.png" style="margin-top:30px;margin-left:20px;height: auto; width: 20%;min-width: 150px;max-width: 252px;max-height: 75px;" height="75" width="256" alt="Amazon AppStore">](https://www.amazon.com/Simon-Poole-vespucci/dp/B00P71C3AW)

<img src="180px-Amerigo_Vespucci.jpg" style="padding-left:20px;float:right">
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.
Expand Down
10 changes: 10 additions & 0 deletions documentation/docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
@@ -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);
}
5 changes: 5 additions & 0 deletions documentation/docs/tutorials/faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
hide:
- navigation
---


# Frequently Asked Questions

Expand Down
5 changes: 5 additions & 0 deletions documentation/docs/tutorials/screenshots.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
hide:
- navigation
---

# Videos

### Downloading and installing presets
Expand Down
36 changes: 32 additions & 4 deletions documentation/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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:[email protected]
extra_css:
- stylesheets/extra.css
exclude_docs: |
!.well-known
nav:
- Vespucci: 'index.md'
- Introduction:
- 'Introduction': 'help/en/Introduction.md'
- 'Features': 'tutorials/features.md'
Expand Down
16 changes: 16 additions & 0 deletions documentation/overrides/partials/copyright.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{#-
This file was automatically generated - do not edit
-#}
<div class="md-copyright">
{% if config.copyright %}
<div class="md-copyright__highlight">
{{ config.copyright }} {{ config.extra.project }} {{ config.extra.version }}
</div>
{% endif %}
{% if not config.extra.generator == false %}
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
{% endif %}
</div>
65 changes: 65 additions & 0 deletions documentation/overrides/partials/header.html
Original file line number Diff line number Diff line change
@@ -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 %}
<header class="{{ class }}" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="{{ lang.t('header') }}">
<a href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}" title="{{ config.site_name | e }}" class="md-header__button md-logo" aria-label="{{ config.site_name }}" data-md-component="logo">
{% include "partials/logo.html" %}
</a>
<label class="md-header__button md-icon" for="__drawer">
{% set icon = config.theme.icon.menu or "material/menu" %}
{% include ".icons/" ~ icon ~ ".svg" %}
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
{% if "navigation.tabs.sticky" in features %}
{% if "navigation.tabs" in features %}
{% include "partials/tabs.html" %}
{% endif %}
{% endif %}
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
{% if page.meta and page.meta.title %}
{{ page.meta.title }}
{% else %}
{{ page.title }}
{% endif %}
</span>
</div>
</div>
</div>
{% if config.theme.palette %}
{% if not config.theme.palette is mapping %}
{% include "partials/palette.html" %}
{% endif %}
{% endif %}
{% if not config.theme.palette is mapping %}
{% include "partials/javascripts/palette.html" %}
{% endif %}
{% if config.extra.alternate %}
{% include "partials/alternate.html" %}
{% endif %}
{% if "material/search" in config.plugins %}
<label class="md-header__button md-icon" for="__search">
{% set icon = config.theme.icon.search or "material/magnify" %}
{% include ".icons/" ~ icon ~ ".svg" %}
</label>
{% include "partials/search.html" %}
{% endif %}
{% if config.repo_url %}
<div class="md-header__source">
{% include "partials/source.html" %}
</div>
{% endif %}
</nav>
</header>

0 comments on commit 3dc6799

Please sign in to comment.