@stacksjs/docs 0.58.48 → 0.58.50

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/docs",
   "type": "module",
-  "version": "0.58.48",
+  "version": "0.58.50",
   "description": "The Stacks way to document.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -38,7 +38,8 @@
   ],
   "files": [
     "README.md",
-    "dist"
+    "dist",
+    "src"
   ],
   "scripts": {
     "build": "bun --bun build.ts",
@@ -51,7 +52,7 @@
     "@stacksjs/path": "latest",
     "@stacksjs/server": "latest",
     "@stacksjs/vite": "latest",
-    "vitepress": "1.0.0-rc.40"
+    "vitepress": "1.0.0-rc.41"
   },
   "dependencies": {
     "@stacksjs/alias": "latest",
@@ -59,7 +60,7 @@
     "@stacksjs/path": "latest",
     "@stacksjs/server": "latest",
     "@stacksjs/vite": "latest",
-    "vitepress": "1.0.0-rc.40",
+    "vitepress": "1.0.0-rc.41",
     "vitepress-plugin-twoslash": "^0.10.2"
   },
   "devDependencies": {

package/src/index.ts

@@ -0,0 +1,67 @@
+import { defineConfig } from 'vitepress'
+import type { UserConfig } from 'vitepress'
+import { alias } from '@stacksjs/alias'
+import { path as p } from '@stacksjs/path'
+import { docs } from '@stacksjs/config'
+import { server } from '@stacksjs/server'
+import { kolorist as c } from '@stacksjs/cli'
+import { withPwa } from '@vite-pwa/vitepress'
+import { version } from '../../../../../package.json'
+import { pwaDocs as pwa } from './scripts/pwa'
+
+export const frameworkDefaults = {
+  base: '/docs/',
+  cleanUrls: true,
+  srcDir: p.projectPath('docs'),
+  outDir: p.projectStoragePath('framework/docs'),
+  cacheDir: p.projectStoragePath('framework/cache/docs'),
+  assetsDir: p.assetsPath(),
+  // sitemap: {
+  //   hostname: 'stacks.localhost',
+  // },
+
+  vite: {
+    envDir: p.projectPath(),
+    envPrefix: 'FRONTEND_',
+
+    server: server({
+      type: 'docs',
+    }),
+
+    resolve: {
+      alias,
+    },
+
+    plugins: [
+      {
+        name: 'stacks-plugin',
+        configureServer(server) {
+          // const base = server.config.base || '/'
+          // const _print = server.printUrls
+          server.printUrls = () => { // eslint-disable-next-line no-console
+            console.log(`  ${c.blue(c.bold('STACKS'))} ${c.blue(version)}`)
+
+            // console.log(`  ${c.green('➜')}  ${c.bold('Docs')}: ${c.green('http://stacks.localhost:3333/docs')}`)
+            // eslint-disable-next-line no-console
+            console.log(`  ${c.green('➜')}  ${c.bold('Docs')}: ${c.green('https://stacks.localhost/docs')}`)
+            // eslint-disable-next-line no-console
+            console.log(`  ${c.green('➜')}  ${c.bold('Temp URL')}: ${c.green('http://stacksjs.test:3333')}`)
+          }
+        },
+      },
+    ],
+  },
+
+  pwa,
+} satisfies UserConfig
+
+const config: UserConfig = {
+  ...frameworkDefaults,
+  ...docs,
+}
+
+export default withPwa(defineConfig(config))
+
+export * from './plugins'
+export * from './scripts/pwa'
+export * from './meta'

package/src/meta.ts

@@ -0,0 +1,32 @@
+// noinspection ES6PreferShortImport: IntelliJ IDE hint to avoid warning to use `~/contributors`, will fail on build if changed
+
+/* Texts */
+// export const stacksName = 'Stacks'
+// export const stacksShortName = 'Stacks'
+// export const stacksDescription = 'Rapid application, cloud & library development framework'
+
+/* CDN fonts and styles */
+export const googleapis = 'https://fonts.googleapis.com'
+export const gstatic = 'https://fonts.gstatic.com'
+export const font = `${googleapis}/css2?family=Readex+Pro:wght@200;400;600&display=swap`
+
+/* vitepress head */
+export const ogUrl = 'https://stacksjs.org/'
+export const ogImage = `${ogUrl}og.png`
+
+/* GitHub and social links */
+export const github = 'https://github.com/stacksjs/stacks'
+export const releases = 'https://github.com/stacksjs/stacks/releases'
+export const contributing = 'https://github.com/stacksjs/stacks/blob/main/CONTRIBUTING.md'
+export const discord = 'https://chat.stacksjs.org'
+export const twitter = 'https://twitter.com/stacksjs'
+
+/* Avatar/Image/Sponsors servers */
+export const preconnectLinks = [googleapis, gstatic]
+export const preconnectHomeLinks = [googleapis, gstatic]
+
+/* PWA runtime caching urlPattern regular expressions */
+export const pwaFontsRegex = new RegExp(`^${googleapis}/.*`, 'i')
+export const pwaFontStylesRegex = new RegExp(`^${gstatic}/.*`, 'i')
+// eslint-disable-next-line prefer-regex-literals
+export const githubusercontentRegex = new RegExp('^https://((i.ibb.co)|((raw|user-images).githubusercontent.com))/.*', 'i')

package/src/plugins.ts

@@ -0,0 +1,4 @@
+import TwoSlashFloatingVue from 'vitepress-plugin-twoslash/client'
+import { transformerTwoslash } from 'vitepress-plugin-twoslash'
+
+export { TwoSlashFloatingVue, transformerTwoslash }

package/src/scripts/pwa.ts

@@ -0,0 +1,116 @@
+import { frameworkPath } from '@stacksjs/path'
+import type { PwaOptions } from '@vite-pwa/vitepress'
+import { docs } from '@stacksjs/config'
+import { githubusercontentRegex, pwaFontStylesRegex, pwaFontsRegex } from '../meta'
+
+export const pwaDocs: PwaOptions = {
+  outDir: frameworkPath('docs/dist'),
+  registerType: 'autoUpdate',
+  // include all static assets under public/
+  manifest: {
+    id: '/',
+    name: docs.title,
+    short_name: docs.title,
+    description: docs.description,
+    theme_color: '#ffffff',
+    start_url: '/',
+    lang: 'en-US',
+    dir: 'ltr',
+    orientation: 'natural',
+    display: 'standalone',
+    display_override: ['window-controls-overlay'],
+    categories: ['development', 'developer tools'],
+    icons: [
+      {
+        src: 'pwa-64x64.png',
+        sizes: '64x64',
+        type: 'image/png',
+      },
+      {
+        src: 'pwa-192x192.png',
+        sizes: '192x192',
+        type: 'image/png',
+      },
+      {
+        src: 'pwa-512x512.png',
+        sizes: '512x512',
+        type: 'image/png',
+        purpose: 'any',
+      },
+      {
+        src: 'maskable-icon.png',
+        sizes: '512x512',
+        type: 'image/png',
+        purpose: 'maskable',
+      },
+    ],
+    screenshots: [{
+      src: 'og.png',
+      sizes: '2258x1185',
+      type: 'image/png',
+      label: `Screenshot of ${docs.title}`,
+    }],
+    handle_links: 'preferred',
+    launch_handler: {
+      client_mode: ['navigate-existing', 'auto'],
+    },
+    edge_side_panel: {
+      preferred_width: 480,
+    },
+  },
+  workbox: {
+    navigateFallbackDenylist: [/^\/new$/],
+    // warning: sponsors/antfu.svg is 2.51 MB, and won't be precached
+    maximumFileSizeToCacheInBytes: 3 * 1024 * 1024, // <== 3MB
+    globPatterns: ['**/*.{css,js,html,png,svg,ico,txt,woff2,json}'],
+    // Rollup 4 change the layout: don't calculate revision (hash)
+    dontCacheBustURLsMatching: /^assets\//,
+    runtimeCaching: [
+      {
+        urlPattern: pwaFontsRegex,
+        handler: 'CacheFirst',
+        options: {
+          cacheName: 'google-fonts-cache',
+          expiration: {
+            maxEntries: 10,
+            maxAgeSeconds: 60 * 60 * 24 * 365, // <== 365 days
+          },
+          cacheableResponse: {
+            statuses: [0, 200],
+          },
+        },
+      },
+      {
+        urlPattern: pwaFontStylesRegex,
+        handler: 'CacheFirst',
+        options: {
+          cacheName: 'gstatic-fonts-cache',
+          expiration: {
+            maxEntries: 10,
+            maxAgeSeconds: 60 * 60 * 24 * 365, // <== 365 days
+          },
+          cacheableResponse: {
+            statuses: [0, 200],
+          },
+        },
+      },
+      {
+        urlPattern: githubusercontentRegex,
+        handler: 'CacheFirst',
+        options: {
+          cacheName: 'githubusercontent-images-cache',
+          expiration: {
+            maxEntries: 10,
+            maxAgeSeconds: 60 * 60 * 24 * 365, // <== 365 days
+          },
+          cacheableResponse: {
+            statuses: [0, 200],
+          },
+        },
+      },
+    ],
+  },
+  experimental: {
+    includeAllowlist: true,
+  },
+}