Change base url

.badges.json

@@ -31,4 +31,4 @@
       "status": "MIT"
     }
   ]
-}
+}

.github/workflows/qa.yml

@@ -24,6 +24,9 @@ jobs:
       - name: Lint source files
         run: npm run lint
 
+      - name: Run Prettier
+        run: npm run prettier
+
       - name: Check types
         run: npm run typecheck
 

.github/workflows/release.yml

@@ -12,7 +12,7 @@ permissions:
 jobs:
   ci:
     name: CI Init
-    runs-on: [ self-hosted, Linux ]
+    runs-on: [self-hosted, Linux]
     outputs:
       action: ${{ steps.init.outputs.action }}
     steps:
@@ -23,7 +23,7 @@ jobs:
     name: Prepare Release PR
     needs: ci
     if: needs.ci.outputs.action == 'prepare'
-    runs-on: [ self-hosted, Linux ]
+    runs-on: [self-hosted, Linux]
     steps:
       - uses: localazy/release/prepare@v2
         with:
@@ -35,7 +35,7 @@ jobs:
     name: Publish Release
     needs: ci
     if: needs.ci.outputs.action == 'publish'
-    runs-on: [ self-hosted, Linux ]
+    runs-on: [self-hosted, Linux]
     steps:
       - uses: localazy/release/publish@v2
         with:
@@ -47,7 +47,7 @@ jobs:
   deploy-docs:
     name: Deploy Docs
     needs: publish
-    runs-on: [ self-hosted, Linux ]
+    runs-on: [self-hosted, Linux]
     env:
       NODE_OPTIONS: --max_old_space_size=8192
     steps:

CHANGELOG.md

@@ -1,26 +1,22 @@
 # 1.5.0 (2024-03-18)
 
-
-
 ### ✨ Features
 
-* Add package version to the CdnClient class ([1a90771](https://github.com/localazy/cdn-client/commit/1a90771))
-
+- Add package version to the CdnClient class ([1a90771](https://github.com/localazy/cdn-client/commit/1a90771))
 
 ### 📚 Documentation
 
-* Update README.md and add badges ([1fd6ac2](https://github.com/localazy/cdn-client/commit/1fd6ac2))
-
+- Update README.md and add badges ([1fd6ac2](https://github.com/localazy/cdn-client/commit/1fd6ac2))
 
 ### 🧰 Other Commits
 
-* Add prettier ([91d4c12](https://github.com/localazy/cdn-client/commit/91d4c12))
-* Delete unused type ([7a9c488](https://github.com/localazy/cdn-client/commit/7a9c488))
-* Reformat with prettier ([8aa5725](https://github.com/localazy/cdn-client/commit/8aa5725))
-* Remove fetch polyfill ([5d60c36](https://github.com/localazy/cdn-client/commit/5d60c36))
-* Split CSS file into theme and custom styles, update hero claim ([ccd264a](https://github.com/localazy/cdn-client/commit/ccd264a))
-* Update deps ([80342a8](https://github.com/localazy/cdn-client/commit/80342a8))
-* Update terser plugin ([bd953d9](https://github.com/localazy/cdn-client/commit/bd953d9))
+- Add prettier ([91d4c12](https://github.com/localazy/cdn-client/commit/91d4c12))
+- Delete unused type ([7a9c488](https://github.com/localazy/cdn-client/commit/7a9c488))
+- Reformat with prettier ([8aa5725](https://github.com/localazy/cdn-client/commit/8aa5725))
+- Remove fetch polyfill ([5d60c36](https://github.com/localazy/cdn-client/commit/5d60c36))
+- Split CSS file into theme and custom styles, update hero claim ([ccd264a](https://github.com/localazy/cdn-client/commit/ccd264a))
+- Update deps ([80342a8](https://github.com/localazy/cdn-client/commit/80342a8))
+- Update terser plugin ([bd953d9](https://github.com/localazy/cdn-client/commit/bd953d9))
 
 ## 1.4.1 (2024-03-15)
 

README.md

@@ -48,16 +48,16 @@ const result = await cdn.fetch({
 const result = {
   en: {
     cdn_info: 'With the CDN you can deliver the translation files instantly',
-    cdn_testing: 'We\'re testing the CDN',
+    cdn_testing: "We're testing the CDN",
     hello_localazy: 'Hello Localazy!',
-    using_javascript: 'In this project we decided to use JavaScript'
+    using_javascript: 'In this project we decided to use JavaScript',
   },
   de: {
     cdn_info: 'Mit dem CDN können Sie die Übersetzungsdateien sofort liefern',
     cdn_testing: 'Wir testen das CDN',
     hello_localazy: 'Hallo Localazy!',
-    using_javascript: 'In diesem Projekt haben wir uns für JavaScript entschieden'
-  }
+    using_javascript: 'In diesem Projekt haben wir uns für JavaScript entschieden',
+  },
 };
 ```
 
@@ -77,7 +77,7 @@ For more information, visit [Installation](https://localazy.github.io/cdn-client
 Check out all npm packages from Localazy:
 
 | Package                                                                                                      | Description                                                              |
-|--------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|
+| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
 | [@localazy/cli](https://www.npmjs.com/package/@localazy/cli)                                                 | Localazy CLI tool for app and software localization and translation.     |
 | [@localazy/api-client](https://www.npmjs.com/package/@localazy/api-client)                                   | Node.js module that allows you to easily interact with the Localazy API. |
 | [@localazy/cdn-client](https://www.npmjs.com/package/@localazy/cdn-client)                                   | Node.js module that allows you to easily interact with the Localazy CDN. |

docs/.vitepress/config.ts

@@ -0,0 +1,39 @@
+import { defineConfig } from 'vitepress';
+import { markdown } from './config/markdown';
+import { head } from './config/en/head';
+import { nav } from './config/en/nav';
+import { sidebar } from './config/en/sidebar';
+
+export default defineConfig({
+  title: 'CDN Client',
+  titleTemplate: 'Localazy CDN Client',
+  description: 'Localazy CDN Client Documentation',
+
+  lang: 'en-US',
+  base: '/',
+  head: head(),
+  lastUpdated: true,
+  markdown: markdown(),
+
+  sitemap: {
+    hostname: 'https://localazy.github.io/cdn-client/',
+  },
+
+  themeConfig: {
+    logo: {
+      src: '/theme/localazy-logo.svg',
+      width: 24,
+      height: 24,
+    },
+    nav: nav(),
+    sidebar: sidebar(),
+    socialLinks: [
+      { icon: 'npm', link: 'https://www.npmjs.com/package/@localazy/cdn-client' },
+      { icon: 'github', link: 'https://github.com/localazy/cdn-client' },
+    ],
+    search: {
+      provider: 'local',
+    },
+    externalLinkIcon: true,
+  },
+});

docs/.vitepress/config/en/head.ts

@@ -0,0 +1,58 @@
+import { HeadConfig } from 'vitepress';
+
+export const head = (): HeadConfig[] => [
+  // Favicon
+  ['link', { rel: 'icon', href: '/cdn-client/favicon.ico', sizes: '32x32' }],
+  ['link', { rel: 'icon', href: '/cdn-client/theme/localazy-logo.svg', type: 'image/svg+xml' }],
+  ['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/cdn-client/theme/apple-touch-icon.png' }],
+
+  // Fonts
+  [
+    'link',
+    {
+      rel: 'stylesheet',
+      href: 'https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,300;0,400;0,500;0,700;0,900;1,100;1,300;1,400;1,500;1,700;1,900&display=swap',
+    },
+  ],
+
+  // Open Graph protocol
+  ['meta', { name: 'theme-color', content: '#066fef' }],
+  ['meta', { property: 'og:type', content: 'website' }],
+  ['meta', { property: 'og:locale', content: 'en' }],
+  ['meta', { property: 'og:title', content: 'Localazy CDN Client | Documentation' }],
+  ['meta', { property: 'og:site_name', content: 'Localazy CDN Client' }],
+  [
+    'meta',
+    {
+      property: 'og:description',
+      content: 'Node.js module that allows you to easily interact with the Localazy CDN.',
+    },
+  ],
+  [
+    'meta',
+    {
+      property: 'og:image',
+      content: 'https://localazy.github.io/cdn-client/cdn-client/theme/localazy-cdn-client-og.png',
+    },
+  ],
+  ['meta', { property: 'og:url', content: 'https://localazy.github.io/cdn-client/' }],
+
+  // Twitter card
+  ['meta', { property: 'twitter:card', content: 'summary_large_image' }],
+  ['meta', { property: 'twitter:url', content: 'https://localazy.github.io/cdn-client/' }],
+  ['meta', { property: 'twitter:title', content: 'Localazy CDN Client | Documentation' }],
+  [
+    'meta',
+    {
+      property: 'twitter:description',
+      content: 'Node.js module that allows you to easily interact with the Localazy CDN.',
+    },
+  ],
+  [
+    'meta',
+    {
+      property: 'twitter:image',
+      content: 'https://localazy.github.io/cdn-client/cdn-client/theme/localazy-cdn-client-og.png',
+    },
+  ],
+];

docs/.vitepress/config/en/nav.ts

@@ -0,0 +1,23 @@
+import { DefaultTheme } from 'vitepress/theme';
+import { version } from '../../../../package.json';
+
+export const nav = (): DefaultTheme.NavItem[] => [
+  {
+    text: 'Get Started',
+    link: '/get-started/introduction',
+    activeMatch: '/get-started/',
+  },
+  {
+    text: version,
+    items: [
+      {
+        text: 'Releases',
+        link: 'https://github.com/localazy/cdn-client/releases',
+      },
+      {
+        text: 'Changelog',
+        link: 'https://github.com/localazy/cdn-client/blob/main/CHANGELOG.md',
+      },
+    ],
+  },
+];