diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 9f7429d..377cc42 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -7,7 +7,6 @@ on: description: 'Publish as version[?]:' default: 'latest' - permissions: contents: write @@ -33,6 +32,7 @@ jobs: - name: Build for ${{ github.event.inputs.version }} run: yarn docs:build --base /${{ github.event.inputs.version }}/ + if: ${{ github.event.inputs.version != 'latest' }} - name: Deploy to ${{ github.event.inputs.version }} uses: JamesIves/github-pages-deploy-action@v4 @@ -48,6 +48,7 @@ jobs: - name: Build for main run: yarn docs:build + if: ${{ github.event.inputs.version == 'latest' }} - name: Deploy to latest if: ${{ github.event.inputs.version == 'latest' }} diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index b4f61d4..22d4be5 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -288,7 +288,7 @@ export default defineConfig({ text: 'Others', items: [ { text: 'MIT License', link: '/others/license' }, - { text: 'Changelog', link: '/others/changelog' }, + { text: 'Changelog', link: '/others/changelog' } ] } ] diff --git a/docs/src/generated/benchmark.md b/docs/src/generated/benchmark.md index a819c83..3887781 100644 --- a/docs/src/generated/benchmark.md +++ b/docs/src/generated/benchmark.md @@ -4,18 +4,20 @@ Run at Sun, 29 Jan 2023 01:24:01 GMT Commit: 3db90e8c262c48d011fdd53bcda105512434e56e - ## CACHE INTERCEPTOR -- Operations: 41275/s -- Network requests: 1 of 205788 -- Performance: 100.00% + +- Operations: 41275/s +- Network requests: 1 of 205788 +- Performance: 100.00% ## CACHE ADAPTER -- Operations: 37683/s -- Network requests: 2 of 185780 -- Performance: 91.30% + +- Operations: 37683/s +- Network requests: 2 of 185780 +- Performance: 91.30% ## AXIOS -- Operations: 1970/s -- Network requests: 9773 of 9773 -- Performance: 4.77% + +- Operations: 1970/s +- Network requests: 9773 of 9773 +- Performance: 4.77% diff --git a/docs/src/guide/getting-started.md b/docs/src/guide/getting-started.md index 56f9844..91f0848 100644 --- a/docs/src/guide/getting-started.md +++ b/docs/src/guide/getting-started.md @@ -17,17 +17,17 @@ npm install axios@1 axios-cache-interceptor@1 ``` ```html [Browser] - + ``` diff --git a/docs/src/guide/request-id.md b/docs/src/guide/request-id.md index 0aca14c..a93630a 100644 --- a/docs/src/guide/request-id.md +++ b/docs/src/guide/request-id.md @@ -61,9 +61,8 @@ properties: import Axios from 'axios'; import { setupCache, buildKeyGenerator } from 'axios-cache-interceptor'; - const axios = setupCache(Axios, { - keyGenerator: buildKeyGenerator((request/* [!code focus:5] */) => ({ + keyGenerator: buildKeyGenerator((request /* [!code focus:5] */) => ({ method: request.method, url: request.url, custom: logicWith(request.method, request.url)