diff --git a/docs/docs/images/MapWPOverview.gif b/docs/docs/images/MapWPOverview.gif new file mode 100644 index 000000000..0f932730f Binary files /dev/null and b/docs/docs/images/MapWPOverview.gif differ diff --git a/docs/docs/index.md b/docs/docs/index.md new file mode 100644 index 000000000..6d34bb59f --- /dev/null +++ b/docs/docs/index.md @@ -0,0 +1,49 @@ +# SharePoint Interactive Map Webpart + +![GitHub release (latest by date)](https://img.shields.io/github/v/release/SPFxAppDev/sp-map-webpart) + +The "Interactive Map" wepart for Microsoft Teams/SharePoint is a solution, that contains one webpart. + +## Installation + +1. Download the latest SharePoint Framework packages **spfxappdev-webparts-map.sppkg** from the [GitHub repository](https://github.com/SPFxAppDev/sp-map-webpart/releases). +2. Add **spfxappdev-webparts-map.sppkg** to the global tenant app catalog or a site collection app catalog. If you don't have an app catalog, follow this [procedure](https://docs.microsoft.com/en-us/sharepoint/use-app-catalog) to create one. + +> * The packages are deployed in the general Office 365 CDN meaning **I do not host any code**. + + +> * For this package, you can choose to make the solution available in [all sites](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-scoped-deployment) or force to install an app to the site every time. + +3. If the solution was not installed globally (available in all sites), install the app in the site +4. Add the webpart to a SharePoint Page or Teams Tab + +![Preview](./images/MapWPOverview.gif) + +## Configuration + +work in process + +### How to add a new marker + +Documentation is still being prepared + +### How to change the marker position + +Documentation is still being prepared + +### How to manage marker categories + +Documentation is still being prepared + +### How to change the tile layer + +Documentation is still being prepared + +### How to change the tile layer + +Documentation is still being prepared + +### How to cluster the markers in groups + +Documentation is still being prepared + diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 000000000..b7d5e0f16 --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,47 @@ +site_name: 'SharePoint Interactive Map Webpart' +nav: + - Home: 'index.md' +theme: + name: material + palette: + - scheme: slate + primary: blue grey + toggle: + icon: material/weather-night + name: Switch to light mode + - scheme: default + toggle: + icon: material/weather-sunny + name: Switch to dark mode + logo: 'https://spfx-app.dev/_next/image?url=https%3A%2F%2Fcdn.hashnode.com%2Fres%2Fhashnode%2Fimage%2Fupload%2Fv1629447472494%2FdGmmXf-Id.png%3Fw%3D1000%26h%3D250%26fit%3Dcrop%26crop%3Dentropy%26auto%3Dcompress%2Cformat%26format%3Dwebp&w=1080&q=75' + features: + - toc.integrate + - navigation.tabs + - navigation.sections + - content.code.annotate +plugins: + - search +markdown_extensions: + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + - admonition + - tables + - codehilite: + guess_lang: false + - toc: + permalink: true +repo_url: https://github.com/SPFxAppDev/sp-map-webpart +extra: + version: + provider: mike + social: + - icon: fontawesome/brands/linkedin + link: https://www.linkedin.com/in/sergej-schwabauer-a26b5267/ + - icon: fontawesome/brands/github + link: https://github.com/SPFxAppDev + - icon: fontawesome/brands/hashnode + link: https://spfx-app.dev/ +copyright: Copyright © 2021 - 2022 Sergej Schwabauer diff --git a/docs/site/404.html b/docs/site/404.html new file mode 100644 index 000000000..99cc07470 --- /dev/null +++ b/docs/site/404.html @@ -0,0 +1,344 @@ + + + +
+ + + + + + + + + + + +\n {translation(\"search.result.term.missing\")}: {...missing}\n
\n }\n