From ad7ff5ddba00233e694d1071dd51115b815d9d40 Mon Sep 17 00:00:00 2001 From: vcoppe Date: Mon, 8 Jul 2024 22:43:50 +0200 Subject: [PATCH] user guide structure draft --- .../src/lib/assets/img/{ => home}/cyclosm.png | Bin website/src/lib/assets/img/{ => home}/ign.png | Bin website/src/lib/assets/img/{ => home}/map.png | Bin .../assets/img/{ => home}/mapbox-outdoors.png | Bin .../img/{ => home}/mapbox-satellite.png | Bin .../src/lib/assets/img/{ => home}/routing.png | Bin .../lib/assets/img/{ => home}/waymarked.png | Bin website/src/lib/components/Footer.svelte | 4 +- website/src/lib/components/Menu.svelte | 2 +- website/src/lib/components/Nav.svelte | 8 ++-- website/src/lib/components/docs/Docs.svelte | 11 ------ .../src/lib/components/docs/DocsLoader.svelte | 21 +++++++--- website/src/lib/docs/en/getting-started.svx | 11 ++++++ website/src/lib/docs/en/introduction/test.md | 5 --- website/src/lib/docs/en/map-controls.svx | 5 +++ website/src/lib/docs/en/menu.svx | 6 +++ website/src/lib/docs/en/menu/edit.svx | 5 +++ website/src/lib/docs/en/menu/file.svx | 5 +++ website/src/lib/docs/en/menu/settings.svx | 5 +++ website/src/lib/docs/en/menu/view.svx | 5 +++ website/src/lib/docs/en/toolbar.svx | 6 +++ website/src/lib/docs/en/toolbar/clean.svx | 5 +++ website/src/lib/docs/en/toolbar/extract.svx | 5 +++ website/src/lib/docs/en/toolbar/merge.svx | 5 +++ website/src/lib/docs/en/toolbar/poi.svx | 5 +++ website/src/lib/docs/en/toolbar/reduce.svx | 5 +++ website/src/lib/docs/en/toolbar/routing.svx | 5 +++ website/src/lib/docs/en/toolbar/scissors.svx | 5 +++ website/src/lib/docs/en/toolbar/time.svx | 5 +++ website/src/lib/sitemap.ts | 5 ++- website/src/locales/en.json | 3 +- website/src/routes/[...language]/+page.svelte | 18 ++++----- .../[...language]/documentation/+page.svelte | 5 --- .../routes/[...language]/help/+layout.svelte | 37 ++++++++++++++++++ .../routes/[...language]/help/+page.svelte | 4 ++ .../help/[...guide]/+page.svelte | 6 +++ 36 files changed, 171 insertions(+), 46 deletions(-) rename website/src/lib/assets/img/{ => home}/cyclosm.png (100%) rename website/src/lib/assets/img/{ => home}/ign.png (100%) rename website/src/lib/assets/img/{ => home}/map.png (100%) rename website/src/lib/assets/img/{ => home}/mapbox-outdoors.png (100%) rename website/src/lib/assets/img/{ => home}/mapbox-satellite.png (100%) rename website/src/lib/assets/img/{ => home}/routing.png (100%) rename website/src/lib/assets/img/{ => home}/waymarked.png (100%) delete mode 100644 website/src/lib/components/docs/Docs.svelte create mode 100644 website/src/lib/docs/en/getting-started.svx delete mode 100644 website/src/lib/docs/en/introduction/test.md create mode 100644 website/src/lib/docs/en/map-controls.svx create mode 100644 website/src/lib/docs/en/menu.svx create mode 100644 website/src/lib/docs/en/menu/edit.svx create mode 100644 website/src/lib/docs/en/menu/file.svx create mode 100644 website/src/lib/docs/en/menu/settings.svx create mode 100644 website/src/lib/docs/en/menu/view.svx create mode 100644 website/src/lib/docs/en/toolbar.svx create mode 100644 website/src/lib/docs/en/toolbar/clean.svx create mode 100644 website/src/lib/docs/en/toolbar/extract.svx create mode 100644 website/src/lib/docs/en/toolbar/merge.svx create mode 100644 website/src/lib/docs/en/toolbar/poi.svx create mode 100644 website/src/lib/docs/en/toolbar/reduce.svx create mode 100644 website/src/lib/docs/en/toolbar/routing.svx create mode 100644 website/src/lib/docs/en/toolbar/scissors.svx create mode 100644 website/src/lib/docs/en/toolbar/time.svx delete mode 100644 website/src/routes/[...language]/documentation/+page.svelte create mode 100644 website/src/routes/[...language]/help/+layout.svelte create mode 100644 website/src/routes/[...language]/help/+page.svelte create mode 100644 website/src/routes/[...language]/help/[...guide]/+page.svelte diff --git a/website/src/lib/assets/img/cyclosm.png b/website/src/lib/assets/img/home/cyclosm.png similarity index 100% rename from website/src/lib/assets/img/cyclosm.png rename to website/src/lib/assets/img/home/cyclosm.png diff --git a/website/src/lib/assets/img/ign.png b/website/src/lib/assets/img/home/ign.png similarity index 100% rename from website/src/lib/assets/img/ign.png rename to website/src/lib/assets/img/home/ign.png diff --git a/website/src/lib/assets/img/map.png b/website/src/lib/assets/img/home/map.png similarity index 100% rename from website/src/lib/assets/img/map.png rename to website/src/lib/assets/img/home/map.png diff --git a/website/src/lib/assets/img/mapbox-outdoors.png b/website/src/lib/assets/img/home/mapbox-outdoors.png similarity index 100% rename from website/src/lib/assets/img/mapbox-outdoors.png rename to website/src/lib/assets/img/home/mapbox-outdoors.png diff --git a/website/src/lib/assets/img/mapbox-satellite.png b/website/src/lib/assets/img/home/mapbox-satellite.png similarity index 100% rename from website/src/lib/assets/img/mapbox-satellite.png rename to website/src/lib/assets/img/home/mapbox-satellite.png diff --git a/website/src/lib/assets/img/routing.png b/website/src/lib/assets/img/home/routing.png similarity index 100% rename from website/src/lib/assets/img/routing.png rename to website/src/lib/assets/img/home/routing.png diff --git a/website/src/lib/assets/img/waymarked.png b/website/src/lib/assets/img/home/waymarked.png similarity index 100% rename from website/src/lib/assets/img/waymarked.png rename to website/src/lib/assets/img/home/waymarked.png diff --git a/website/src/lib/components/Footer.svelte b/website/src/lib/components/Footer.svelte index d41c806d..9dbf0c87 100644 --- a/website/src/lib/components/Footer.svelte +++ b/website/src/lib/components/Footer.svelte @@ -44,10 +44,10 @@
diff --git a/website/src/lib/components/Menu.svelte b/website/src/lib/components/Menu.svelte index ab010043..fb64a2b4 100644 --- a/website/src/lib/components/Menu.svelte +++ b/website/src/lib/components/Menu.svelte @@ -417,7 +417,7 @@
diff --git a/website/src/lib/components/docs/Docs.svelte b/website/src/lib/components/docs/Docs.svelte deleted file mode 100644 index 044b32d5..00000000 --- a/website/src/lib/components/docs/Docs.svelte +++ /dev/null @@ -1,11 +0,0 @@ - - -{metadata.title} - - diff --git a/website/src/lib/components/docs/DocsLoader.svelte b/website/src/lib/components/docs/DocsLoader.svelte index 8eaeee44..2362aff7 100644 --- a/website/src/lib/components/docs/DocsLoader.svelte +++ b/website/src/lib/components/docs/DocsLoader.svelte @@ -2,22 +2,33 @@ import { _, locale } from 'svelte-i18n'; export let path: string; + export let titleOnly: boolean = false; let module = undefined; + let metadata: Record = {}; const modules = import.meta.glob('/src/lib/docs/**/*.{md,svx}'); - $: if ($locale) { - modules[`/src/lib/docs/${$locale}/${path}`]().then((mod) => { + function loadModule(path: string) { + modules[path]().then((mod) => { module = mod.default; + metadata = mod.metadata; }); } + + $: if ($locale) { + loadModule(`/src/lib/docs/${$locale}/${path}`); + } {#if module !== undefined} -
- -
+ {#if titleOnly} + {metadata.title} + {:else} +
+ +
+ {/if} {/if}