feat: Refresh docs (#416)

* WIP, switch to mkdocs * chore: upgrade node * WIP: add example stubs * doc: add arg type docs * docs: finish first example in ts * fix: example layout * docs: add font awesome for icons on control btns * docs: import wmts example * fix: ts type warnings * docs: reimport list storage * feat: just examples is enough * docs: add doc howto start examples * chore: switch to main branch
allartk · Nov 28, 2024 · 554c867 · 554c867
1 parent 18242ec
commit 554c867
Show file tree

Hide file tree

Showing 71 changed files with 3,432 additions and 17,644 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -4,12 +4,12 @@ updates:
     directory: '/'
     schedule:
       interval: 'monthly'
-    target-branch: 'master'
+    target-branch: 'main'
     versioning-strategy: increase-if-necessary
     allow:
       # Allow both direct and indirect updates for all packages
       - dependency-type: "direct"
     commit-message:
       prefix: fix
       prefix-development: chore
-      include: scope      
+      include: scope
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -3,8 +3,7 @@ on:
   pull_request: ~
   push:
     branches:
-      - develop
-      - master
+      - main
 jobs:
   run:
     runs-on: ubuntu-latest
@@ -15,7 +14,7 @@ jobs:
       - name: Set up Node
         uses: actions/setup-node@v2
         with:
-          node-version: 18
+          node-version: 20
           check-latest: true
 
       - name: Cache dependencies

diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-lts/hydrogen
+lts/iron
diff --git a/README.md b/README.md
@@ -6,8 +6,7 @@
 
 This library can be used to create maps, which are still available when you are offline and are fast when your connection is not. It works in the browser or can be used in an mobile app based on html and in progressive webapps.
 
-- [examples](http://allartk.github.io/leaflet.offline/)
-- [api docs](docs/api.md)
+- [examples](https://github.com/allartk/leaflet.offline/tree/main/examples)
 
 ## Dependencies
 
@@ -48,7 +47,7 @@ npm install && npm run start
 
 **pull requests welcome**
 
-* You MUST test your code with `npm test` and  `npm run lint`. 
+* You MUST test your code with `npm test` and  `npm run lint`.
 * Please one feature at a time, if you can split your PR, please do so.
 * Also, do not mix a feature with package updates.
 * [Use commit message conventions](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#rules)

diff --git a/docs/.eslintrc.js b/docs/.eslintrc.js
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/_config.dev.yml b/docs/_config.dev.yml
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/_includes/head.html b/docs/_includes/head.html
diff --git a/docs/_includes/navbar.html b/docs/_includes/navbar.html
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
diff --git a/docs/_layouts/iife.html b/docs/_layouts/iife.html
diff --git a/docs/_sass/_main.scss b/docs/_sass/_main.scss