feat: doc add pwa

Author: Undertone0809

.gitignore

@@ -1,4 +1,4 @@
-cache/
+docs/.vitepress/cache/
 
 # Created by https://www.gitignore.io/api/osx,python,pycharm,windows,visualstudio,visualstudiocode
 # Edit at https://www.gitignore.io/?templates=osx,python,pycharm,windows,visualstudio,visualstudiocode

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "p3g"
-version = "1.5.4"
+version = "1.5.5"
 description = "Python Packages Project Generator"
 readme = "README.md"
 authors = ["Zeeland <zeeland4work@gmail.com>"]

{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/.gitignore

@@ -1,3 +1,4 @@
+docs/.vitepress/cache/
 node_modules/
 
 # Created by https://www.gitignore.io/api/osx,python,pycharm,windows,visualstudio,visualstudiocode

{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/docs/.vitepress/config.mts

@@ -1,47 +1,70 @@
 import { defineConfig } from "vitepress";
+import { withPwa } from "@vite-pwa/vitepress";
 
 // https://vitepress.dev/reference/site-config
-export default defineConfig({
-  title: "{{ cookiecutter.project_name }}",
-  description: "{{ cookiecutter.project_description }}",
-  themeConfig: {
-    // https://vitepress.dev/reference/default-theme-config
-    logo: "/logo.png",
-    nav: [
-      { text: "Home", link: "/" },
-      { text: "Guide", link: "/guide/" },
-      { text: "API", link: "/api/" },
-      {
-        text: "GitHub",
-        link: "https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}",
+export default withPwa(
+  defineConfig({
+    title: "{{ cookiecutter.project_name }}",
+    description: "{{ cookiecutter.project_description }}",
+    themeConfig: {
+      // https://vitepress.dev/reference/default-theme-config
+      logo: "/logo.png",
+      nav: [
+        { text: "Home", link: "/" },
+        { text: "Guide", link: "/guide/" },
+        { text: "API", link: "/api/" },
+        {
+          text: "GitHub",
+          link: "https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}",
+        },
+      ],
+      sidebar: [
+        {
+          text: "Introduction",
+          items: [
+            { text: "Getting Started", link: "/guide/" },
+            { text: "Installation", link: "/guide/installation" },
+          ],
+        },
+        {
+          text: "API Reference",
+          items: [
+            { text: "Overview", link: "/api/" },
+            { text: "Examples", link: "/api/examples" },
+          ],
+        },
+      ],
+      socialLinks: [
+        {
+          icon: "github",
+          link: "https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}",
+        },
+      ],
+      footer: {
+        message: "Released under the {{ cookiecutter.license }} License.",
+        copyright:
+          'Copyright © {% now "utc", "%Y" %} {{ cookiecutter.organization }}',
       },
-    ],
-    sidebar: [
-      {
-        text: "Introduction",
-        items: [
-          { text: "Getting Started", link: "/guide/" },
-          { text: "Installation", link: "/guide/installation" },
-        ],
-      },
-      {
-        text: "API Reference",
-        items: [
-          { text: "Overview", link: "/api/" },
-          { text: "Examples", link: "/api/examples" },
+    },
+    pwa: {
+      manifest: {
+        name: "{{ cookiecutter.project_name }}",
+        short_name: "{{ cookiecutter.project_name }}",
+        theme_color: "#2b2a27",
+        background_color: "#ffffff",
+        display: "standalone",
+        orientation: "portrait",
+        scope: "/",
+        start_url: "/",
+        icons: [
+          {
+            src: "/logo.png",
+            sizes: "192x192",
+            type: "image/png",
+            purpose: "maskable any",
+          },
         ],
       },
-    ],
-    socialLinks: [
-      {
-        icon: "github",
-        link: "https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}",
-      },
-    ],
-    footer: {
-      message: "Released under the {{ cookiecutter.license }} License.",
-      copyright:
-        'Copyright © {% now "utc", "%Y" %} {{ cookiecutter.organization }}',
     },
-  },
-});
+  })
+);