diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index b08fcc43..2e0725bd 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -7,11 +7,9 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - # need Node 16 or less to get rid of ERR_OSSL_EVP_UNSUPPORTED - uses: actions/setup-node@v3 with: - node-version: 16 + node-version: 20 - name: Generate dist run: | @@ -33,12 +31,10 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - # need Node 16 or less to get rid of ERR_OSSL_EVP_UNSUPPORTED - uses: actions/setup-node@v3 with: - node-version: 16 - + node-version: 20 + cache: 'yarn' - name: Generate dist run: | yarn install diff --git a/.github/workflows/dist-dev.yml b/.github/workflows/dist-dev.yml index 48ee6c18..8e31258e 100644 --- a/.github/workflows/dist-dev.yml +++ b/.github/workflows/dist-dev.yml @@ -19,18 +19,20 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - # need Node 16 or less to get rid of ERR_OSSL_EVP_UNSUPPORTED - uses: actions/setup-node@v3 with: - node-version: 16 + node-version: 20 + cache: 'yarn' - name: Install run: | yarn install - name: Generate dist + env: + SMARTLOOK_KEY: ${{ secrets.SMARTLOOK_KEY }} run: | + echo "VITE_SMARTLOOK_KEY=$SMARTLOOK_KEY" > ./src/.env yarn build - name: "Check dist dir consistency" diff --git a/.github/workflows/dist-prod.yml b/.github/workflows/dist-prod.yml index 9450b0a9..cec1ace8 100644 --- a/.github/workflows/dist-prod.yml +++ b/.github/workflows/dist-prod.yml @@ -15,18 +15,20 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - # need Node 16 or less to get rid of ERR_OSSL_EVP_UNSUPPORTED - uses: actions/setup-node@v3 with: - node-version: 16 + node-version: 20 + cache: 'yarn' - name: Install run: | yarn install - name: Generate dist + env: + SMARTLOOK_KEY: ${{ secrets.SMARTLOOK_KEY }} run: | + echo "VITE_SMARTLOOK_KEY=$SMARTLOOK_KEY" > ./src/.env yarn build - name: "Check dist dir consistency" diff --git a/.gitignore b/.gitignore index 0e117423..5cc088de 100644 --- a/.gitignore +++ b/.gitignore @@ -18,4 +18,7 @@ git-output.txt .node-version .vscode *-snippet.txt -redirect_test.txt \ No newline at end of file +redirect_test.txt + +src/.vitepress/cache +src/.vitepress/dist \ No newline at end of file diff --git a/README.md b/README.md index 6e5f35c1..a89f22cb 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,8 @@ You can also spin-up a node Docker container using the provided compose file docker compose up mm-docs ``` +The minimum required version of Node.js is 18. + ## Translations At the moment we do not support translations, see https://github.com/MerginMaps/docs/issues/133 @@ -65,20 +67,6 @@ yarn build and see the result in `dist` folder -### Error for nodejs 17 - -If you get `opensslErrorStack: [ 'error:03000086:digital envelope routines::initialization error' ]`, run - ```bash - export NODE_OPTIONS=--openssl-legacy-provider - ``` - - or on Windows - ```bash - set NODE_OPTIONS=--openssl-legacy-provider - ``` - - or downgrade `nodejs` to 16 or less. More here: https://github.com/webpack/webpack/issues/14532 - # License The Mergin Maps product documentation in the `src` are licensed under a [CC-BY license](LICENSE). diff --git a/docker-compose.yml b/docker-compose.yml index b6b18047..ee2c7da5 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,7 +1,7 @@ services: mm-docs: - image: node:16-alpine + image: node:20-alpine restart: on-failure volumes: - .:/docs diff --git a/package.json b/package.json index 1b0dabe8..510afb4d 100755 --- a/package.json +++ b/package.json @@ -10,20 +10,18 @@ }, "repository": "merginmaps/docs", "scripts": { - "dev": "vuepress dev src", - "build": "vuepress build src", - "export": "vuepress export src" + "dev": "vitepress dev src", + "build": "vitepress build src", + "preview": "vitepress preview src" }, "devDependencies": { - "@vuepress/plugin-medium-zoom": "^1.9.8", - "sass": "^1.62.1", - "sass-loader": "10", - "vuepress": "^1.9.8", - "vuepress-plugin-clean-urls": "^1.1.2", - "vuepress-plugin-fulltext-search": "^2.2.1" + "sass": "^1.86.0", + "vitepress": "^1.6.3", + "vitepress-plugin-image-viewer": "^1.1.6", + "vue": "^3.5.13" }, "dependencies": { - "@gtm-support/vue2-gtm": "1.0.0", + "@gtm-support/vue-gtm": "^3.1.0", "smartlook-client": "^10.0.0" } } diff --git a/scripts/check-redirects/main.py b/scripts/check-redirects/main.py index c2fafcb0..f20ceff4 100644 --- a/scripts/check-redirects/main.py +++ b/scripts/check-redirects/main.py @@ -44,8 +44,9 @@ def slashify(url): return path page_extension = '.md' -iamge_extensions = ['.jpg', '.png', '.gif', '.xcf'] +iamge_extensions = ['.jpg', '.png', '.gif', '.xcf', '.svg', '.ico'] data_extensions = ['.json', '.zip'] +vue_extensions = ['.vue', '.js', '.ts'] deleted_pages = [] renamed_pages_or_data_files = [] @@ -63,7 +64,7 @@ def slashify(url): deleted_pages.append(line_parts[1].strip()) elif status[0] == 'R': old_filename, file_extension = os.path.splitext(line_parts[1]) - if file_extension.strip() not in iamge_extensions: + if file_extension.strip() not in iamge_extensions + vue_extensions + data_extensions: renamed_pages_or_data_files.append( (line_parts[1].strip(),line_parts[2].strip()) ) if file_extension not in captured_exts: captured_exts.append(file_extension) diff --git a/src/.env b/src/.env new file mode 100644 index 00000000..cdbef54a --- /dev/null +++ b/src/.env @@ -0,0 +1 @@ +VITE_SMARTLOOK_KEY='' \ No newline at end of file diff --git a/src/.vuepress/components/AppDomainNameLink.vue b/src/.vitepress/components/AppDomainNameLink.vue similarity index 100% rename from src/.vuepress/components/AppDomainNameLink.vue rename to src/.vitepress/components/AppDomainNameLink.vue diff --git a/src/.vuepress/components/AppDownload.vue b/src/.vitepress/components/AppDownload.vue similarity index 74% rename from src/.vuepress/components/AppDownload.vue rename to src/.vitepress/components/AppDownload.vue index 2cc352f1..5cd72724 100644 --- a/src/.vuepress/components/AppDownload.vue +++ b/src/.vitepress/components/AppDownload.vue @@ -1,21 +1,28 @@ + diff --git a/src/.vuepress/components/DashboardLink.vue b/src/.vitepress/components/DashboardLink.vue similarity index 100% rename from src/.vuepress/components/DashboardLink.vue rename to src/.vitepress/components/DashboardLink.vue diff --git a/src/.vuepress/components/DashboardShortLink.vue b/src/.vitepress/components/DashboardShortLink.vue similarity index 100% rename from src/.vuepress/components/DashboardShortLink.vue rename to src/.vitepress/components/DashboardShortLink.vue diff --git a/src/.vuepress/components/DockerHubLink.vue b/src/.vitepress/components/DockerHubLink.vue similarity index 100% rename from src/.vuepress/components/DockerHubLink.vue rename to src/.vitepress/components/DockerHubLink.vue diff --git a/src/.vuepress/components/EnterprisePlatformName.vue b/src/.vitepress/components/EnterprisePlatformName.vue similarity index 100% rename from src/.vuepress/components/EnterprisePlatformName.vue rename to src/.vitepress/components/EnterprisePlatformName.vue diff --git a/src/.vuepress/components/EnterprisePlatformNameLink.vue b/src/.vitepress/components/EnterprisePlatformNameLink.vue similarity index 100% rename from src/.vuepress/components/EnterprisePlatformNameLink.vue rename to src/.vitepress/components/EnterprisePlatformNameLink.vue diff --git a/src/.vuepress/components/GitHubRepo.vue b/src/.vitepress/components/GitHubRepo.vue similarity index 94% rename from src/.vuepress/components/GitHubRepo.vue rename to src/.vitepress/components/GitHubRepo.vue index 7bd6cbab..86f6f61b 100644 --- a/src/.vuepress/components/GitHubRepo.vue +++ b/src/.vitepress/components/GitHubRepo.vue @@ -9,7 +9,6 @@ - (opens new window) diff --git a/src/.vuepress/components/LutraConsultingName.vue b/src/.vitepress/components/LutraConsultingName.vue similarity index 100% rename from src/.vuepress/components/LutraConsultingName.vue rename to src/.vitepress/components/LutraConsultingName.vue diff --git a/src/.vuepress/components/LutraConsultingWeb.vue b/src/.vitepress/components/LutraConsultingWeb.vue similarity index 100% rename from src/.vuepress/components/LutraConsultingWeb.vue rename to src/.vitepress/components/LutraConsultingWeb.vue diff --git a/src/.vuepress/components/MainDomainName.vue b/src/.vitepress/components/MainDomainName.vue similarity index 100% rename from src/.vuepress/components/MainDomainName.vue rename to src/.vitepress/components/MainDomainName.vue diff --git a/src/.vuepress/components/MainDomainNameLink.vue b/src/.vitepress/components/MainDomainNameLink.vue similarity index 100% rename from src/.vuepress/components/MainDomainNameLink.vue rename to src/.vitepress/components/MainDomainNameLink.vue diff --git a/src/.vuepress/components/MainPlatformName.vue b/src/.vitepress/components/MainPlatformName.vue similarity index 100% rename from src/.vuepress/components/MainPlatformName.vue rename to src/.vitepress/components/MainPlatformName.vue diff --git a/src/.vuepress/components/MainPlatformNameLink.vue b/src/.vitepress/components/MainPlatformNameLink.vue similarity index 100% rename from src/.vuepress/components/MainPlatformNameLink.vue rename to src/.vitepress/components/MainPlatformNameLink.vue diff --git a/src/.vuepress/components/MerginMapsEmail.vue b/src/.vitepress/components/MerginMapsEmail.vue similarity index 100% rename from src/.vuepress/components/MerginMapsEmail.vue rename to src/.vitepress/components/MerginMapsEmail.vue diff --git a/src/.vuepress/components/MerginMapsProject.vue b/src/.vitepress/components/MerginMapsProject.vue similarity index 66% rename from src/.vuepress/components/MerginMapsProject.vue rename to src/.vitepress/components/MerginMapsProject.vue index 115d667d..d93fcd17 100644 --- a/src/.vuepress/components/MerginMapsProject.vue +++ b/src/.vitepress/components/MerginMapsProject.vue @@ -1,26 +1,21 @@ - diff --git a/src/.vuepress/components/MobileAppName.vue b/src/.vitepress/components/MobileAppName.vue similarity index 100% rename from src/.vuepress/components/MobileAppName.vue rename to src/.vitepress/components/MobileAppName.vue diff --git a/src/.vuepress/components/MobileAppNameShort.vue b/src/.vitepress/components/MobileAppNameShort.vue similarity index 100% rename from src/.vuepress/components/MobileAppNameShort.vue rename to src/.vitepress/components/MobileAppNameShort.vue diff --git a/src/.vuepress/components/NoSpellcheck.vue b/src/.vitepress/components/NoSpellcheck.vue similarity index 100% rename from src/.vuepress/components/NoSpellcheck.vue rename to src/.vitepress/components/NoSpellcheck.vue diff --git a/src/.vuepress/components/PublicAsset.vue b/src/.vitepress/components/PublicAsset.vue similarity index 56% rename from src/.vuepress/components/PublicAsset.vue rename to src/.vitepress/components/PublicAsset.vue index cf634871..9e21d24b 100644 --- a/src/.vuepress/components/PublicAsset.vue +++ b/src/.vitepress/components/PublicAsset.vue @@ -1,8 +1,10 @@ + + \ No newline at end of file diff --git a/src/.vuepress/components/QGISHelp.vue b/src/.vitepress/components/QGIS.vue similarity index 65% rename from src/.vuepress/components/QGISHelp.vue rename to src/.vitepress/components/QGIS.vue index 1948988a..e94403b5 100644 --- a/src/.vuepress/components/QGISHelp.vue +++ b/src/.vitepress/components/QGIS.vue @@ -1,33 +1,32 @@ - \ No newline at end of file + diff --git a/src/.vuepress/components/QGIS.vue b/src/.vitepress/components/QGISHelp.vue similarity index 67% rename from src/.vuepress/components/QGIS.vue rename to src/.vitepress/components/QGISHelp.vue index 92931474..88f59084 100644 --- a/src/.vuepress/components/QGIS.vue +++ b/src/.vitepress/components/QGISHelp.vue @@ -1,28 +1,26 @@ - + \ No newline at end of file diff --git a/src/.vuepress/components/QGISPluginName.vue b/src/.vitepress/components/QGISPluginName.vue similarity index 100% rename from src/.vuepress/components/QGISPluginName.vue rename to src/.vitepress/components/QGISPluginName.vue diff --git a/src/.vuepress/components/QGISPluginNameShort.vue b/src/.vitepress/components/QGISPluginNameShort.vue similarity index 100% rename from src/.vuepress/components/QGISPluginNameShort.vue rename to src/.vitepress/components/QGISPluginNameShort.vue diff --git a/src/.vitepress/components/ServerType.vue b/src/.vitepress/components/ServerType.vue new file mode 100644 index 00000000..37a872c8 --- /dev/null +++ b/src/.vitepress/components/ServerType.vue @@ -0,0 +1,37 @@ + + + + + + + diff --git a/src/.vuepress/components/SinceBadge.vue b/src/.vitepress/components/SinceBadge.vue similarity index 63% rename from src/.vuepress/components/SinceBadge.vue rename to src/.vitepress/components/SinceBadge.vue index 254be338..33e84586 100644 --- a/src/.vuepress/components/SinceBadge.vue +++ b/src/.vitepress/components/SinceBadge.vue @@ -17,16 +17,16 @@ export default { } - diff --git a/src/.vuepress/components/WishListLink.vue b/src/.vitepress/components/WishListLink.vue similarity index 100% rename from src/.vuepress/components/WishListLink.vue rename to src/.vitepress/components/WishListLink.vue diff --git a/src/.vuepress/components/YouTube.vue b/src/.vitepress/components/YouTube.vue similarity index 85% rename from src/.vuepress/components/YouTube.vue rename to src/.vitepress/components/YouTube.vue index e205c251..2cabb5e2 100644 --- a/src/.vuepress/components/YouTube.vue +++ b/src/.vitepress/components/YouTube.vue @@ -6,13 +6,13 @@ - diff --git a/src/.vuepress/components/cookie-consent/components/CookieConsentPreferences.vue b/src/.vitepress/components/cookie-consent/components/CookieConsentPreferences.vue similarity index 81% rename from src/.vuepress/components/cookie-consent/components/CookieConsentPreferences.vue rename to src/.vitepress/components/cookie-consent/components/CookieConsentPreferences.vue index a20b0baf..1998461f 100644 --- a/src/.vuepress/components/cookie-consent/components/CookieConsentPreferences.vue +++ b/src/.vitepress/components/cookie-consent/components/CookieConsentPreferences.vue @@ -3,7 +3,7 @@