diff --git a/.eslintrc.js b/.eslintrc.js index 502c615068..41859a9031 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -214,7 +214,7 @@ module.exports = { ], 'no-useless-escape': WARNING, 'no-void': [ERROR, {allowAsStatement: true}], - 'prefer-destructuring': WARNING, + 'prefer-destructuring': OFF, 'prefer-named-capture-group': WARNING, 'prefer-template': WARNING, yoda: WARNING, @@ -304,7 +304,7 @@ module.exports = { 'jest/prefer-expect-resolves': WARNING, 'jest/prefer-lowercase-title': [WARNING, {ignore: ['describe']}], 'jest/prefer-spy-on': WARNING, - 'jest/prefer-to-be': WARNING, + 'jest/prefer-to-be': OFF, 'jest/prefer-to-have-length': WARNING, 'jest/require-top-level-describe': ERROR, 'jest/valid-title': [ diff --git a/.github/workflows/argos.yml b/.github/workflows/argos.yml index c1c6be47ef..f381f3c242 100644 --- a/.github/workflows/argos.yml +++ b/.github/workflows/argos.yml @@ -27,10 +27,10 @@ jobs: runs-on: ubuntu-latest steps: - name: Check out repository code - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Use Node.js - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn diff --git a/.github/workflows/build-blog-only.yml b/.github/workflows/build-blog-only.yml index 334ae73dea..18f6777d7c 100644 --- a/.github/workflows/build-blog-only.yml +++ b/.github/workflows/build-blog-only.yml @@ -22,9 +22,9 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Set up Node - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn @@ -32,3 +32,5 @@ jobs: run: yarn || yarn || yarn - name: Build blog-only run: yarn workspace website build:blogOnly + env: + DOCUSAURUS_PERF_LOGGER: 'true' diff --git a/.github/workflows/build-hash-router.yml b/.github/workflows/build-hash-router.yml index e99ec20433..e143bb8ed2 100644 --- a/.github/workflows/build-hash-router.yml +++ b/.github/workflows/build-hash-router.yml @@ -25,9 +25,9 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Set up Node - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn @@ -37,19 +37,20 @@ jobs: - name: Build Hash Router run: yarn build:website:fast env: + DOCUSAURUS_PERF_LOGGER: 'true' DOCUSAURUS_ROUTER: 'hash' # Note: hash router + baseUrl do not play well together # This would host at https://facebook.github.io/docusaurus/#/docusaurus/ # BASE_URL: '/docusaurus/' # hash router + - name: Upload Website artifact - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v5 with: name: website-hash-router-archive path: website/build #- name: Upload Website Pages artifact - # uses: actions/upload-pages-artifact@v3 + # uses: actions/upload-pages-artifact@v4 # with: # path: website/build diff --git a/.github/workflows/build-perf.yml b/.github/workflows/build-perf.yml index aa46d31b8e..d1fc937229 100644 --- a/.github/workflows/build-perf.yml +++ b/.github/workflows/build-perf.yml @@ -41,9 +41,9 @@ jobs: DOCUSAURUS_INFRA: ['SLOWER', 'FASTER'] steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Set up Node - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn @@ -62,6 +62,7 @@ jobs: comment-key: DOCUSAURUS_INFRA_${{ matrix.DOCUSAURUS_INFRA }} env: DOCUSAURUS_SLOWER: ${{ matrix.DOCUSAURUS_INFRA == 'SLOWER' && 'true' || 'false' }} + DOCUSAURUS_PERF_LOGGER: 'true' # Ensures build times stay under reasonable thresholds build-time: @@ -73,9 +74,9 @@ jobs: DOCUSAURUS_INFRA: ['SLOWER', 'FASTER'] steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Set up Node - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn @@ -88,6 +89,7 @@ jobs: timeout-minutes: ${{ matrix.DOCUSAURUS_INFRA == 'SLOWER' && 3 || 2 }} env: DOCUSAURUS_SLOWER: ${{ matrix.DOCUSAURUS_INFRA == 'SLOWER' && 'true' || 'false' }} + DOCUSAURUS_PERF_LOGGER: 'true' # Ensure build with a warm cache does not increase too much - name: Build (warm cache) @@ -96,5 +98,6 @@ jobs: timeout-minutes: ${{ matrix.DOCUSAURUS_INFRA == 'SLOWER' && 1 || 2 }} env: DOCUSAURUS_SLOWER: ${{ matrix.DOCUSAURUS_INFRA == 'SLOWER' && 'true' || 'false' }} + DOCUSAURUS_PERF_LOGGER: 'true' # TODO post a GitHub comment with build with perf warnings? diff --git a/.github/workflows/canary-release.yml b/.github/workflows/canary-release.yml index cf417eb044..cbcf9e877a 100644 --- a/.github/workflows/canary-release.yml +++ b/.github/workflows/canary-release.yml @@ -20,11 +20,11 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 with: fetch-depth: 0 # Needed to get the commit number with "git rev-list --count HEAD" - name: Set up Node - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 6a8990b04a..e544c63f62 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -33,12 +33,12 @@ jobs: steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Initialize CodeQL - uses: github/codeql-action/init@2c779ab0d087cd7fe7b826087247c2c81f27bfa6 # 3.26.5 + uses: github/codeql-action/init@4e94bd11f71e507f7f87df81788dff88d1dacbfb # 4.31.0 with: languages: ${{ matrix.language }} - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@2c779ab0d087cd7fe7b826087247c2c81f27bfa6 # 3.26.5 + uses: github/codeql-action/analyze@4e94bd11f71e507f7f87df81788dff88d1dacbfb # 4.31.0 diff --git a/.github/workflows/continuous-releases.yml b/.github/workflows/continuous-releases.yml index 13431aef77..2b26a9e81f 100644 --- a/.github/workflows/continuous-releases.yml +++ b/.github/workflows/continuous-releases.yml @@ -18,10 +18,10 @@ jobs: steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Set up Node - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml index 5d9fc5e2ed..813363d2fd 100644 --- a/.github/workflows/dependency-review.yml +++ b/.github/workflows/dependency-review.yml @@ -13,6 +13,6 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Dependency Review - uses: actions/dependency-review-action@da24556b548a50705dd671f47852072ea4c105d9 # 4.7.1 + uses: actions/dependency-review-action@3c4e3dcb1aa7874d2c16be7d79418e9b7efd6261 # 4.8.2 diff --git a/.github/workflows/lighthouse-report.yml b/.github/workflows/lighthouse-report.yml index 118cd61afb..cc6fc8c1eb 100644 --- a/.github/workflows/lighthouse-report.yml +++ b/.github/workflows/lighthouse-report.yml @@ -1,7 +1,7 @@ name: Lighthouse Report on: - pull_request_target: + pull_request: branches: - main - docusaurus-v** @@ -21,10 +21,10 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Use Node.js - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn @@ -53,7 +53,7 @@ jobs: - name: Format lighthouse score id: format_lighthouse_score - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # 7.0.1 + uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # 8.0.0 with: github-token: ${{ secrets.GITHUB_TOKEN }} script: | @@ -65,7 +65,7 @@ jobs: - name: Add Lighthouse stats as comment id: comment_to_pr - uses: marocchino/sticky-pull-request-comment@d2ad0de260ae8b0235ce059e63f2949ba9e05943 # 2.9.3 + uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # 2.9.4 with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} number: ${{ github.event.pull_request.number }} diff --git a/.github/workflows/lint-autofix.yml b/.github/workflows/lint-autofix.yml index dd42164b3b..00d52dd5d8 100644 --- a/.github/workflows/lint-autofix.yml +++ b/.github/workflows/lint-autofix.yml @@ -19,7 +19,7 @@ jobs: contents: write steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6.0.1 with: repository: ${{ github.event.pull_request.head.repo.full_name }} ref: ${{ github.head_ref }} @@ -42,6 +42,6 @@ jobs: - name: Print Diff run: git diff - - uses: stefanzweifel/git-auto-commit-action@v6 + - uses: stefanzweifel/git-auto-commit-action@v7 with: commit_message: 'refactor: apply lint autofix' diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index b7a477806d..bcba72d055 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -20,9 +20,9 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Set up Node - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn diff --git a/.github/workflows/showcase-test.yml b/.github/workflows/showcase-test.yml index ff3a8018f8..6b8fd4d16b 100644 --- a/.github/workflows/showcase-test.yml +++ b/.github/workflows/showcase-test.yml @@ -22,9 +22,9 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Set up Node - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn diff --git a/.github/workflows/tests-e2e.yml b/.github/workflows/tests-e2e.yml index 875910efaa..6116e23e72 100644 --- a/.github/workflows/tests-e2e.yml +++ b/.github/workflows/tests-e2e.yml @@ -38,12 +38,12 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - node: ['18.0', '20', '22', '24'] + node: ['20.0', '20', '22', '24', '25.1'] steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Use Node.js ${{ matrix.node }} - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: ${{ matrix.node }} cache: yarn @@ -78,9 +78,9 @@ jobs: runs-on: windows-8-core steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Use Node.js LTS - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn @@ -109,7 +109,7 @@ jobs: DOCUSAURUS_PERF_LOGGER: 'true' working-directory: test-website-in-workspace - name: Upload Website artifact - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v5 with: name: website-e2e-windows path: test-website-in-workspace/build @@ -124,9 +124,9 @@ jobs: variant: [-s, -st] steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Use Node.js LTS - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn @@ -193,9 +193,9 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Use Node.js LTS - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn @@ -233,9 +233,9 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Use Node.js LTS - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn diff --git a/.github/workflows/tests-swizzle.yml b/.github/workflows/tests-swizzle.yml index 92a15de818..bd52ac93a4 100644 --- a/.github/workflows/tests-swizzle.yml +++ b/.github/workflows/tests-swizzle.yml @@ -26,9 +26,9 @@ jobs: variant: ['js', 'ts'] steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Set up Node LTS - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: lts/* cache: yarn diff --git a/.github/workflows/tests-windows.yml b/.github/workflows/tests-windows.yml index 018eb41268..c1feb517e8 100644 --- a/.github/workflows/tests-windows.yml +++ b/.github/workflows/tests-windows.yml @@ -27,14 +27,14 @@ jobs: runs-on: windows-latest strategy: matrix: - node: ['18.0', '20', '22', '24'] + node: ['20.0', '20', '22', '24', '25.1'] steps: - name: Support longpaths run: git config --system core.longpaths true - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Use Node.js ${{ matrix.node }} - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: ${{ matrix.node }} cache: yarn @@ -54,14 +54,20 @@ jobs: run: yarn workspace website test:swizzle:wrap:ts - name: Docusaurus Build run: yarn build:website:fast + env: + DOCUSAURUS_PERF_LOGGER: 'true' - name: TypeCheck website - # TODO temporary, remove TS skipLibCheck # see https://github.com/facebook/docusaurus/pull/10486 - run: yarn workspace website typecheck --project tsconfig.skipLibCheck.json + run: yarn workspace website typecheck - name: TypeCheck website - min version - v5.1 run: | yarn add typescript@5.1.6 --exact -D -W --ignore-scripts + + # DocSearch@4/ai@5 doesn't support TS 5.1 (with skipLibCheck=false) + jq '.resolutions."@docsearch/react" = "^3.9.0"' package.json > package.json.tmp && mv -Force package.json.tmp package.json + yarn add @docsearch/react@^3.9.0 --exact -D -W --ignore-scripts + yarn workspace website typecheck - name: TypeCheck website - max version - Latest # For latest TS there are often lib check errors, so we disable it diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 4163b3131f..9a71d589f8 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -27,12 +27,12 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - node: ['18.0', '20', '22', '24'] + node: ['20.0', '20', '22', '24', '25.1'] steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Use Node.js ${{ matrix.node }} - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 with: node-version: ${{ matrix.node }} cache: yarn @@ -55,12 +55,16 @@ jobs: run: yarn workspace website test:css-order - name: TypeCheck website - # TODO temporary, remove TS skipLibCheck # see https://github.com/facebook/docusaurus/pull/10486 - run: yarn workspace website typecheck --project tsconfig.skipLibCheck.json + run: yarn workspace website typecheck - name: TypeCheck website - min version - v5.1 run: | yarn add typescript@5.1.6 --exact -D -W --ignore-scripts + + # DocSearch@4/ai@5 doesn't support TS 5.1 (with skipLibCheck=false) + jq '.resolutions."@docsearch/react" = "^3.9.0"' package.json > package.json.tmp && mv -f package.json.tmp package.json + yarn add @docsearch/react@^3.9.0 --exact -D -W --ignore-scripts + yarn workspace website typecheck - name: TypeCheck website - max version - Latest # For latest TS there are often lib check errors, so we disable it diff --git a/.prettierignore b/.prettierignore index 19af204b9c..c611d3a49e 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,7 +1,7 @@ dist node_modules .yarn -build +**/build/** coverage .docusaurus .idea @@ -11,6 +11,8 @@ coverage jest/vendor +argos/test-results + packages/lqip-loader/lib/ packages/docusaurus/lib/ packages/docusaurus-*/lib/* diff --git a/CHANGELOG.md b/CHANGELOG.md index 59c365d070..808dba8538 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,186 @@ # Docusaurus Changelog +## 3.9.2 (2025-10-17) + +#### :bug: Bug Fix + +- `docusaurus-plugin-content-docs` + - [#11490](https://github.com/facebook/docusaurus/pull/11490) fix(docs): add support for missing `sidebar_key` front matter attribute ([@slorber](https://github.com/slorber)) +- `docusaurus-cssnano-preset` + - [#11487](https://github.com/facebook/docusaurus/pull/11487) fix(cssnano-preset): disable CSS counter minification ([@YDKK](https://github.com/YDKK)) +- `docusaurus-theme-search-algolia` + - [#11468](https://github.com/facebook/docusaurus/pull/11468) fix(theme-search-algolia): Fix Algolia AskAI validation logic ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-translations` + - [#11431](https://github.com/facebook/docusaurus/pull/11431) fix(theme-translation): add missing Polish (pl) theme translations ([@mariuszkrzaczkowski](https://github.com/mariuszkrzaczkowski)) +- `docusaurus-theme-classic`, `docusaurus-theme-common` + - [#11466](https://github.com/facebook/docusaurus/pull/11466) fix(theme): Fix CSS `scroll-margin-top` when clicking footnote items, factorize code ([@slorber](https://github.com/slorber)) +- `docusaurus` + - [#11452](https://github.com/facebook/docusaurus/pull/11452) fix(core): allow `i18n.localeConfigs.translate` in validation ([@trofim24](https://github.com/trofim24)) +- `docusaurus-theme-mermaid` + - [#11437](https://github.com/facebook/docusaurus/pull/11437) fix(theme-mermaid): Fix Mermaid ELK layout dependency required bug on v3.9 ([@slorber](https://github.com/slorber)) + +#### :running_woman: Performance + +- `docusaurus-theme-mermaid` + - [#11438](https://github.com/facebook/docusaurus/pull/11438) perf(theme-mermaid): lazy load the Mermaid library ([@slorber](https://github.com/slorber)) + +#### :nail_care: Polish + +- `docusaurus-theme-classic` + - [#11463](https://github.com/facebook/docusaurus/pull/11463) fix(theme): remove "Edit this page" button from print view ([@richk21](https://github.com/richk21)) + +#### :robot: Dependencies + +- [#11479](https://github.com/facebook/docusaurus/pull/11479) chore(deps): bump stefanzweifel/git-auto-commit-action from 6 to 7 ([@dependabot[bot]](https://github.com/apps/dependabot)) +- [#11480](https://github.com/facebook/docusaurus/pull/11480) chore(deps): bump github/codeql-action from 3.26.5 to 4.30.8 ([@dependabot[bot]](https://github.com/apps/dependabot)) +- [#11481](https://github.com/facebook/docusaurus/pull/11481) chore(deps): bump actions/dependency-review-action from 4.8.0 to 4.8.1 ([@dependabot[bot]](https://github.com/apps/dependabot)) +- [#11446](https://github.com/facebook/docusaurus/pull/11446) chore(deps): bump actions/dependency-review-action from 4.7.3 to 4.8.0 ([@dependabot[bot]](https://github.com/apps/dependabot)) + +#### :globe_with_meridians: Translations + +- `docusaurus-theme-translations` + - [#11484](https://github.com/facebook/docusaurus/pull/11484) fix(translations): improve Arabic theme translations ([@maysara-elshewehy](https://github.com/maysara-elshewehy)) + +#### Committers: 9 + +- Alexander Trofimov ([@trofim24](https://github.com/trofim24)) +- Dan Roscigno ([@DanRoscigno](https://github.com/DanRoscigno)) +- Eleni Grosdouli ([@egrosdou01](https://github.com/egrosdou01)) +- Ethan ([@ethanppl](https://github.com/ethanppl)) +- Mariusz Krzaczkowski ([@mariuszkrzaczkowski](https://github.com/mariuszkrzaczkowski)) +- Maysara ([@maysara-elshewehy](https://github.com/maysara-elshewehy)) +- Richa Kiran ([@richk21](https://github.com/richk21)) +- Sébastien Lorber ([@slorber](https://github.com/slorber)) +- [@YDKK](https://github.com/YDKK) + +## 3.9.1 (2025-09-26) + +#### :bug: Bug Fix + +- `docusaurus` + - [#11434](https://github.com/facebook/docusaurus/pull/11434) fix(core): fix Docusaurus outDir for sites using baseUrl ([@slorber](https://github.com/slorber)) + +#### Committers: 1 + +- Sébastien Lorber ([@slorber](https://github.com/slorber)) + +## 3.9.0 (2025-09-25) + +#### :rocket: New Feature + +- `docusaurus-theme-search-algolia` + - [#11421](https://github.com/facebook/docusaurus/pull/11421) feat(theme-search-algolia): use DocSearch v4.1, optimize integration ([@slorber](https://github.com/slorber)) +- `docusaurus-plugin-content-blog`, `docusaurus-theme-classic` + - [#11425](https://github.com/facebook/docusaurus/pull/11425) feat(blog): Add support for email social icon + resize default social icon a bit ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-classic`, `docusaurus-theme-common` + - [#11426](https://github.com/facebook/docusaurus/pull/11426) feat(theme): Add theme-tabs-container stable className ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-classic`, `docusaurus-theme-search-algolia`, `docusaurus-theme-translations` + - [#11327](https://github.com/facebook/docusaurus/pull/11327) feat(search): add runtime support for DocSearch v4 ([@dylantientcheu](https://github.com/dylantientcheu)) +- `docusaurus-faster`, `docusaurus` + - [#11415](https://github.com/facebook/docusaurus/pull/11415) feat(faster): upgrade Rspack to 1.5, use lazyBarrel experiment, remove deprecated option ([@slorber](https://github.com/slorber)) + - [#11294](https://github.com/facebook/docusaurus/pull/11294) feat(faster): Upgrade to Rspack 1.4 ([@slorber](https://github.com/slorber)) +- `docusaurus-utils` + - [#11397](https://github.com/facebook/docusaurus/pull/11397) feat(mdx): resolve `@site/*` markdown links, fix resolution priority bugs ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-mermaid` + - [#11357](https://github.com/facebook/docusaurus/pull/11357) feat(mermaid): support elk layout ([@Feez2403](https://github.com/Feez2403)) +- `docusaurus-plugin-pwa`, `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-types`, `docusaurus-utils`, `docusaurus` + - [#11316](https://github.com/facebook/docusaurus/pull/11316) feat(core): Add `i18n.localeConfigs[locale].{url,baseUrl}` config options, fix multi-domain deployments ([@slorber](https://github.com/slorber)) +- `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-content-pages`, `docusaurus-types`, `docusaurus-utils`, `docusaurus` + - [#11304](https://github.com/facebook/docusaurus/pull/11304) feat(core): add `i18n.localeConfigs.translate` + skip translation process if `i18n/` dir doesn't exist ([@slorber](https://github.com/slorber)) +- `docusaurus-plugin-content-docs` + - [#11228](https://github.com/facebook/docusaurus/pull/11228) feat(docs): sidebar item `key` attribute - fix docs translations key conflicts ([@slorber](https://github.com/slorber)) +- `create-docusaurus` + - [#11293](https://github.com/facebook/docusaurus/pull/11293) feat(create-docusaurus): use respectPrefersColorScheme in init template ([@slorber](https://github.com/slorber)) +- `docusaurus-mdx-loader`, `docusaurus-types`, `docusaurus` + - [#11282](https://github.com/facebook/docusaurus/pull/11282) feat(core): add `siteConfig.markdown.emoji` config option to disable `remark-emoji` ([@slorber](https://github.com/slorber)) +- `create-docusaurus`, `docusaurus-mdx-loader`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-types`, `docusaurus` + - [#11283](https://github.com/facebook/docusaurus/pull/11283) feat(core): Add `siteConfig.markdown.hooks`, deprecate `siteConfig.onBrokenMarkdownLinks` ([@slorber](https://github.com/slorber)) + +#### :bug: Bug Fix + +- `docusaurus-theme-classic`, `docusaurus` + - [#11422](https://github.com/facebook/docusaurus/pull/11422) fix(theme): fix copy of indented code blocks, replace copy-text-to-clipboard by clipboard API ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-classic` + - [#11407](https://github.com/facebook/docusaurus/pull/11407) fix(theme): remove hardcoded fill from Bluesky and LinkedIn icons ([@Simek](https://github.com/Simek)) + - [#11389](https://github.com/facebook/docusaurus/pull/11389) fix(theme): render sidebar category index with unlisted children as a simple doc/link item ([@slorber](https://github.com/slorber)) + - [#11360](https://github.com/facebook/docusaurus/pull/11360) fix(theme): Add translate no to heading anchors and blog authors ([@slorber](https://github.com/slorber)) + - [#11356](https://github.com/facebook/docusaurus/pull/11356) fix(theme): Doc sidebar links/categories with long labels should display properly ([@slorber](https://github.com/slorber)) + - [#11338](https://github.com/facebook/docusaurus/pull/11338) fix(theme-classic): fix collapsed sidebar category expansion when navigating to another link within that category ([@qqq614](https://github.com/qqq614)) + - [#11289](https://github.com/facebook/docusaurus/pull/11289) fix(theme): Fix footnote ref scrolling behind the navbar when footnote back reference clicked ([@slorber](https://github.com/slorber)) +- `docusaurus` + - [#11410](https://github.com/facebook/docusaurus/pull/11410) fix(deps): upgrade webpack-dev-server to v5, fix security warning ([@slorber](https://github.com/slorber)) + - [#11347](https://github.com/facebook/docusaurus/pull/11347) fix(core): Fix docusaurus start on macOS when exec throws a synchronous error ([@slorber](https://github.com/slorber)) + - [#11271](https://github.com/facebook/docusaurus/pull/11271) fix(dev-server): use correct dev server HTML lang attribute ([@enumura1](https://github.com/enumura1)) +- `docusaurus-theme-common` + - [#11405](https://github.com/facebook/docusaurus/pull/11405) fix(theme): fix `useColorMode()` visual glitches due to provider unmounts/remounts ([@slorber](https://github.com/slorber)) + - [#11280](https://github.com/facebook/docusaurus/pull/11280) fix(theme-common): Export FooterColumnItem type ([@stubinubin](https://github.com/stubinubin)) +- `docusaurus-bundler`, `docusaurus-faster` + - [#11383](https://github.com/facebook/docusaurus/pull/11383) fix(ssg): HTML minifier should preserve `` for `og:image` crawlers ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-classic`, `docusaurus-theme-translations` + - [#11331](https://github.com/facebook/docusaurus/pull/11331) fix(theme): Add `aria-label` to `IconExternalLink` with value `'(opens in new tab)'` ([@WestonThayer](https://github.com/WestonThayer)) +- `docusaurus-plugin-content-docs` + - [#11281](https://github.com/facebook/docusaurus/pull/11281) fix(docs): Fix empty sidebar item category `className` lost when post-processed to a doc ([@slorber](https://github.com/slorber)) + - [#11251](https://github.com/facebook/docusaurus/pull/11251) fix(docs): prevent docs ids conflicts within a version ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-classic`, `docusaurus-theme-common` + - [#11263](https://github.com/facebook/docusaurus/pull/11263) fix(theme): make `useHistorySelector()` hydration-safe + use it read search/hash in theme ([@slorber](https://github.com/slorber)) + +#### :memo: Documentation + +- [#11339](https://github.com/facebook/docusaurus/pull/11339) docs: clarify impact of document ID on the URL ([@shanti2530](https://github.com/shanti2530)) + +#### :robot: Dependencies + +- [#11402](https://github.com/facebook/docusaurus/pull/11402) chore(deps): bump actions/github-script from 7.0.1 to 8.0.0 ([@dependabot[bot]](https://github.com/apps/dependabot)) +- [#11401](https://github.com/facebook/docusaurus/pull/11401) chore(deps): bump actions/dependency-review-action from 4.7.2 to 4.7.3 ([@dependabot[bot]](https://github.com/apps/dependabot)) +- [#11403](https://github.com/facebook/docusaurus/pull/11403) chore(deps): bump actions/setup-node from 4.4.0 to 5.0.0 ([@dependabot[bot]](https://github.com/apps/dependabot)) +- [#11373](https://github.com/facebook/docusaurus/pull/11373) chore(deps): bump actions/dependency-review-action from 4.7.1 to 4.7.2 ([@dependabot[bot]](https://github.com/apps/dependabot)) +- [#11365](https://github.com/facebook/docusaurus/pull/11365) chore(deps): bump actions/checkout from 4 to 5 ([@dependabot[bot]](https://github.com/apps/dependabot)) +- [#11342](https://github.com/facebook/docusaurus/pull/11342) chore(deps): bump form-data from 4.0.1 to 4.0.4 ([@dependabot[bot]](https://github.com/apps/dependabot)) +- [#11341](https://github.com/facebook/docusaurus/pull/11341) chore(deps): bump marocchino/sticky-pull-request-comment from 2.9.3 to 2.9.4 ([@dependabot[bot]](https://github.com/apps/dependabot)) +- [#11285](https://github.com/facebook/docusaurus/pull/11285) chore(deps): bump marocchino/sticky-pull-request-comment from 2.9.2 to 2.9.3 ([@dependabot[bot]](https://github.com/apps/dependabot)) +- [#11272](https://github.com/facebook/docusaurus/pull/11272) chore(deps): bump stefanzweifel/git-auto-commit-action from 5 to 6 ([@dependabot[bot]](https://github.com/apps/dependabot)) +- [#11273](https://github.com/facebook/docusaurus/pull/11273) chore(deps): bump treosh/lighthouse-ci-action from 12.1.0 to 12.6.1 ([@dependabot[bot]](https://github.com/apps/dependabot)) + +#### :wrench: Maintenance + +- `create-docusaurus`, `docusaurus-babel`, `docusaurus-bundler`, `docusaurus-cssnano-preset`, `docusaurus-faster`, `docusaurus-logger`, `docusaurus-mdx-loader`, `docusaurus-plugin-client-redirects`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-content-pages`, `docusaurus-plugin-css-cascade-layers`, `docusaurus-plugin-debug`, `docusaurus-plugin-google-analytics`, `docusaurus-plugin-google-gtag`, `docusaurus-plugin-google-tag-manager`, `docusaurus-plugin-ideal-image`, `docusaurus-plugin-pwa`, `docusaurus-plugin-rsdoctor`, `docusaurus-plugin-sitemap`, `docusaurus-plugin-svgr`, `docusaurus-plugin-vercel-analytics`, `docusaurus-preset-classic`, `docusaurus-remark-plugin-npm2yarn`, `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-theme-live-codeblock`, `docusaurus-theme-mermaid`, `docusaurus-theme-search-algolia`, `docusaurus-theme-translations`, `docusaurus-utils-common`, `docusaurus-utils-validation`, `docusaurus-utils`, `docusaurus`, `eslint-plugin`, `lqip-loader` + - [#11408](https://github.com/facebook/docusaurus/pull/11408) chore: drop support for Node 18, that reached End-of-Life ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-classic` + - [#11317](https://github.com/facebook/docusaurus/pull/11317) chore: minor reduction to inline svg/js code ([@SethFalco](https://github.com/SethFalco)) +- `docusaurus-plugin-content-docs` + - [#11307](https://github.com/facebook/docusaurus/pull/11307) test(docs): fix docs tests issues ([@slorber](https://github.com/slorber)) +- `docusaurus-bundler` + - [#11290](https://github.com/facebook/docusaurus/pull/11290) chore: upgrade website to Rspack 1.4 + fix Rspack internal performance tracing ([@slorber](https://github.com/slorber)) +- Other + - [#11287](https://github.com/facebook/docusaurus/pull/11287) chore(website): split changelog per version + adjust changelog plugin implementation ([@slorber](https://github.com/slorber)) + +#### :globe_with_meridians: Translations + +- `docusaurus-theme-translations` + - [#11315](https://github.com/facebook/docusaurus/pull/11315) fix(theme-translations): Add missing Portuguese (pt-BR) theme translations and improve some of it. ([@marcelocell](https://github.com/marcelocell)) + - [#11305](https://github.com/facebook/docusaurus/pull/11305) fix(translations): Add missing Ukrainian translations ([@maluke](https://github.com/maluke)) + +#### Committers: 18 + +- Akshat Sinha ([@akshatsinha0](https://github.com/akshatsinha0)) +- Bartosz Kaszubowski ([@Simek](https://github.com/Simek)) +- Dylan Tientcheu ([@dylantientcheu](https://github.com/dylantientcheu)) +- Guo Ci ([@guoci](https://github.com/guoci)) +- Jaime Iniesta ([@jaimeiniesta](https://github.com/jaimeiniesta)) +- Joshua Chen ([@Josh-Cena](https://github.com/Josh-Cena)) +- Marcelo Junior ([@marcelocell](https://github.com/marcelocell)) +- Maria Stellini ([@shanti2530](https://github.com/shanti2530)) +- Riccardo ([@3v0k4](https://github.com/3v0k4)) +- Sergey Schetinin ([@maluke](https://github.com/maluke)) +- Seth Falco ([@SethFalco](https://github.com/SethFalco)) +- Sébastien Lorber ([@slorber](https://github.com/slorber)) +- Weston Thayer ([@WestonThayer](https://github.com/WestonThayer)) +- [@Feez2403](https://github.com/Feez2403) +- [@stubinubin](https://github.com/stubinubin) +- [@ya-dvorovenko](https://github.com/ya-dvorovenko) +- enumura ([@enumura1](https://github.com/enumura1)) +- hjcho ([@qqq614](https://github.com/qqq614)) + ## 3.8.1 (2025-06-06) #### :bug: Bug Fix diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2247b52162..de66b73be0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -82,7 +82,7 @@ Apart from the `good first issue`, the following labels are also worth looking a - [`help wanted`](https://github.com/facebook/docusaurus/labels/help%20wanted): if you have specific knowledge in one domain, working on these issues can make your expertise shine. - [`status: accepting pr`](https://github.com/facebook/docusaurus/labels/status%3A%20accepting%20pr): community contributors can feel free to claim any of these. -If you want to work on any of these issues, just drop a message saying "I'd like to work on this", and we will assign the issue to you and update the issue's status as "claimed". **You are expected to send a pull request within seven days** after that, so we can still delegate the issue to someone else if you are unavailable. +If you want to work on any of these issues, just drop a message saying "I am working on this". **You do not need to ask for assignment to work on any issue explicitly marked as welcoming external contributions.** However, don't "cookie lick", or squat on an issue without actually sending a PR. You are automatically considered as giving up if you don't **send a PR within seven days after your comment**, and the issue automatically becomes up for grabs again. Alternatively, when opening an issue, you can also click the "self service" checkbox to indicate that you'd like to work on the issue yourself, which will also make us see the issue as "claimed". @@ -214,6 +214,16 @@ After you have signed the CLA, the CLA bot would automatically update the PR sta If it happens that you were unavailable and your PR gets closed, feel free to reopen once it's ready! We are still happy to review it, help you complete it, and eventually merge it. +### AI-assisted PRs + +We welcome the use of AI tools for authoring PRs, and we love to see people pushing the boundaries of AI capabilities. The core team actively uses different AI tools in our development process. However, we are aware that **many people are sending entirely AI-generated PRs as a low-effort way to farm OSS contributions**, so please be mindful of the following etiquette to show your respect for our time and our codebase: + +- **Be transparent**: If a significant portion of your code is AI generated, please indicate that in your PR description. +- **Be accountable**: You are responsible for the code you submit, regardless of whether it was generated by AI or written by you. You should be able to explain every line of the code, ensure all tests pass, and address our reviews. +- **Be reasonable**: Sometimes we receive 1k LOC PRs that are obviously AI-generated and implement unsolicited features. Please note that significant changes require prior communication and approval from the team in the form of an issue. + +We retain the right to close any PR that we deem as unproductive or low-effort, even when we agree with the spirit of the change. + ### Breaking Changes When adding a new breaking change, follow this template in your pull request: @@ -227,6 +237,10 @@ When adding a new breaking change, follow this template in your pull request: - **Severity (number of people affected x effort)**: ``` +> [!NOTE] +> +> Breaking changes should be discussed in the issue tracker before being implemented. + ### What Happens Next? The core Docusaurus team will be monitoring pull requests. Do help us by keeping pull requests consistent by following the guidelines above. diff --git a/README.md b/README.md index 70fe727319..b4feffe65a 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Short on time? Check out our [5-minute tutorial ⏱️](https://tutorial.docusau - **Customizable** -> While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a [blog](https://docusaurus.io/docs/blog), and additional support pages, it is also [customizable](https://docusaurus.io/docs/creating-pages) as well to ensure you have a site that is [uniquely yours](https://docusaurus.io/docs/styling-layout). +> While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a [blog](https://docusaurus.io/docs/blog), and additional support pages, it is also [customizable](https://docusaurus.io/docs/creating-pages) to ensure you have a site that is [uniquely yours](https://docusaurus.io/docs/styling-layout). ## Installation @@ -120,4 +120,4 @@ The Docusaurus documentation (e.g., `.md` files in the `/docs` folder) is [Creat [![Rocket Validator logo](./admin/img/rocketvalidator-logo.png)](https://rocketvalidator.com/) -[Rocket Validator](https://rocketvalidator.com/) helps us find HTML markup or accessibility issues. +[Rocket Validator](https://rocketvalidator.com/) helps us find [HTML markup and accessibility issues](https://rocketvalidator.com/stats/docusaurus.io). diff --git a/admin/new.docusaurus.io/package.json b/admin/new.docusaurus.io/package.json index 4146fb0d03..b685dd0a8e 100644 --- a/admin/new.docusaurus.io/package.json +++ b/admin/new.docusaurus.io/package.json @@ -1,6 +1,6 @@ { "name": "new.docusaurus.io", - "version": "3.8.1", + "version": "3.9.2", "private": true, "scripts": { "start": "npx --package netlify-cli netlify dev" diff --git a/admin/test-bad-package/package.json b/admin/test-bad-package/package.json index 6b5043a5e9..9e4db408ec 100644 --- a/admin/test-bad-package/package.json +++ b/admin/test-bad-package/package.json @@ -1,6 +1,6 @@ { "name": "test-bad-package", - "version": "3.8.1", + "version": "3.9.2", "private": true, "dependencies": { "@mdx-js/react": "1.0.1", diff --git a/argos/package.json b/argos/package.json index da71275545..adb0bfe5bb 100644 --- a/argos/package.json +++ b/argos/package.json @@ -1,6 +1,6 @@ { "name": "argos", - "version": "3.8.1", + "version": "3.9.2", "description": "Argos visual diff tests", "license": "MIT", "private": true, diff --git a/crowdin-v2.yaml b/crowdin-v2.yaml index a055f2ebe8..08a78b4e76 100644 --- a/crowdin-v2.yaml +++ b/crowdin-v2.yaml @@ -20,6 +20,19 @@ languages_mapping: &languages_mapping two_letters_code: pt-BR: pt-BR +# Crowdin regularly update their MDX parser +# Unfortunately, their v2 parser is more "MDX compliant" and thus can't parse +# Docusaurus MDX files correctly due to our custom {#headingId} syntax. +# Adding this type param permits using their older v1.2 parser. +# Note: you can find the version of a file using browser DevTools +# The source file icons will have a class such as "file_type_mdx_v1_2" +# +# TODO fix our headingId syntax +# providing an explicit type is annoying and not future-proof +# there's a risk that when adding an image in /docs, it will be parsed as mdx +# and duplicating source file configs for various extensions is not great either +mdx_file_type: &mdx_file_type mdx_v1_2 + # # Files configuration # @@ -27,18 +40,33 @@ files: - source: /website/i18n/en/**/* translation: /website/i18n/%two_letters_code%/**/%original_file_name% languages_mapping: *languages_mapping + + - source: /website/docs/**/*.mdx + translation: /website/i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name% + languages_mapping: *languages_mapping + type: *mdx_file_type - source: /website/docs/**/* translation: /website/i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name% languages_mapping: *languages_mapping - - source: /website/community/**/* - translation: /website/i18n/%two_letters_code%/docusaurus-plugin-content-docs-community/current/**/%original_file_name% + ignore: [/**/*.mdx] + + - source: /website/versioned_docs/**/*.mdx + translation: /website/i18n/%two_letters_code%/docusaurus-plugin-content-docs/**/%original_file_name% languages_mapping: *languages_mapping + type: *mdx_file_type - source: /website/versioned_docs/**/* translation: /website/i18n/%two_letters_code%/docusaurus-plugin-content-docs/**/%original_file_name% languages_mapping: *languages_mapping + ignore: [/**/*.mdx] + + - source: /website/community/**/* + translation: /website/i18n/%two_letters_code%/docusaurus-plugin-content-docs-community/current/**/%original_file_name% + languages_mapping: *languages_mapping + - source: /website/blog/**/* translation: /website/i18n/%two_letters_code%/docusaurus-plugin-content-blog/**/%original_file_name% languages_mapping: *languages_mapping + - source: /website/src/pages/**/* translation: /website/i18n/%two_letters_code%/docusaurus-plugin-content-pages/**/%original_file_name% ignore: [/**/*.js, /**/*.jsx, /**/*.ts, /**/*.tsx, /**/*.css] diff --git a/examples/classic-typescript/docs/intro.md b/examples/classic-typescript/docs/intro.md index 45e8604c8b..88f9571445 100644 --- a/examples/classic-typescript/docs/intro.md +++ b/examples/classic-typescript/docs/intro.md @@ -14,7 +14,7 @@ Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new ### What you'll need -- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: +- [Node.js](https://nodejs.org/en/download/) version 20.0 or above: - When installing Node.js, you are recommended to check all checkboxes related to dependencies. ## Generate a new site diff --git a/examples/classic-typescript/docusaurus.config.ts b/examples/classic-typescript/docusaurus.config.ts index 95cb36ccd7..671bab5472 100644 --- a/examples/classic-typescript/docusaurus.config.ts +++ b/examples/classic-typescript/docusaurus.config.ts @@ -26,7 +26,6 @@ const config: Config = { projectName: 'docusaurus', // Usually your repo name. onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'warn', // Even if you don't use internationalization, you can use this field to set // useful metadata like html lang. For example, if your site is Chinese, you @@ -72,6 +71,9 @@ const config: Config = { themeConfig: { // Replace with your project's social card image: 'img/docusaurus-social-card.jpg', + colorMode: { + respectPrefersColorScheme: true, + }, navbar: { title: 'My Site', logo: { diff --git a/examples/classic-typescript/package.json b/examples/classic-typescript/package.json index 899d265071..5fbc024796 100644 --- a/examples/classic-typescript/package.json +++ b/examples/classic-typescript/package.json @@ -16,8 +16,8 @@ "dev": "docusaurus start" }, "dependencies": { - "@docusaurus/core": "3.8.0", - "@docusaurus/preset-classic": "3.8.0", + "@docusaurus/core": "3.9.2", + "@docusaurus/preset-classic": "3.9.2", "@mdx-js/react": "^3.0.0", "clsx": "^2.0.0", "prism-react-renderer": "^2.3.0", @@ -25,9 +25,9 @@ "react-dom": "^19.0.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.8.0", - "@docusaurus/tsconfig": "3.8.0", - "@docusaurus/types": "3.8.0", + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/tsconfig": "3.9.2", + "@docusaurus/types": "3.9.2", "typescript": "~5.6.2" }, "browserslist": { @@ -43,7 +43,7 @@ ] }, "engines": { - "node": ">=18.0" + "node": ">=20.0" }, "description": "Docusaurus example project (classic-typescript template)" } diff --git a/examples/classic-typescript/yarn.lock b/examples/classic-typescript/yarn.lock index 838d0a906f..d392b75ecf 100644 --- a/examples/classic-typescript/yarn.lock +++ b/examples/classic-typescript/yarn.lock @@ -2,161 +2,191 @@ # yarn lockfile v1 -"@algolia/autocomplete-core@1.17.9": - version "1.17.9" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.17.9.tgz#83374c47dc72482aa45d6b953e89377047f0dcdc" - integrity sha512-O7BxrpLDPJWWHv/DLA9DRFWs+iY1uOJZkqUwjS5HSZAGcl0hIVCQ97LTLewiZmZ402JYUrun+8NqFP+hCknlbQ== +"@ai-sdk/gateway@2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@ai-sdk/gateway/-/gateway-2.0.0.tgz#d291c40fa869174af5b7230bd838d1028488a6fd" + integrity sha512-Gj0PuawK7NkZuyYgO/h5kDK/l6hFOjhLdTq3/Lli1FTl47iGmwhH1IZQpAL3Z09BeFYWakcwUmn02ovIm2wy9g== dependencies: - "@algolia/autocomplete-plugin-algolia-insights" "1.17.9" - "@algolia/autocomplete-shared" "1.17.9" + "@ai-sdk/provider" "2.0.0" + "@ai-sdk/provider-utils" "3.0.12" + "@vercel/oidc" "3.0.3" -"@algolia/autocomplete-plugin-algolia-insights@1.17.9": - version "1.17.9" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.17.9.tgz#74c86024d09d09e8bfa3dd90b844b77d9f9947b6" - integrity sha512-u1fEHkCbWF92DBeB/KHeMacsjsoI0wFhjZtlCq2ddZbAehshbZST6Hs0Avkc0s+4UyBGbMDnSuXHLuvRWK5iDQ== +"@ai-sdk/provider-utils@3.0.12": + version "3.0.12" + resolved "https://registry.yarnpkg.com/@ai-sdk/provider-utils/-/provider-utils-3.0.12.tgz#9812a0b7ce36f2cae81dff3afe70f0c4bde76213" + integrity sha512-ZtbdvYxdMoria+2SlNarEk6Hlgyf+zzcznlD55EAl+7VZvJaSg2sqPvwArY7L6TfDEDJsnCq0fdhBSkYo0Xqdg== dependencies: - "@algolia/autocomplete-shared" "1.17.9" + "@ai-sdk/provider" "2.0.0" + "@standard-schema/spec" "^1.0.0" + eventsource-parser "^3.0.5" -"@algolia/autocomplete-preset-algolia@1.17.9": - version "1.17.9" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.17.9.tgz#911f3250544eb8ea4096fcfb268f156b085321b5" - integrity sha512-Na1OuceSJeg8j7ZWn5ssMu/Ax3amtOwk76u4h5J4eK2Nx2KB5qt0Z4cOapCsxot9VcEN11ADV5aUSlQF4RhGjQ== +"@ai-sdk/provider@2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@ai-sdk/provider/-/provider-2.0.0.tgz#b853c739d523b33675bc74b6c506b2c690bc602b" + integrity sha512-6o7Y2SeO9vFKB8lArHXehNuusnpddKPk7xqL7T2/b+OvXMRIXUO1rR4wcv1hAFUAT9avGZshty3Wlua/XA7TvA== dependencies: - "@algolia/autocomplete-shared" "1.17.9" + json-schema "^0.4.0" -"@algolia/autocomplete-shared@1.17.9": - version "1.17.9" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.17.9.tgz#5f38868f7cb1d54b014b17a10fc4f7e79d427fa8" - integrity sha512-iDf05JDQ7I0b7JEA/9IektxN/80a2MZ1ToohfmNS3rfeuQnIKI3IJlIafD0xu4StbtQTghx9T3Maa97ytkXenQ== - -"@algolia/client-abtesting@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/client-abtesting/-/client-abtesting-5.25.0.tgz#012204f1614e1a71366fb1e117c8f195186ff081" - integrity sha512-1pfQulNUYNf1Tk/svbfjfkLBS36zsuph6m+B6gDkPEivFmso/XnRgwDvjAx80WNtiHnmeNjIXdF7Gos8+OLHqQ== +"@ai-sdk/react@^2.0.30": + version "2.0.76" + resolved "https://registry.yarnpkg.com/@ai-sdk/react/-/react-2.0.76.tgz#eba2457f208d1762f16f807e1c4324cdf63bd969" + integrity sha512-ggAPzyaKJTqUWigpxMzI5DuC0Y3iEpDUPCgz6/6CpnKZY/iok+x5xiZhDemeaP0ILw5IQekV0kdgBR8JPgI8zQ== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@ai-sdk/provider-utils" "3.0.12" + ai "5.0.76" + swr "^2.2.5" + throttleit "2.1.0" -"@algolia/client-analytics@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/client-analytics/-/client-analytics-5.25.0.tgz#eba015bfafb3dbb82712c9160a00717a5974ff71" - integrity sha512-AFbG6VDJX/o2vDd9hqncj1B6B4Tulk61mY0pzTtzKClyTDlNP0xaUiEKhl6E7KO9I/x0FJF5tDCm0Hn6v5x18A== +"@algolia/abtesting@1.6.1": + version "1.6.1" + resolved "https://registry.yarnpkg.com/@algolia/abtesting/-/abtesting-1.6.1.tgz#1074f6df6a59b371f56fdb5ddc2caec1853bcc58" + integrity sha512-wV/gNRkzb7sI9vs1OneG129hwe3Q5zPj7zigz3Ps7M5Lpo2hSorrOnXNodHEOV+yXE/ks4Pd+G3CDFIjFTWhMQ== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" -"@algolia/client-common@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-5.25.0.tgz#2def8947efe849266057d92f67d1b8d83de0c005" - integrity sha512-il1zS/+Rc6la6RaCdSZ2YbJnkQC6W1wiBO8+SH+DE6CPMWBU6iDVzH0sCKSAtMWl9WBxoN6MhNjGBnCv9Yy2bA== - -"@algolia/client-insights@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/client-insights/-/client-insights-5.25.0.tgz#b87df8614b96c4cc9c9aa7765cce07fa70864fa8" - integrity sha512-blbjrUH1siZNfyCGeq0iLQu00w3a4fBXm0WRIM0V8alcAPo7rWjLbMJMrfBtzL9X5ic6wgxVpDADXduGtdrnkw== +"@algolia/autocomplete-core@1.19.2": + version "1.19.2" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.19.2.tgz#702df67a08cb3cfe8c33ee1111ef136ec1a9e232" + integrity sha512-mKv7RyuAzXvwmq+0XRK8HqZXt9iZ5Kkm2huLjgn5JoCPtDy+oh9yxUMfDDaVCw0oyzZ1isdJBc7l9nuCyyR7Nw== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/autocomplete-plugin-algolia-insights" "1.19.2" + "@algolia/autocomplete-shared" "1.19.2" -"@algolia/client-personalization@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-5.25.0.tgz#74b041f0e7d91e1009c131c8d716c34e4d45c30f" - integrity sha512-aywoEuu1NxChBcHZ1pWaat0Plw7A8jDMwjgRJ00Mcl7wGlwuPt5dJ/LTNcg3McsEUbs2MBNmw0ignXBw9Tbgow== +"@algolia/autocomplete-plugin-algolia-insights@1.19.2": + version "1.19.2" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.19.2.tgz#3584b625b9317e333d1ae43664d02358e175c52d" + integrity sha512-TjxbcC/r4vwmnZaPwrHtkXNeqvlpdyR+oR9Wi2XyfORkiGkLTVhX2j+O9SaCCINbKoDfc+c2PB8NjfOnz7+oKg== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/autocomplete-shared" "1.19.2" -"@algolia/client-query-suggestions@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/client-query-suggestions/-/client-query-suggestions-5.25.0.tgz#e92d935d9e2994f790d43c64d3518d81070a3888" - integrity sha512-a/W2z6XWKjKjIW1QQQV8PTTj1TXtaKx79uR3NGBdBdGvVdt24KzGAaN7sCr5oP8DW4D3cJt44wp2OY/fZcPAVA== - dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" +"@algolia/autocomplete-shared@1.19.2": + version "1.19.2" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.19.2.tgz#c0b7b8dc30a5c65b70501640e62b009535e4578f" + integrity sha512-jEazxZTVD2nLrC+wYlVHQgpBoBB5KPStrJxLzsIFl6Kqd1AlG9sIAGl39V5tECLpIQzB3Qa2T6ZPJ1ChkwMK/w== -"@algolia/client-search@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-5.25.0.tgz#dc38ca1015f2f4c9f5053a4517f96fb28a2117f8" - integrity sha512-9rUYcMIBOrCtYiLX49djyzxqdK9Dya/6Z/8sebPn94BekT+KLOpaZCuc6s0Fpfq7nx5J6YY5LIVFQrtioK9u0g== +"@algolia/client-abtesting@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/client-abtesting/-/client-abtesting-5.40.1.tgz#6674c20731e887a081edf7ea009fe00ce20537d4" + integrity sha512-cxKNATPY5t+Mv8XAVTI57altkaPH+DZi4uMrnexPxPHODMljhGYY+GDZyHwv9a+8CbZHcY372OkxXrDMZA4Lnw== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" + +"@algolia/client-analytics@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/client-analytics/-/client-analytics-5.40.1.tgz#6550da491a59e9bc5112d9aeb1964e04b34543c5" + integrity sha512-XP008aMffJCRGAY8/70t+hyEyvqqV7YKm502VPu0+Ji30oefrTn2al7LXkITz7CK6I4eYXWRhN6NaIUi65F1OA== + dependencies: + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" + +"@algolia/client-common@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-5.40.1.tgz#df272c1eb491e7e4b15eaa44e4ad781630b4a438" + integrity sha512-gWfQuQUBtzUboJv/apVGZMoxSaB0M4Imwl1c9Ap+HpCW7V0KhjBddqF2QQt5tJZCOFsfNIgBbZDGsEPaeKUosw== + +"@algolia/client-insights@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/client-insights/-/client-insights-5.40.1.tgz#db53a74d78b004b176213dfe84cb250323e64906" + integrity sha512-RTLjST/t+lsLMouQ4zeLJq2Ss+UNkLGyNVu+yWHanx6kQ3LT5jv8UvPwyht9s7R6jCPnlSI77WnL80J32ZuyJg== + dependencies: + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" + +"@algolia/client-personalization@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-5.40.1.tgz#9e9885a1855b893ddb3cefa484d5d08158b622f5" + integrity sha512-2FEK6bUomBzEYkTKzD0iRs7Ljtjb45rKK/VSkyHqeJnG+77qx557IeSO0qVFE3SfzapNcoytTofnZum0BQ6r3Q== + dependencies: + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" + +"@algolia/client-query-suggestions@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/client-query-suggestions/-/client-query-suggestions-5.40.1.tgz#45dd6d7ad53f87043d44ffe983ab2d2385c8270a" + integrity sha512-Nju4NtxAvXjrV2hHZNLKVJLXjOlW6jAXHef/CwNzk1b2qIrCWDO589ELi5ZHH1uiWYoYyBXDQTtHmhaOVVoyXg== + dependencies: + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" + +"@algolia/client-search@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-5.40.1.tgz#9e179ac583dd9ddf638139e24971bb9229897931" + integrity sha512-Mw6pAUF121MfngQtcUb5quZVqMC68pSYYjCRZkSITC085S3zdk+h/g7i6FxnVdbSU6OztxikSDMh1r7Z+4iPlA== + dependencies: + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" "@algolia/events@^4.0.1": version "4.0.1" resolved "https://registry.yarnpkg.com/@algolia/events/-/events-4.0.1.tgz#fd39e7477e7bc703d7f893b556f676c032af3950" integrity sha512-FQzvOCgoFXAbf5Y6mYozw2aj5KCJoA3m4heImceldzPSMbdyS4atVjJzXKMsfX3wnZTFYwkkt8/z8UesLHlSBQ== -"@algolia/ingestion@1.25.0": - version "1.25.0" - resolved "https://registry.yarnpkg.com/@algolia/ingestion/-/ingestion-1.25.0.tgz#4d13c56dda0a05c7bacb0e3ef5866292dfd86ed5" - integrity sha512-jJeH/Hk+k17Vkokf02lkfYE4A+EJX+UgnMhTLR/Mb+d1ya5WhE+po8p5a/Nxb6lo9OLCRl6w3Hmk1TX1e9gVbQ== +"@algolia/ingestion@1.40.1": + version "1.40.1" + resolved "https://registry.yarnpkg.com/@algolia/ingestion/-/ingestion-1.40.1.tgz#eea0793d6e89b424d742d726de7419f5bcaefa16" + integrity sha512-z+BPlhs45VURKJIxsR99NNBWpUEEqIgwt10v/fATlNxc4UlXvALdOsWzaFfe89/lbP5Bu4+mbO59nqBC87ZM/g== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" -"@algolia/monitoring@1.25.0": - version "1.25.0" - resolved "https://registry.yarnpkg.com/@algolia/monitoring/-/monitoring-1.25.0.tgz#d59360cfe556338519d05a9d8107147e9dbcb020" - integrity sha512-Ls3i1AehJ0C6xaHe7kK9vPmzImOn5zBg7Kzj8tRYIcmCWVyuuFwCIsbuIIz/qzUf1FPSWmw0TZrGeTumk2fqXg== +"@algolia/monitoring@1.40.1": + version "1.40.1" + resolved "https://registry.yarnpkg.com/@algolia/monitoring/-/monitoring-1.40.1.tgz#50bf7286f3ba0fae220d7f5e0bf73c1b671f8958" + integrity sha512-VJMUMbO0wD8Rd2VVV/nlFtLJsOAQvjnVNGkMkspFiFhpBA7s/xJOb+fJvvqwKFUjbKTUA7DjiSi1ljSMYBasXg== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" -"@algolia/recommend@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/recommend/-/recommend-5.25.0.tgz#b96f12c85aa74a0326982c7801fcd4a610b420f4" - integrity sha512-79sMdHpiRLXVxSjgw7Pt4R1aNUHxFLHiaTDnN2MQjHwJ1+o3wSseb55T9VXU4kqy3m7TUme3pyRhLk5ip/S4Mw== +"@algolia/recommend@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/recommend/-/recommend-5.40.1.tgz#db8395ce0d17ccba03a877b42dce1f205bbdf5b9" + integrity sha512-ehvJLadKVwTp9Scg9NfzVSlBKH34KoWOQNTaN8i1Ac64AnO6iH2apJVSP6GOxssaghZ/s8mFQsDH3QIZoluFHA== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" -"@algolia/requester-browser-xhr@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.25.0.tgz#c194fa5f49206b9343e6646c41bfbca2a3f2ac54" - integrity sha512-JLaF23p1SOPBmfEqozUAgKHQrGl3z/Z5RHbggBu6s07QqXXcazEsub5VLonCxGVqTv6a61AAPr8J1G5HgGGjEw== +"@algolia/requester-browser-xhr@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.40.1.tgz#cddc52f7dc8e4b4a1051f90e55336d9573df62af" + integrity sha512-PbidVsPurUSQIr6X9/7s34mgOMdJnn0i6p+N6Ab+lsNhY5eiu+S33kZEpZwkITYBCIbhzDLOvb7xZD3gDi+USA== dependencies: - "@algolia/client-common" "5.25.0" + "@algolia/client-common" "5.40.1" -"@algolia/requester-fetch@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/requester-fetch/-/requester-fetch-5.25.0.tgz#231a2d0da2397d141f80b8f28e2cb6e3d219d38d" - integrity sha512-rtzXwqzFi1edkOF6sXxq+HhmRKDy7tz84u0o5t1fXwz0cwx+cjpmxu/6OQKTdOJFS92JUYHsG51Iunie7xbqfQ== +"@algolia/requester-fetch@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/requester-fetch/-/requester-fetch-5.40.1.tgz#3ec36412f7d10f4270a59e456d8e71a2eda58ea8" + integrity sha512-ThZ5j6uOZCF11fMw9IBkhigjOYdXGXQpj6h4k+T9UkZrF2RlKcPynFzDeRgaLdpYk8Yn3/MnFbwUmib7yxj5Lw== dependencies: - "@algolia/client-common" "5.25.0" + "@algolia/client-common" "5.40.1" -"@algolia/requester-node-http@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/requester-node-http/-/requester-node-http-5.25.0.tgz#0ce13c550890de21c558b04381535d2d245a3725" - integrity sha512-ZO0UKvDyEFvyeJQX0gmZDQEvhLZ2X10K+ps6hViMo1HgE2V8em00SwNsQ+7E/52a+YiBkVWX61pJJJE44juDMQ== +"@algolia/requester-node-http@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/requester-node-http/-/requester-node-http-5.40.1.tgz#ed3a9b1846f7d6be88839522ca0d337159d5ff66" + integrity sha512-H1gYPojO6krWHnUXu/T44DrEun/Wl95PJzMXRcM/szstNQczSbwq6wIFJPI9nyE95tarZfUNU3rgorT+wZ6iCQ== dependencies: - "@algolia/client-common" "5.25.0" - -"@ampproject/remapping@^2.2.0": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@ampproject/remapping/-/remapping-2.3.0.tgz#ed441b6fa600072520ce18b43d2c8cc8caecc7f4" - integrity sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw== - dependencies: - "@jridgewell/gen-mapping" "^0.3.5" - "@jridgewell/trace-mapping" "^0.3.24" + "@algolia/client-common" "5.40.1" "@babel/code-frame@^7.0.0", "@babel/code-frame@^7.27.1": version "7.27.1" @@ -167,51 +197,51 @@ js-tokens "^4.0.0" picocolors "^1.1.1" -"@babel/compat-data@^7.22.6", "@babel/compat-data@^7.27.2": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.27.3.tgz#cc49c2ac222d69b889bf34c795f537c0c6311111" - integrity sha512-V42wFfx1ymFte+ecf6iXghnnP8kWTO+ZLXIyZq+1LAXHHvTZdVxicn4yiVYdYMGaCO3tmqub11AorKkv+iodqw== +"@babel/compat-data@^7.27.2", "@babel/compat-data@^7.27.7", "@babel/compat-data@^7.28.0": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.28.4.tgz#96fdf1af1b8859c8474ab39c295312bfb7c24b04" + integrity sha512-YsmSKC29MJwf0gF8Rjjrg5LQCmyh+j/nD8/eP7f+BeoQTKYqs9RoWbjGOdy0+1Ekr68RJZMUOPVQaQisnIo4Rw== "@babel/core@^7.21.3", "@babel/core@^7.25.9": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.27.3.tgz#d7d05502bccede3cab36373ed142e6a1df554c2f" - integrity sha512-hyrN8ivxfvJ4i0fIJuV4EOlV0WDMz5Ui4StRTgVaAvWeiRCilXgwVvxJKtFQ3TKtHgJscB2YiXKGNJuVwhQMtA== + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.28.4.tgz#12a550b8794452df4c8b084f95003bce1742d496" + integrity sha512-2BCOP7TN8M+gVDj7/ht3hsaO/B/n5oDbiAyyvnRlNOs+u1o+JWNYTQrmpuNp1/Wq2gcFrI01JAW+paEKDMx/CA== dependencies: - "@ampproject/remapping" "^2.2.0" "@babel/code-frame" "^7.27.1" - "@babel/generator" "^7.27.3" + "@babel/generator" "^7.28.3" "@babel/helper-compilation-targets" "^7.27.2" - "@babel/helper-module-transforms" "^7.27.3" - "@babel/helpers" "^7.27.3" - "@babel/parser" "^7.27.3" + "@babel/helper-module-transforms" "^7.28.3" + "@babel/helpers" "^7.28.4" + "@babel/parser" "^7.28.4" "@babel/template" "^7.27.2" - "@babel/traverse" "^7.27.3" - "@babel/types" "^7.27.3" + "@babel/traverse" "^7.28.4" + "@babel/types" "^7.28.4" + "@jridgewell/remapping" "^2.3.5" convert-source-map "^2.0.0" debug "^4.1.0" gensync "^1.0.0-beta.2" json5 "^2.2.3" semver "^6.3.1" -"@babel/generator@^7.25.9", "@babel/generator@^7.27.3": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.27.3.tgz#ef1c0f7cfe3b5fc8cbb9f6cc69f93441a68edefc" - integrity sha512-xnlJYj5zepml8NXtjkG0WquFUv8RskFqyFcVgTBp5k+NaA/8uw/K+OSVf8AMGw5e9HKP2ETd5xpK5MLZQD6b4Q== +"@babel/generator@^7.25.9", "@babel/generator@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.28.3.tgz#9626c1741c650cbac39121694a0f2d7451b8ef3e" + integrity sha512-3lSpxGgvnmZznmBkCRnVREPUFJv2wrv9iAoFDvADJc0ypmdOxdUtcLeBgBJ6zE0PMeTKnxeQzyk0xTBq4Ep7zw== dependencies: - "@babel/parser" "^7.27.3" - "@babel/types" "^7.27.3" - "@jridgewell/gen-mapping" "^0.3.5" - "@jridgewell/trace-mapping" "^0.3.25" + "@babel/parser" "^7.28.3" + "@babel/types" "^7.28.2" + "@jridgewell/gen-mapping" "^0.3.12" + "@jridgewell/trace-mapping" "^0.3.28" jsesc "^3.0.2" -"@babel/helper-annotate-as-pure@^7.27.1": +"@babel/helper-annotate-as-pure@^7.27.1", "@babel/helper-annotate-as-pure@^7.27.3": version "7.27.3" resolved "https://registry.yarnpkg.com/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.27.3.tgz#f31fd86b915fc4daf1f3ac6976c59be7084ed9c5" integrity sha512-fXSwMQqitTGeHLBC08Eq5yXz2m37E4pJX1qAU1+2cNedz/ifv/bVXft90VeSav5nFO61EcNgwr0aJxbyPaWBPg== dependencies: "@babel/types" "^7.27.3" -"@babel/helper-compilation-targets@^7.22.6", "@babel/helper-compilation-targets@^7.27.1", "@babel/helper-compilation-targets@^7.27.2": +"@babel/helper-compilation-targets@^7.27.1", "@babel/helper-compilation-targets@^7.27.2": version "7.27.2" resolved "https://registry.yarnpkg.com/@babel/helper-compilation-targets/-/helper-compilation-targets-7.27.2.tgz#46a0f6efab808d51d29ce96858dd10ce8732733d" integrity sha512-2+1thGUUWWjLTYTHZWK1n8Yga0ijBz1XAhUXcKy81rd5g6yh7hGqMp45v7cadSbEHc9G3OTv45SyneRN3ps4DQ== @@ -222,17 +252,17 @@ lru-cache "^5.1.1" semver "^6.3.1" -"@babel/helper-create-class-features-plugin@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.27.1.tgz#5bee4262a6ea5ddc852d0806199eb17ca3de9281" - integrity sha512-QwGAmuvM17btKU5VqXfb+Giw4JcN0hjuufz3DYnpeVDvZLAObloM77bhMXiqry3Iio+Ai4phVRDwl6WU10+r5A== +"@babel/helper-create-class-features-plugin@^7.27.1", "@babel/helper-create-class-features-plugin@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.28.3.tgz#3e747434ea007910c320c4d39a6b46f20f371d46" + integrity sha512-V9f6ZFIYSLNEbuGA/92uOvYsGCJNsuA8ESZ4ldc09bWk/j8H8TKiPw8Mk1eG6olpnO0ALHJmYfZvF4MEE4gajg== dependencies: - "@babel/helper-annotate-as-pure" "^7.27.1" + "@babel/helper-annotate-as-pure" "^7.27.3" "@babel/helper-member-expression-to-functions" "^7.27.1" "@babel/helper-optimise-call-expression" "^7.27.1" "@babel/helper-replace-supers" "^7.27.1" "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" - "@babel/traverse" "^7.27.1" + "@babel/traverse" "^7.28.3" semver "^6.3.1" "@babel/helper-create-regexp-features-plugin@^7.18.6", "@babel/helper-create-regexp-features-plugin@^7.27.1": @@ -244,16 +274,21 @@ regexpu-core "^6.2.0" semver "^6.3.1" -"@babel/helper-define-polyfill-provider@^0.6.3", "@babel/helper-define-polyfill-provider@^0.6.4": - version "0.6.4" - resolved "https://registry.yarnpkg.com/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.4.tgz#15e8746368bfa671785f5926ff74b3064c291fab" - integrity sha512-jljfR1rGnXXNWnmQg2K3+bvhkxB51Rl32QRaOTuwwjviGrHzIbSc8+x9CpraDtbT7mfyjXObULP4w/adunNwAw== +"@babel/helper-define-polyfill-provider@^0.6.5": + version "0.6.5" + resolved "https://registry.yarnpkg.com/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.5.tgz#742ccf1cb003c07b48859fc9fa2c1bbe40e5f753" + integrity sha512-uJnGFcPsWQK8fvjgGP5LZUZZsYGIoPeRjSF5PGwrelYgq7Q15/Ft9NGFp1zglwgIv//W0uG4BevRuSJRyylZPg== dependencies: - "@babel/helper-compilation-targets" "^7.22.6" - "@babel/helper-plugin-utils" "^7.22.5" - debug "^4.1.1" + "@babel/helper-compilation-targets" "^7.27.2" + "@babel/helper-plugin-utils" "^7.27.1" + debug "^4.4.1" lodash.debounce "^4.0.8" - resolve "^1.14.2" + resolve "^1.22.10" + +"@babel/helper-globals@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/helper-globals/-/helper-globals-7.28.0.tgz#b9430df2aa4e17bc28665eadeae8aa1d985e6674" + integrity sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw== "@babel/helper-member-expression-to-functions@^7.27.1": version "7.27.1" @@ -271,14 +306,14 @@ "@babel/traverse" "^7.27.1" "@babel/types" "^7.27.1" -"@babel/helper-module-transforms@^7.27.1", "@babel/helper-module-transforms@^7.27.3": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.27.3.tgz#db0bbcfba5802f9ef7870705a7ef8788508ede02" - integrity sha512-dSOvYwvyLsWBeIRyOeHXp5vPj5l1I011r52FM1+r1jCERv+aFXYk4whgQccYEGYxK2H3ZAIA8nuPkQ0HaUo3qg== +"@babel/helper-module-transforms@^7.27.1", "@babel/helper-module-transforms@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.28.3.tgz#a2b37d3da3b2344fe085dab234426f2b9a2fa5f6" + integrity sha512-gytXUbs8k2sXS9PnQptz5o0QnpLL51SwASIORY6XaBKF88nsOT0Zw9szLqlSGQDP/4TljBAD5y98p2U1fqkdsw== dependencies: "@babel/helper-module-imports" "^7.27.1" "@babel/helper-validator-identifier" "^7.27.1" - "@babel/traverse" "^7.27.3" + "@babel/traverse" "^7.28.3" "@babel/helper-optimise-call-expression@^7.27.1": version "7.27.1" @@ -287,7 +322,7 @@ dependencies: "@babel/types" "^7.27.1" -"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.18.6", "@babel/helper-plugin-utils@^7.22.5", "@babel/helper-plugin-utils@^7.27.1", "@babel/helper-plugin-utils@^7.8.0": +"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.18.6", "@babel/helper-plugin-utils@^7.27.1", "@babel/helper-plugin-utils@^7.8.0": version "7.27.1" resolved "https://registry.yarnpkg.com/@babel/helper-plugin-utils/-/helper-plugin-utils-7.27.1.tgz#ddb2f876534ff8013e6c2b299bf4d39b3c51d44c" integrity sha512-1gn1Up5YXka3YYAHGKpbideQ5Yjf1tDa9qYcgysz+cNCXukyLl6DjPXhD3VRwSb8c0J9tA4b2+rHEZtc6R0tlw== @@ -334,28 +369,28 @@ integrity sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg== "@babel/helper-wrap-function@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/helper-wrap-function/-/helper-wrap-function-7.27.1.tgz#b88285009c31427af318d4fe37651cd62a142409" - integrity sha512-NFJK2sHUvrjo8wAU/nQTWU890/zB2jj0qBcCbZbbf+005cAsv6tMjXz31fBign6M5ov1o0Bllu+9nbqkfsjjJQ== - dependencies: - "@babel/template" "^7.27.1" - "@babel/traverse" "^7.27.1" - "@babel/types" "^7.27.1" - -"@babel/helpers@^7.27.3": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.27.3.tgz#387d65d279290e22fe7a47a8ffcd2d0c0184edd0" - integrity sha512-h/eKy9agOya1IGuLaZ9tEUgz+uIRXcbtOhRtUyyMf8JFmn1iT13vnl/IGVWSkdOCG/pC57U4S1jnAabAavTMwg== + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helper-wrap-function/-/helper-wrap-function-7.28.3.tgz#fe4872092bc1438ffd0ce579e6f699609f9d0a7a" + integrity sha512-zdf983tNfLZFletc0RRXYrHrucBEg95NIFMkn6K9dbeMYnsgHaSBGcQqdsCSStG2PYwRre0Qc2NNSCXbG+xc6g== dependencies: "@babel/template" "^7.27.2" - "@babel/types" "^7.27.3" + "@babel/traverse" "^7.28.3" + "@babel/types" "^7.28.2" -"@babel/parser@^7.27.2", "@babel/parser@^7.27.3": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.27.3.tgz#1b7533f0d908ad2ac545c4d05cbe2fb6dc8cfaaf" - integrity sha512-xyYxRj6+tLNDTWi0KCBcZ9V7yg3/lwL9DWh9Uwh/RIVlIfFidggcgxKX3GCXwCiswwcGRawBKbEg2LG/Y8eJhw== +"@babel/helpers@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.28.4.tgz#fe07274742e95bdf7cf1443593eeb8926ab63827" + integrity sha512-HFN59MmQXGHVyYadKLVumYsA9dBFun/ldYxipEjzA4196jpLZd8UjEEBLkbEkvfYreDqJhZxYAWFPtrfhNpj4w== dependencies: - "@babel/types" "^7.27.3" + "@babel/template" "^7.27.2" + "@babel/types" "^7.28.4" + +"@babel/parser@^7.27.2", "@babel/parser@^7.28.3", "@babel/parser@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.28.4.tgz#da25d4643532890932cc03f7705fe19637e03fa8" + integrity sha512-yZbBqeM6TkpP9du/I2pUZnJsRMGGvOuIrhjzC1AwHwW+6he4mni6Bp/m8ijn0iOuZuPI2BfkCoSRunpyjnrQKg== + dependencies: + "@babel/types" "^7.28.4" "@babel/plugin-bugfix-firefox-class-in-computed-class-key@^7.27.1": version "7.27.1" @@ -388,13 +423,13 @@ "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" "@babel/plugin-transform-optional-chaining" "^7.27.1" -"@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.27.1.tgz#bb1c25af34d75115ce229a1de7fa44bf8f955670" - integrity sha512-6BpaYGDavZqkI6yT+KSPdpZFfpnd68UKXbcjI9pJ13pvHhPrCKWOOLp+ysvMeA+DxnhuPpgIaRpxRxo5A9t5jw== +"@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.28.3.tgz#373f6e2de0016f73caf8f27004f61d167743742a" + integrity sha512-b6YTX108evsvE4YgWyQ921ZAFFQm3Bn+CA3+ZXlNVnPhx+UfsVURoPjfGAPCjBgrqo30yX/C2nZGX96DxvR9Iw== dependencies: "@babel/helper-plugin-utils" "^7.27.1" - "@babel/traverse" "^7.27.1" + "@babel/traverse" "^7.28.3" "@babel/plugin-proposal-private-property-in-object@7.21.0-placeholder-for-preset-env.2": version "7.21.0-placeholder-for-preset-env.2" @@ -451,14 +486,14 @@ dependencies: "@babel/helper-plugin-utils" "^7.27.1" -"@babel/plugin-transform-async-generator-functions@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.27.1.tgz#ca433df983d68e1375398e7ca71bf2a4f6fd89d7" - integrity sha512-eST9RrwlpaoJBDHShc+DS2SG4ATTi2MYNb4OxYkf3n+7eb49LWpnS+HSpVfW4x927qQwgk8A2hGNVaajAEw0EA== +"@babel/plugin-transform-async-generator-functions@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.28.0.tgz#1276e6c7285ab2cd1eccb0bc7356b7a69ff842c2" + integrity sha512-BEOdvX4+M765icNPZeidyADIvQ1m1gmunXufXxvRESy/jNNyfovIqUyE7MVgGBjWktCoJlzvFA1To2O4ymIO3Q== dependencies: "@babel/helper-plugin-utils" "^7.27.1" "@babel/helper-remap-async-to-generator" "^7.27.1" - "@babel/traverse" "^7.27.1" + "@babel/traverse" "^7.28.0" "@babel/plugin-transform-async-to-generator@^7.27.1": version "7.27.1" @@ -476,10 +511,10 @@ dependencies: "@babel/helper-plugin-utils" "^7.27.1" -"@babel/plugin-transform-block-scoping@^7.27.1": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.27.3.tgz#a21f37e222dc0a7b91c3784fa3bd4edf8d7a6dc1" - integrity sha512-+F8CnfhuLhwUACIJMLWnjz6zvzYM2r0yeIHKlbgfw7ml8rOMJsXNXV/hyRcb3nb493gRs4WvYpQAndWj/qQmkQ== +"@babel/plugin-transform-block-scoping@^7.28.0": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.28.4.tgz#e19ac4ddb8b7858bac1fd5c1be98a994d9726410" + integrity sha512-1yxmvN0MJHOhPVmAsmoW5liWwoILobu/d/ShymZmj867bAdxGbehIrew1DuLpw2Ukv+qDSSPQdYW1dLNE7t11A== dependencies: "@babel/helper-plugin-utils" "^7.27.1" @@ -491,25 +526,25 @@ "@babel/helper-create-class-features-plugin" "^7.27.1" "@babel/helper-plugin-utils" "^7.27.1" -"@babel/plugin-transform-class-static-block@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.27.1.tgz#7e920d5625b25bbccd3061aefbcc05805ed56ce4" - integrity sha512-s734HmYU78MVzZ++joYM+NkJusItbdRcbm+AGRgJCt3iA+yux0QpD9cBVdz3tKyrjVYWRl7j0mHSmv4lhV0aoA== +"@babel/plugin-transform-class-static-block@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.28.3.tgz#d1b8e69b54c9993bc558203e1f49bfc979bfd852" + integrity sha512-LtPXlBbRoc4Njl/oh1CeD/3jC+atytbnf/UqLoqTDcEYGUPj022+rvfkbDYieUrSj3CaV4yHDByPE+T2HwfsJg== dependencies: - "@babel/helper-create-class-features-plugin" "^7.27.1" + "@babel/helper-create-class-features-plugin" "^7.28.3" "@babel/helper-plugin-utils" "^7.27.1" -"@babel/plugin-transform-classes@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-classes/-/plugin-transform-classes-7.27.1.tgz#03bb04bea2c7b2f711f0db7304a8da46a85cced4" - integrity sha512-7iLhfFAubmpeJe/Wo2TVuDrykh/zlWXLzPNdL0Jqn/Xu8R3QQ8h9ff8FQoISZOsw74/HFqFI7NX63HN7QFIHKA== +"@babel/plugin-transform-classes@^7.28.3": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-classes/-/plugin-transform-classes-7.28.4.tgz#75d66175486788c56728a73424d67cbc7473495c" + integrity sha512-cFOlhIYPBv/iBoc+KS3M6et2XPtbT2HiCRfBXWtfpc9OAyostldxIf9YAYB6ypURBBbx+Qv6nyrLzASfJe+hBA== dependencies: - "@babel/helper-annotate-as-pure" "^7.27.1" - "@babel/helper-compilation-targets" "^7.27.1" + "@babel/helper-annotate-as-pure" "^7.27.3" + "@babel/helper-compilation-targets" "^7.27.2" + "@babel/helper-globals" "^7.28.0" "@babel/helper-plugin-utils" "^7.27.1" "@babel/helper-replace-supers" "^7.27.1" - "@babel/traverse" "^7.27.1" - globals "^11.1.0" + "@babel/traverse" "^7.28.4" "@babel/plugin-transform-computed-properties@^7.27.1": version "7.27.1" @@ -519,12 +554,13 @@ "@babel/helper-plugin-utils" "^7.27.1" "@babel/template" "^7.27.1" -"@babel/plugin-transform-destructuring@^7.27.1", "@babel/plugin-transform-destructuring@^7.27.3": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.27.3.tgz#3cc8299ed798d9a909f8d66ddeb40849ec32e3b0" - integrity sha512-s4Jrok82JpiaIprtY2nHsYmrThKvvwgHwjgd7UMiYhZaN0asdXNLr0y+NjTfkA7SyQE5i2Fb7eawUOZmLvyqOA== +"@babel/plugin-transform-destructuring@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.28.0.tgz#0f156588f69c596089b7d5b06f5af83d9aa7f97a" + integrity sha512-v1nrSMBiKcodhsyJ4Gf+Z0U/yawmJDBOTpEB3mcQY52r9RIyPneGyAS/yM6seP/8I+mWI3elOMtT5dB8GJVs+A== dependencies: "@babel/helper-plugin-utils" "^7.27.1" + "@babel/traverse" "^7.28.0" "@babel/plugin-transform-dotall-regex@^7.27.1": version "7.27.1" @@ -556,6 +592,14 @@ dependencies: "@babel/helper-plugin-utils" "^7.27.1" +"@babel/plugin-transform-explicit-resource-management@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-explicit-resource-management/-/plugin-transform-explicit-resource-management-7.28.0.tgz#45be6211b778dbf4b9d54c4e8a2b42fa72e09a1a" + integrity sha512-K8nhUcn3f6iB+P3gwCv/no7OdzOZQcKchW6N389V6PD8NUWKZHzndOd9sPDVbMoBsbmjMqlB4L9fm+fEFNVlwQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/plugin-transform-destructuring" "^7.28.0" + "@babel/plugin-transform-exponentiation-operator@^7.27.1": version "7.27.1" resolved "https://registry.yarnpkg.com/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.27.1.tgz#fc497b12d8277e559747f5a3ed868dd8064f83e1" @@ -678,15 +722,16 @@ dependencies: "@babel/helper-plugin-utils" "^7.27.1" -"@babel/plugin-transform-object-rest-spread@^7.27.2": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.27.3.tgz#ce130aa73fef828bc3e3e835f9bc6144be3eb1c0" - integrity sha512-7ZZtznF9g4l2JCImCo5LNKFHB5eXnN39lLtLY5Tg+VkR0jwOt7TBciMckuiQIOIW7L5tkQOCh3bVGYeXgMx52Q== +"@babel/plugin-transform-object-rest-spread@^7.28.0": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.28.4.tgz#9ee1ceca80b3e6c4bac9247b2149e36958f7f98d" + integrity sha512-373KA2HQzKhQCYiRVIRr+3MjpCObqzDlyrM6u4I201wL8Mp2wHf7uB8GhDwis03k2ti8Zr65Zyyqs1xOxUF/Ew== dependencies: "@babel/helper-compilation-targets" "^7.27.2" "@babel/helper-plugin-utils" "^7.27.1" - "@babel/plugin-transform-destructuring" "^7.27.3" - "@babel/plugin-transform-parameters" "^7.27.1" + "@babel/plugin-transform-destructuring" "^7.28.0" + "@babel/plugin-transform-parameters" "^7.27.7" + "@babel/traverse" "^7.28.4" "@babel/plugin-transform-object-super@^7.27.1": version "7.27.1" @@ -711,10 +756,10 @@ "@babel/helper-plugin-utils" "^7.27.1" "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" -"@babel/plugin-transform-parameters@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.27.1.tgz#80334b54b9b1ac5244155a0c8304a187a618d5a7" - integrity sha512-018KRk76HWKeZ5l4oTj2zPpSh+NbGdt0st5S6x0pga6HgrjBOJb24mMDHorFopOOd6YHkLgOZ+zaCjZGPO4aKg== +"@babel/plugin-transform-parameters@^7.27.7": + version "7.27.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.27.7.tgz#1fd2febb7c74e7d21cf3b05f7aebc907940af53a" + integrity sha512-qBkYTYCb76RRxUM6CcZA5KRu8K4SM8ajzVeUgVdMVO9NN9uI/GaVmBg/WKJJGnNokV9SY8FxNOVWGXzqzUidBg== dependencies: "@babel/helper-plugin-utils" "^7.27.1" @@ -750,9 +795,9 @@ "@babel/helper-plugin-utils" "^7.27.1" "@babel/plugin-transform-react-display-name@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-display-name/-/plugin-transform-react-display-name-7.27.1.tgz#43af31362d71f7848cfac0cbc212882b1a16e80f" - integrity sha512-p9+Vl3yuHPmkirRrg021XiP+EETmPMQTLr6Ayjj85RLNEbb3Eya/4VI0vAdzQG9SEAl2Lnt7fy5lZyMzjYoZQQ== + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-display-name/-/plugin-transform-react-display-name-7.28.0.tgz#6f20a7295fea7df42eb42fed8f896813f5b934de" + integrity sha512-D6Eujc2zMxKjfa4Zxl4GHMsmhKKZ9VpcqIchJLvwTxad9zWIYulwYItBovpDOoNLISpcZSXoDJ5gaGbQUDqViA== dependencies: "@babel/helper-plugin-utils" "^7.27.1" @@ -782,10 +827,10 @@ "@babel/helper-annotate-as-pure" "^7.27.1" "@babel/helper-plugin-utils" "^7.27.1" -"@babel/plugin-transform-regenerator@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.27.1.tgz#0a471df9213416e44cd66bf67176b66f65768401" - integrity sha512-B19lbbL7PMrKr52BNPjCqg1IyNUIjTcxKj8uX9zHO+PmWN93s19NDr/f69mIkEp2x9nmDJ08a7lgHaTTzvW7mw== +"@babel/plugin-transform-regenerator@^7.28.3": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.28.4.tgz#9d3fa3bebb48ddd0091ce5729139cd99c67cea51" + integrity sha512-+ZEdQlBoRg9m2NnzvEeLgtvBMO4tkFBw5SQIUgLICgTrumLoU7lr+Oghi6km2PFj+dbUt2u1oby2w3BDO9YQnA== dependencies: "@babel/helper-plugin-utils" "^7.27.1" @@ -805,15 +850,15 @@ "@babel/helper-plugin-utils" "^7.27.1" "@babel/plugin-transform-runtime@^7.25.9": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.27.3.tgz#ad35f1eff5ba18a5e23f7270e939fb5a59d3ec0b" - integrity sha512-bA9ZL5PW90YwNgGfjg6U+7Qh/k3zCEQJ06BFgAGRp/yMjw9hP9UGbGPtx3KSOkHGljEPCCxaE+PH4fUR2h1sDw== + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.28.3.tgz#f5990a1b2d2bde950ed493915e0719841c8d0eaa" + integrity sha512-Y6ab1kGqZ0u42Zv/4a7l0l72n9DKP/MKoKWaUSBylrhNZO2prYuqFOLbn5aW5SIFXwSH93yfjbgllL8lxuGKLg== dependencies: "@babel/helper-module-imports" "^7.27.1" "@babel/helper-plugin-utils" "^7.27.1" - babel-plugin-polyfill-corejs2 "^0.4.10" - babel-plugin-polyfill-corejs3 "^0.11.0" - babel-plugin-polyfill-regenerator "^0.6.1" + babel-plugin-polyfill-corejs2 "^0.4.14" + babel-plugin-polyfill-corejs3 "^0.13.0" + babel-plugin-polyfill-regenerator "^0.6.5" semver "^6.3.1" "@babel/plugin-transform-shorthand-properties@^7.27.1": @@ -853,11 +898,11 @@ "@babel/helper-plugin-utils" "^7.27.1" "@babel/plugin-transform-typescript@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.27.1.tgz#d3bb65598bece03f773111e88cc4e8e5070f1140" - integrity sha512-Q5sT5+O4QUebHdbwKedFBEwRLb02zJ7r4A5Gg2hUoLuU3FjdMcyqcywqUrLCaDsFCxzokf7u9kuy7qz51YUuAg== + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.28.0.tgz#796cbd249ab56c18168b49e3e1d341b72af04a6b" + integrity sha512-4AEiDEBPIZvLQaWlc9liCavE0xRM0dNca41WtBeM3jgFptfUOSG9z0uteLhq6+3rq+WB6jIvUwKDTpXEHPJ2Vg== dependencies: - "@babel/helper-annotate-as-pure" "^7.27.1" + "@babel/helper-annotate-as-pure" "^7.27.3" "@babel/helper-create-class-features-plugin" "^7.27.1" "@babel/helper-plugin-utils" "^7.27.1" "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" @@ -895,11 +940,11 @@ "@babel/helper-plugin-utils" "^7.27.1" "@babel/preset-env@^7.20.2", "@babel/preset-env@^7.25.9": - version "7.27.2" - resolved "https://registry.yarnpkg.com/@babel/preset-env/-/preset-env-7.27.2.tgz#106e6bfad92b591b1f6f76fd4cf13b7725a7bf9a" - integrity sha512-Ma4zSuYSlGNRlCLO+EAzLnCmJK2vdstgv+n7aUP+/IKZrOfWHOJVdSJtuub8RzHTj3ahD37k5OKJWvzf16TQyQ== + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/preset-env/-/preset-env-7.28.3.tgz#2b18d9aff9e69643789057ae4b942b1654f88187" + integrity sha512-ROiDcM+GbYVPYBOeCR6uBXKkQpBExLl8k9HO1ygXEyds39j+vCCsjmj7S8GOniZQlEs81QlkdJZe76IpLSiqpg== dependencies: - "@babel/compat-data" "^7.27.2" + "@babel/compat-data" "^7.28.0" "@babel/helper-compilation-targets" "^7.27.2" "@babel/helper-plugin-utils" "^7.27.1" "@babel/helper-validator-option" "^7.27.1" @@ -907,25 +952,26 @@ "@babel/plugin-bugfix-safari-class-field-initializer-scope" "^7.27.1" "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression" "^7.27.1" "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining" "^7.27.1" - "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly" "^7.27.1" + "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly" "^7.28.3" "@babel/plugin-proposal-private-property-in-object" "7.21.0-placeholder-for-preset-env.2" "@babel/plugin-syntax-import-assertions" "^7.27.1" "@babel/plugin-syntax-import-attributes" "^7.27.1" "@babel/plugin-syntax-unicode-sets-regex" "^7.18.6" "@babel/plugin-transform-arrow-functions" "^7.27.1" - "@babel/plugin-transform-async-generator-functions" "^7.27.1" + "@babel/plugin-transform-async-generator-functions" "^7.28.0" "@babel/plugin-transform-async-to-generator" "^7.27.1" "@babel/plugin-transform-block-scoped-functions" "^7.27.1" - "@babel/plugin-transform-block-scoping" "^7.27.1" + "@babel/plugin-transform-block-scoping" "^7.28.0" "@babel/plugin-transform-class-properties" "^7.27.1" - "@babel/plugin-transform-class-static-block" "^7.27.1" - "@babel/plugin-transform-classes" "^7.27.1" + "@babel/plugin-transform-class-static-block" "^7.28.3" + "@babel/plugin-transform-classes" "^7.28.3" "@babel/plugin-transform-computed-properties" "^7.27.1" - "@babel/plugin-transform-destructuring" "^7.27.1" + "@babel/plugin-transform-destructuring" "^7.28.0" "@babel/plugin-transform-dotall-regex" "^7.27.1" "@babel/plugin-transform-duplicate-keys" "^7.27.1" "@babel/plugin-transform-duplicate-named-capturing-groups-regex" "^7.27.1" "@babel/plugin-transform-dynamic-import" "^7.27.1" + "@babel/plugin-transform-explicit-resource-management" "^7.28.0" "@babel/plugin-transform-exponentiation-operator" "^7.27.1" "@babel/plugin-transform-export-namespace-from" "^7.27.1" "@babel/plugin-transform-for-of" "^7.27.1" @@ -942,15 +988,15 @@ "@babel/plugin-transform-new-target" "^7.27.1" "@babel/plugin-transform-nullish-coalescing-operator" "^7.27.1" "@babel/plugin-transform-numeric-separator" "^7.27.1" - "@babel/plugin-transform-object-rest-spread" "^7.27.2" + "@babel/plugin-transform-object-rest-spread" "^7.28.0" "@babel/plugin-transform-object-super" "^7.27.1" "@babel/plugin-transform-optional-catch-binding" "^7.27.1" "@babel/plugin-transform-optional-chaining" "^7.27.1" - "@babel/plugin-transform-parameters" "^7.27.1" + "@babel/plugin-transform-parameters" "^7.27.7" "@babel/plugin-transform-private-methods" "^7.27.1" "@babel/plugin-transform-private-property-in-object" "^7.27.1" "@babel/plugin-transform-property-literals" "^7.27.1" - "@babel/plugin-transform-regenerator" "^7.27.1" + "@babel/plugin-transform-regenerator" "^7.28.3" "@babel/plugin-transform-regexp-modifiers" "^7.27.1" "@babel/plugin-transform-reserved-words" "^7.27.1" "@babel/plugin-transform-shorthand-properties" "^7.27.1" @@ -963,10 +1009,10 @@ "@babel/plugin-transform-unicode-regex" "^7.27.1" "@babel/plugin-transform-unicode-sets-regex" "^7.27.1" "@babel/preset-modules" "0.1.6-no-external-plugins" - babel-plugin-polyfill-corejs2 "^0.4.10" - babel-plugin-polyfill-corejs3 "^0.11.0" - babel-plugin-polyfill-regenerator "^0.6.1" - core-js-compat "^3.40.0" + babel-plugin-polyfill-corejs2 "^0.4.14" + babel-plugin-polyfill-corejs3 "^0.13.0" + babel-plugin-polyfill-regenerator "^0.6.5" + core-js-compat "^3.43.0" semver "^6.3.1" "@babel/preset-modules@0.1.6-no-external-plugins": @@ -1002,16 +1048,16 @@ "@babel/plugin-transform-typescript" "^7.27.1" "@babel/runtime-corejs3@^7.25.9": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/runtime-corejs3/-/runtime-corejs3-7.27.3.tgz#b971a4a0a376171e266629152e74ef50e9931f79" - integrity sha512-ZYcgrwb+dkWNcDlsTe4fH1CMdqMDSJ5lWFd1by8Si2pI54XcQjte/+ViIPqAk7EAWisaUxvQ89grv+bNX2x8zg== + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/runtime-corejs3/-/runtime-corejs3-7.28.4.tgz#c25be39c7997ce2f130d70b9baecb8ed94df93fa" + integrity sha512-h7iEYiW4HebClDEhtvFObtPmIvrd1SSfpI9EhOeKk4CtIK/ngBWFpuhCzhdmRKtg71ylcue+9I6dv54XYO1epQ== dependencies: - core-js-pure "^3.30.2" + core-js-pure "^3.43.0" "@babel/runtime@^7.1.2", "@babel/runtime@^7.10.3", "@babel/runtime@^7.12.13", "@babel/runtime@^7.12.5", "@babel/runtime@^7.25.9": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.27.3.tgz#10491113799fb8d77e1d9273384d5d68deeea8f6" - integrity sha512-7EYtGezsdiDMyY80+65EzwiGmcJqpmcZCojSXaRgdrBaGtWTgDZKq69cPIVped6MkIM78cTQ2GOiEYjwOlG4xw== + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.28.4.tgz#a70226016fabe25c5783b2f22d3e1c9bc5ca3326" + integrity sha512-Q/N6JNWvIvPnLDvjlE1OUBLPQHH6l3CltCEsHIujp45zQUSSh8K+gHnaEX45yAT1nyngnINhvWtzN+Nb9D8RAQ== "@babel/template@^7.27.1", "@babel/template@^7.27.2": version "7.27.2" @@ -1022,23 +1068,23 @@ "@babel/parser" "^7.27.2" "@babel/types" "^7.27.1" -"@babel/traverse@^7.25.9", "@babel/traverse@^7.27.1", "@babel/traverse@^7.27.3": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.27.3.tgz#8b62a6c2d10f9d921ba7339c90074708509cffae" - integrity sha512-lId/IfN/Ye1CIu8xG7oKBHXd2iNb2aW1ilPszzGcJug6M8RCKfVNcYhpI5+bMvFYjK7lXIM0R+a+6r8xhHp2FQ== +"@babel/traverse@^7.25.9", "@babel/traverse@^7.27.1", "@babel/traverse@^7.28.0", "@babel/traverse@^7.28.3", "@babel/traverse@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.28.4.tgz#8d456101b96ab175d487249f60680221692b958b" + integrity sha512-YEzuboP2qvQavAcjgQNVgsvHIDv6ZpwXvcvjmyySP2DIMuByS/6ioU5G9pYrWHM6T2YDfc7xga9iNzYOs12CFQ== dependencies: "@babel/code-frame" "^7.27.1" - "@babel/generator" "^7.27.3" - "@babel/parser" "^7.27.3" + "@babel/generator" "^7.28.3" + "@babel/helper-globals" "^7.28.0" + "@babel/parser" "^7.28.4" "@babel/template" "^7.27.2" - "@babel/types" "^7.27.3" + "@babel/types" "^7.28.4" debug "^4.3.1" - globals "^11.1.0" -"@babel/types@^7.21.3", "@babel/types@^7.27.1", "@babel/types@^7.27.3", "@babel/types@^7.4.4": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.27.3.tgz#c0257bedf33aad6aad1f406d35c44758321eb3ec" - integrity sha512-Y1GkI4ktrtvmawoSq+4FCVHNryea6uR+qUQy0AGxLSsjCX0nVmkYQMBLHDkXZuo5hGx7eYdnIaslsdBFm7zbUw== +"@babel/types@^7.21.3", "@babel/types@^7.27.1", "@babel/types@^7.27.3", "@babel/types@^7.28.2", "@babel/types@^7.28.4", "@babel/types@^7.4.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.28.4.tgz#0a4e618f4c60a7cd6c11cb2d48060e4dbe38ac3a" + integrity sha512-bkFqkLhh3pMBUQQkpVgWDWq/lqzc2678eUyDlTBhRqhCHFguYYGM0Efga7tYk4TogG/3x0EEl66/OQ+WGbWB/Q== dependencies: "@babel/helper-string-parser" "^7.27.1" "@babel/helper-validator-identifier" "^7.27.1" @@ -1048,92 +1094,136 @@ resolved "https://registry.yarnpkg.com/@colors/colors/-/colors-1.5.0.tgz#bb504579c1cae923e6576a4f5da43d25f97bdbd9" integrity sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ== -"@csstools/cascade-layer-name-parser@^2.0.4": - version "2.0.4" - resolved "https://registry.yarnpkg.com/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.4.tgz#64d128529397aa1e1c986f685713363b262b81b1" - integrity sha512-7DFHlPuIxviKYZrOiwVU/PiHLm3lLUR23OMuEEtfEOQTOp9hzQ2JjdY6X5H18RVuUPJqSCI+qNnD5iOLMVE0bA== +"@csstools/cascade-layer-name-parser@^2.0.5": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.5.tgz#43f962bebead0052a9fed1a2deeb11f85efcbc72" + integrity sha512-p1ko5eHgV+MgXFVa4STPKpvPxr6ReS8oS2jzTukjR74i5zJNyWO1ZM1m8YKBXnzDKWfBN1ztLYlHxbVemDD88A== -"@csstools/color-helpers@^5.0.2": - version "5.0.2" - resolved "https://registry.yarnpkg.com/@csstools/color-helpers/-/color-helpers-5.0.2.tgz#82592c9a7c2b83c293d9161894e2a6471feb97b8" - integrity sha512-JqWH1vsgdGcw2RR6VliXXdA0/59LttzlU8UlRT/iUUsEeWfYq8I+K0yhihEUTTHLRm1EXvpsCx3083EU15ecsA== +"@csstools/color-helpers@^5.1.0": + version "5.1.0" + resolved "https://registry.yarnpkg.com/@csstools/color-helpers/-/color-helpers-5.1.0.tgz#106c54c808cabfd1ab4c602d8505ee584c2996ef" + integrity sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA== -"@csstools/css-calc@^2.1.3": - version "2.1.3" - resolved "https://registry.yarnpkg.com/@csstools/css-calc/-/css-calc-2.1.3.tgz#6f68affcb569a86b91965e8622d644be35a08423" - integrity sha512-XBG3talrhid44BY1x3MHzUx/aTG8+x/Zi57M4aTKK9RFB4aLlF3TTSzfzn8nWVHWL3FgAXAxmupmDd6VWww+pw== +"@csstools/css-calc@^2.1.4": + version "2.1.4" + resolved "https://registry.yarnpkg.com/@csstools/css-calc/-/css-calc-2.1.4.tgz#8473f63e2fcd6e459838dd412401d5948f224c65" + integrity sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ== -"@csstools/css-color-parser@^3.0.9": - version "3.0.9" - resolved "https://registry.yarnpkg.com/@csstools/css-color-parser/-/css-color-parser-3.0.9.tgz#8d81b77d6f211495b5100ec4cad4c8828de49f6b" - integrity sha512-wILs5Zk7BU86UArYBJTPy/FMPPKVKHMj1ycCEyf3VUptol0JNRLFU/BZsJ4aiIHJEbSLiizzRrw8Pc1uAEDrXw== +"@csstools/css-color-parser@^3.1.0": + version "3.1.0" + resolved "https://registry.yarnpkg.com/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz#4e386af3a99dd36c46fef013cfe4c1c341eed6f0" + integrity sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA== dependencies: - "@csstools/color-helpers" "^5.0.2" - "@csstools/css-calc" "^2.1.3" + "@csstools/color-helpers" "^5.1.0" + "@csstools/css-calc" "^2.1.4" -"@csstools/css-parser-algorithms@^3.0.4": +"@csstools/css-parser-algorithms@^3.0.5": + version "3.0.5" + resolved "https://registry.yarnpkg.com/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz#5755370a9a29abaec5515b43c8b3f2cf9c2e3076" + integrity sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ== + +"@csstools/css-tokenizer@^3.0.4": version "3.0.4" - resolved "https://registry.yarnpkg.com/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.4.tgz#74426e93bd1c4dcab3e441f5cc7ba4fb35d94356" - integrity sha512-Up7rBoV77rv29d3uKHUIVubz1BTcgyUK72IvCQAbfbMv584xHcGKCKbWh7i8hPrRJ7qU4Y8IO3IY9m+iTB7P3A== + resolved "https://registry.yarnpkg.com/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz#333fedabc3fd1a8e5d0100013731cf19e6a8c5d3" + integrity sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw== -"@csstools/css-tokenizer@^3.0.3": - version "3.0.3" - resolved "https://registry.yarnpkg.com/@csstools/css-tokenizer/-/css-tokenizer-3.0.3.tgz#a5502c8539265fecbd873c1e395a890339f119c2" - integrity sha512-UJnjoFsmxfKUdNYdWgOB0mWUypuLvAfQPH1+pyvRJs6euowbFkFC6P13w1l8mJyi3vxYMxc9kld5jZEGRQs6bw== +"@csstools/media-query-list-parser@^4.0.3": + version "4.0.3" + resolved "https://registry.yarnpkg.com/@csstools/media-query-list-parser/-/media-query-list-parser-4.0.3.tgz#7aec77bcb89c2da80ef207e73f474ef9e1b3cdf1" + integrity sha512-HAYH7d3TLRHDOUQK4mZKf9k9Ph/m8Akstg66ywKR4SFAigjs3yBiUeZtFxywiTm5moZMAp/5W/ZuFnNXXYLuuQ== -"@csstools/media-query-list-parser@^4.0.2": - version "4.0.2" - resolved "https://registry.yarnpkg.com/@csstools/media-query-list-parser/-/media-query-list-parser-4.0.2.tgz#e80e17eba1693fceafb8d6f2cfc68c0e7a9ab78a" - integrity sha512-EUos465uvVvMJehckATTlNqGj4UJWkTmdWuDMjqvSUkjGpmOyFZBVwb4knxCm/k2GMTXY+c/5RkdndzFYWeX5A== +"@csstools/postcss-alpha-function@^1.0.1": + version "1.0.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-alpha-function/-/postcss-alpha-function-1.0.1.tgz#7989605711de7831bc7cd75b94c9b5bac9c3728e" + integrity sha512-isfLLwksH3yHkFXfCI2Gcaqg7wGGHZZwunoJzEZk0yKYIokgre6hYVFibKL3SYAoR1kBXova8LB+JoO5vZzi9w== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" + "@csstools/utilities" "^2.0.0" -"@csstools/postcss-cascade-layers@^5.0.1": - version "5.0.1" - resolved "https://registry.yarnpkg.com/@csstools/postcss-cascade-layers/-/postcss-cascade-layers-5.0.1.tgz#9640313e64b5e39133de7e38a5aa7f40dc259597" - integrity sha512-XOfhI7GShVcKiKwmPAnWSqd2tBR0uxt+runAxttbSp/LY2U16yAVPmAf7e9q4JJ0d+xMNmpwNDLBXnmRCl3HMQ== +"@csstools/postcss-cascade-layers@^5.0.2": + version "5.0.2" + resolved "https://registry.yarnpkg.com/@csstools/postcss-cascade-layers/-/postcss-cascade-layers-5.0.2.tgz#dd2c70db3867b88975f2922da3bfbae7d7a2cae7" + integrity sha512-nWBE08nhO8uWl6kSAeCx4im7QfVko3zLrtgWZY4/bP87zrSPpSyN/3W3TDqz1jJuH+kbKOHXg5rJnK+ZVYcFFg== dependencies: "@csstools/selector-specificity" "^5.0.0" postcss-selector-parser "^7.0.0" -"@csstools/postcss-color-function@^4.0.9": - version "4.0.9" - resolved "https://registry.yarnpkg.com/@csstools/postcss-color-function/-/postcss-color-function-4.0.9.tgz#67080c6b4635926d68cc9c8f52261b87ece70bf8" - integrity sha512-2UeQCGMO5+EeQsPQK2DqXp0dad+P6nIz6G2dI06APpBuYBKxZEq7CTH+UiztFQ8cB1f89dnO9+D/Kfr+JfI2hw== +"@csstools/postcss-color-function-display-p3-linear@^1.0.1": + version "1.0.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-function-display-p3-linear/-/postcss-color-function-display-p3-linear-1.0.1.tgz#3017ff5e1f65307d6083e58e93d76724fb1ebf9f" + integrity sha512-E5qusdzhlmO1TztYzDIi8XPdPoYOjoTY6HBYBCYSj+Gn4gQRBlvjgPQXzfzuPQqt8EhkC/SzPKObg4Mbn8/xMg== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" -"@csstools/postcss-color-mix-function@^3.0.9": - version "3.0.9" - resolved "https://registry.yarnpkg.com/@csstools/postcss-color-mix-function/-/postcss-color-mix-function-3.0.9.tgz#103858388ba4d2c589daeecb02f9f05baecc27d0" - integrity sha512-Enj7ZIIkLD7zkGCN31SZFx4H1gKiCs2Y4taBo/v/cqaHN7p1qGrf5UTMNSjQFZ7MgClGufHx4pddwFTGL+ipug== +"@csstools/postcss-color-function@^4.0.12": + version "4.0.12" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-function/-/postcss-color-function-4.0.12.tgz#a7c85a98c77b522a194a1bbb00dd207f40c7a771" + integrity sha512-yx3cljQKRaSBc2hfh8rMZFZzChaFgwmO2JfFgFr1vMcF3C/uyy5I4RFIBOIWGq1D+XbKCG789CGkG6zzkLpagA== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" -"@csstools/postcss-content-alt-text@^2.0.5": - version "2.0.5" - resolved "https://registry.yarnpkg.com/@csstools/postcss-content-alt-text/-/postcss-content-alt-text-2.0.5.tgz#86b195bef6ce32179a68011b87212a3e4e73b84a" - integrity sha512-9BOS535v6YmyOYk32jAHXeddRV+iyd4vRcbrEekpwxmueAXX5J8WgbceFnE4E4Pmw/ysnB9v+n/vSWoFmcLMcA== +"@csstools/postcss-color-mix-function@^3.0.12": + version "3.0.12" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-mix-function/-/postcss-color-mix-function-3.0.12.tgz#2f1ee9f8208077af069545c9bd79bb9733382c2a" + integrity sha512-4STERZfCP5Jcs13P1U5pTvI9SkgLgfMUMhdXW8IlJWkzOOOqhZIjcNhWtNJZes2nkBDsIKJ0CJtFtuaZ00moag== dependencies: - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" -"@csstools/postcss-exponential-functions@^2.0.8": +"@csstools/postcss-color-mix-variadic-function-arguments@^1.0.2": + version "1.0.2" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-mix-variadic-function-arguments/-/postcss-color-mix-variadic-function-arguments-1.0.2.tgz#b4012b62a4eaa24d694172bb7137f9d2319cb8f2" + integrity sha512-rM67Gp9lRAkTo+X31DUqMEq+iK+EFqsidfecmhrteErxJZb6tUoJBVQca1Vn1GpDql1s1rD1pKcuYzMsg7Z1KQ== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-content-alt-text@^2.0.8": version "2.0.8" - resolved "https://registry.yarnpkg.com/@csstools/postcss-exponential-functions/-/postcss-exponential-functions-2.0.8.tgz#da6b3673fcb48a78294d39d6afc1e4da45dedada" - integrity sha512-vHgDXtGIBPpFQnFNDftMQg4MOuXcWnK91L/7REjBNYzQ/p2Fa/6RcnehTqCRrNtQ46PNIolbRsiDdDuxiHolwQ== + resolved "https://registry.yarnpkg.com/@csstools/postcss-content-alt-text/-/postcss-content-alt-text-2.0.8.tgz#1d52da1762893c32999ff76839e48d6ec7c7a4cb" + integrity sha512-9SfEW9QCxEpTlNMnpSqFaHyzsiRpZ5J5+KqCu1u5/eEJAWsMhzT40qf0FIbeeglEvrGRMdDzAxMIz3wqoGSb+Q== dependencies: - "@csstools/css-calc" "^2.1.3" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-contrast-color-function@^2.0.12": + version "2.0.12" + resolved "https://registry.yarnpkg.com/@csstools/postcss-contrast-color-function/-/postcss-contrast-color-function-2.0.12.tgz#ca46986d095c60f208d9e3f24704d199c9172637" + integrity sha512-YbwWckjK3qwKjeYz/CijgcS7WDUCtKTd8ShLztm3/i5dhh4NaqzsbYnhm4bjrpFpnLZ31jVcbK8YL77z3GBPzA== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-exponential-functions@^2.0.9": + version "2.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-exponential-functions/-/postcss-exponential-functions-2.0.9.tgz#fc03d1272888cb77e64cc1a7d8a33016e4f05c69" + integrity sha512-abg2W/PI3HXwS/CZshSa79kNWNZHdJPMBXeZNyPQFbbj8sKO3jXxOt/wF7juJVjyDTc6JrvaUZYFcSBZBhaxjw== + dependencies: + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" "@csstools/postcss-font-format-keywords@^4.0.0": version "4.0.0" @@ -1143,43 +1233,43 @@ "@csstools/utilities" "^2.0.0" postcss-value-parser "^4.2.0" -"@csstools/postcss-gamut-mapping@^2.0.9": - version "2.0.9" - resolved "https://registry.yarnpkg.com/@csstools/postcss-gamut-mapping/-/postcss-gamut-mapping-2.0.9.tgz#83b08d302865ce6fc3127589ff6658fe32635636" - integrity sha512-quksIsFm3DGsf8Qbr9KiSGBF2w3RwxSfOfma5wbORDB1AFF15r4EVW7sUuWw3s5IAEGMqzel/dE2rQsI7Yb8mA== +"@csstools/postcss-gamut-mapping@^2.0.11": + version "2.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-gamut-mapping/-/postcss-gamut-mapping-2.0.11.tgz#be0e34c9f0142852cccfc02b917511f0d677db8b" + integrity sha512-fCpCUgZNE2piVJKC76zFsgVW1apF6dpYsqGyH8SIeCcM4pTEsRTWTLCaJIMKFEundsCKwY1rwfhtrio04RJ4Dw== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" -"@csstools/postcss-gradients-interpolation-method@^5.0.9": - version "5.0.9" - resolved "https://registry.yarnpkg.com/@csstools/postcss-gradients-interpolation-method/-/postcss-gradients-interpolation-method-5.0.9.tgz#e2e1c59b08e7524c269bb4cac91618f95b9c849e" - integrity sha512-duqTeUHF4ambUybAmhX9KonkicLM/WNp2JjMUbegRD4O8A/tb6fdZ7jUNdp/UUiO1FIdDkMwmNw6856bT0XF8Q== +"@csstools/postcss-gradients-interpolation-method@^5.0.12": + version "5.0.12" + resolved "https://registry.yarnpkg.com/@csstools/postcss-gradients-interpolation-method/-/postcss-gradients-interpolation-method-5.0.12.tgz#0955cce4d97203b861bf66742bbec611b2f3661c" + integrity sha512-jugzjwkUY0wtNrZlFeyXzimUL3hN4xMvoPnIXxoZqxDvjZRiSh+itgHcVUWzJ2VwD/VAMEgCLvtaJHX+4Vj3Ow== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" -"@csstools/postcss-hwb-function@^4.0.9": - version "4.0.9" - resolved "https://registry.yarnpkg.com/@csstools/postcss-hwb-function/-/postcss-hwb-function-4.0.9.tgz#4abca35a88a382e211fc0abe125a8ce7bb07030b" - integrity sha512-sDpdPsoGAhYl/PMSYfu5Ez82wXb2bVkg1Cb8vsRLhpXhAk4OSlsJN+GodAql6tqc1B2G/WToxsFU6G74vkhPvA== +"@csstools/postcss-hwb-function@^4.0.12": + version "4.0.12" + resolved "https://registry.yarnpkg.com/@csstools/postcss-hwb-function/-/postcss-hwb-function-4.0.12.tgz#07f7ecb08c50e094673bd20eaf7757db0162beee" + integrity sha512-mL/+88Z53KrE4JdePYFJAQWFrcADEqsLprExCM04GDNgHIztwFzj0Mbhd/yxMBngq0NIlz58VVxjt5abNs1VhA== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" -"@csstools/postcss-ic-unit@^4.0.1": - version "4.0.1" - resolved "https://registry.yarnpkg.com/@csstools/postcss-ic-unit/-/postcss-ic-unit-4.0.1.tgz#7b67b49d85713d8bad70ee5735f409b19fd906f9" - integrity sha512-lECc38i1w3qU9nhrUhP6F8y4BfcQJkR1cb8N6tZNf2llM6zPkxnqt04jRCwsUgNcB3UGKDy+zLenhOYGHqCV+Q== +"@csstools/postcss-ic-unit@^4.0.4": + version "4.0.4" + resolved "https://registry.yarnpkg.com/@csstools/postcss-ic-unit/-/postcss-ic-unit-4.0.4.tgz#2ee2da0690db7edfbc469279711b9e69495659d2" + integrity sha512-yQ4VmossuOAql65sCPppVO1yfb7hDscf4GseF0VCA/DTDaBc0Wtf8MTqVPfjGYlT5+2buokG0Gp7y0atYZpwjg== dependencies: - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" postcss-value-parser "^4.2.0" @@ -1188,22 +1278,22 @@ resolved "https://registry.yarnpkg.com/@csstools/postcss-initial/-/postcss-initial-2.0.1.tgz#c385bd9d8ad31ad159edd7992069e97ceea4d09a" integrity sha512-L1wLVMSAZ4wovznquK0xmC7QSctzO4D0Is590bxpGqhqjboLXYA16dWZpfwImkdOgACdQ9PqXsuRroW6qPlEsg== -"@csstools/postcss-is-pseudo-class@^5.0.1": - version "5.0.1" - resolved "https://registry.yarnpkg.com/@csstools/postcss-is-pseudo-class/-/postcss-is-pseudo-class-5.0.1.tgz#12041448fedf01090dd4626022c28b7f7623f58e" - integrity sha512-JLp3POui4S1auhDR0n8wHd/zTOWmMsmK3nQd3hhL6FhWPaox5W7j1se6zXOG/aP07wV2ww0lxbKYGwbBszOtfQ== +"@csstools/postcss-is-pseudo-class@^5.0.3": + version "5.0.3" + resolved "https://registry.yarnpkg.com/@csstools/postcss-is-pseudo-class/-/postcss-is-pseudo-class-5.0.3.tgz#d34e850bcad4013c2ed7abe948bfa0448aa8eb74" + integrity sha512-jS/TY4SpG4gszAtIg7Qnf3AS2pjcUM5SzxpApOrlndMeGhIbaTzWBzzP/IApXoNWEW7OhcjkRT48jnAUIFXhAQ== dependencies: "@csstools/selector-specificity" "^5.0.0" postcss-selector-parser "^7.0.0" -"@csstools/postcss-light-dark-function@^2.0.8": - version "2.0.8" - resolved "https://registry.yarnpkg.com/@csstools/postcss-light-dark-function/-/postcss-light-dark-function-2.0.8.tgz#bac218338f458f9a3f05edcc94ab009def14a532" - integrity sha512-v8VU5WtrZIyEtk88WB4fkG22TGd8HyAfSFfZZQ1uNN0+arMJdZc++H3KYTfbYDpJRGy8GwADYH8ySXiILn+OyA== +"@csstools/postcss-light-dark-function@^2.0.11": + version "2.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-light-dark-function/-/postcss-light-dark-function-2.0.11.tgz#0df448aab9a33cb9a085264ff1f396fb80c4437d" + integrity sha512-fNJcKXJdPM3Lyrbmgw2OBbaioU7yuKZtiXClf4sGdQttitijYlZMD5K7HrC/eF83VRWRrYq6OZ0Lx92leV2LFA== dependencies: - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" "@csstools/postcss-logical-float-and-clear@^3.0.0": @@ -1228,32 +1318,32 @@ dependencies: postcss-value-parser "^4.2.0" -"@csstools/postcss-logical-viewport-units@^3.0.3": - version "3.0.3" - resolved "https://registry.yarnpkg.com/@csstools/postcss-logical-viewport-units/-/postcss-logical-viewport-units-3.0.3.tgz#f6cc63520ca2a6eb76b9cd946070c38dda66d733" - integrity sha512-OC1IlG/yoGJdi0Y+7duz/kU/beCwO+Gua01sD6GtOtLi7ByQUpcIqs7UE/xuRPay4cHgOMatWdnDdsIDjnWpPw== +"@csstools/postcss-logical-viewport-units@^3.0.4": + version "3.0.4" + resolved "https://registry.yarnpkg.com/@csstools/postcss-logical-viewport-units/-/postcss-logical-viewport-units-3.0.4.tgz#016d98a8b7b5f969e58eb8413447eb801add16fc" + integrity sha512-q+eHV1haXA4w9xBwZLKjVKAWn3W2CMqmpNpZUk5kRprvSiBEGMgrNH3/sJZ8UA3JgyHaOt3jwT9uFa4wLX4EqQ== dependencies: - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/css-tokenizer" "^3.0.4" "@csstools/utilities" "^2.0.0" -"@csstools/postcss-media-minmax@^2.0.8": - version "2.0.8" - resolved "https://registry.yarnpkg.com/@csstools/postcss-media-minmax/-/postcss-media-minmax-2.0.8.tgz#b5397f18531c54ac0c12cbf20b6bf93208bd5d16" - integrity sha512-Skum5wIXw2+NyCQWUyfstN3c1mfSh39DRAo+Uh2zzXOglBG8xB9hnArhYFScuMZkzeM+THVa//mrByKAfumc7w== +"@csstools/postcss-media-minmax@^2.0.9": + version "2.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-media-minmax/-/postcss-media-minmax-2.0.9.tgz#184252d5b93155ae526689328af6bdf3fc113987" + integrity sha512-af9Qw3uS3JhYLnCbqtZ9crTvvkR+0Se+bBqSr7ykAnl9yKhk6895z9rf+2F4dClIDJWxgn0iZZ1PSdkhrbs2ig== dependencies: - "@csstools/css-calc" "^2.1.3" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/media-query-list-parser" "^4.0.2" + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/media-query-list-parser" "^4.0.3" -"@csstools/postcss-media-queries-aspect-ratio-number-values@^3.0.4": - version "3.0.4" - resolved "https://registry.yarnpkg.com/@csstools/postcss-media-queries-aspect-ratio-number-values/-/postcss-media-queries-aspect-ratio-number-values-3.0.4.tgz#d71102172c74baf3f892fac88cf1ea46a961600d" - integrity sha512-AnGjVslHMm5xw9keusQYvjVWvuS7KWK+OJagaG0+m9QnIjZsrysD2kJP/tr/UJIyYtMCtu8OkUd+Rajb4DqtIQ== +"@csstools/postcss-media-queries-aspect-ratio-number-values@^3.0.5": + version "3.0.5" + resolved "https://registry.yarnpkg.com/@csstools/postcss-media-queries-aspect-ratio-number-values/-/postcss-media-queries-aspect-ratio-number-values-3.0.5.tgz#f485c31ec13d6b0fb5c528a3474334a40eff5f11" + integrity sha512-zhAe31xaaXOY2Px8IYfoVTB3wglbJUVigGphFLj6exb7cjZRH9A6adyE22XfFK3P2PzwRk0VDeTJmaxpluyrDg== dependencies: - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/media-query-list-parser" "^4.0.2" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/media-query-list-parser" "^4.0.3" "@csstools/postcss-nested-calc@^4.0.0": version "4.0.0" @@ -1270,42 +1360,42 @@ dependencies: postcss-value-parser "^4.2.0" -"@csstools/postcss-oklab-function@^4.0.9": - version "4.0.9" - resolved "https://registry.yarnpkg.com/@csstools/postcss-oklab-function/-/postcss-oklab-function-4.0.9.tgz#21d8846b3fe632d663b8cfe5d1fa2ccdd3f0709a" - integrity sha512-UHrnujimwtdDw8BYDcWJtBXuJ13uc/BjAddPdfMc/RsWxhg8gG8UbvTF0tnMtHrZ4i7lwy85fPEzK1AiykMyRA== +"@csstools/postcss-oklab-function@^4.0.12": + version "4.0.12" + resolved "https://registry.yarnpkg.com/@csstools/postcss-oklab-function/-/postcss-oklab-function-4.0.12.tgz#416640ef10227eea1375b47b72d141495950971d" + integrity sha512-HhlSmnE1NKBhXsTnNGjxvhryKtO7tJd1w42DKOGFD6jSHtYOrsJTQDKPMwvOfrzUAk8t7GcpIfRyM7ssqHpFjg== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" -"@csstools/postcss-progressive-custom-properties@^4.0.1": - version "4.0.1" - resolved "https://registry.yarnpkg.com/@csstools/postcss-progressive-custom-properties/-/postcss-progressive-custom-properties-4.0.1.tgz#487e619d2577358cb08ed7319dd203d4d5db5bb6" - integrity sha512-Ofz81HaY8mmbP8/Qr3PZlUzjsyV5WuxWmvtYn+jhYGvvjFazTmN9R2io5W5znY1tyk2CA9uM0IPWyY4ygDytCw== +"@csstools/postcss-progressive-custom-properties@^4.2.1": + version "4.2.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-progressive-custom-properties/-/postcss-progressive-custom-properties-4.2.1.tgz#c39780b9ff0d554efb842b6bd75276aa6f1705db" + integrity sha512-uPiiXf7IEKtUQXsxu6uWtOlRMXd2QWWy5fhxHDnPdXKCQckPP3E34ZgDoZ62r2iT+UOgWsSbM4NvHE5m3mAEdw== dependencies: postcss-value-parser "^4.2.0" -"@csstools/postcss-random-function@^2.0.0": - version "2.0.0" - resolved "https://registry.yarnpkg.com/@csstools/postcss-random-function/-/postcss-random-function-2.0.0.tgz#38da06d102bbe65504023278f670895c4a1ceef9" - integrity sha512-MYZKxSr4AKfjECL8vg49BbfNNzK+t3p2OWX+Xf7rXgMaTP44oy/e8VGWu4MLnJ3NUd9tFVkisLO/sg+5wMTNsg== +"@csstools/postcss-random-function@^2.0.1": + version "2.0.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-random-function/-/postcss-random-function-2.0.1.tgz#3191f32fe72936e361dadf7dbfb55a0209e2691e" + integrity sha512-q+FQaNiRBhnoSNo+GzqGOIBKoHQ43lYz0ICrV+UudfWnEF6ksS6DsBIJSISKQT2Bvu3g4k6r7t0zYrk5pDlo8w== dependencies: - "@csstools/css-calc" "^2.1.3" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" -"@csstools/postcss-relative-color-syntax@^3.0.9": - version "3.0.9" - resolved "https://registry.yarnpkg.com/@csstools/postcss-relative-color-syntax/-/postcss-relative-color-syntax-3.0.9.tgz#1075eda90bb2a59f30bed94605def0a99cad3040" - integrity sha512-+AGOcLF5PmMnTRPnOdCvY7AwvD5veIOhTWbJV6vC3hB1tt0ii/k6QOwhWfsGGg1ZPQ0JY15u+wqLR4ZTtB0luA== +"@csstools/postcss-relative-color-syntax@^3.0.12": + version "3.0.12" + resolved "https://registry.yarnpkg.com/@csstools/postcss-relative-color-syntax/-/postcss-relative-color-syntax-3.0.12.tgz#ced792450102441f7c160e1d106f33e4b44181f8" + integrity sha512-0RLIeONxu/mtxRtf3o41Lq2ghLimw0w9ByLWnnEVuy89exmEEq8bynveBxNW3nyHqLAFEeNtVEmC1QK9MZ8Huw== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" "@csstools/postcss-scope-pseudo-class@^4.0.1": @@ -1315,50 +1405,50 @@ dependencies: postcss-selector-parser "^7.0.0" -"@csstools/postcss-sign-functions@^1.1.3": - version "1.1.3" - resolved "https://registry.yarnpkg.com/@csstools/postcss-sign-functions/-/postcss-sign-functions-1.1.3.tgz#ba64c7a6e25f50221a2f37fac5d7592917245781" - integrity sha512-4F4GRhj8xNkBtLZ+3ycIhReaDfKJByXI+cQGIps3AzCO8/CJOeoDPxpMnL5vqZrWKOceSATHEQJUO/Q/r2y7OQ== +"@csstools/postcss-sign-functions@^1.1.4": + version "1.1.4" + resolved "https://registry.yarnpkg.com/@csstools/postcss-sign-functions/-/postcss-sign-functions-1.1.4.tgz#a9ac56954014ae4c513475b3f1b3e3424a1e0c12" + integrity sha512-P97h1XqRPcfcJndFdG95Gv/6ZzxUBBISem0IDqPZ7WMvc/wlO+yU0c5D/OCpZ5TJoTt63Ok3knGk64N+o6L2Pg== dependencies: - "@csstools/css-calc" "^2.1.3" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" -"@csstools/postcss-stepped-value-functions@^4.0.8": - version "4.0.8" - resolved "https://registry.yarnpkg.com/@csstools/postcss-stepped-value-functions/-/postcss-stepped-value-functions-4.0.8.tgz#345f5620cbeb0e9742f242e1dc6c88a051ce6700" - integrity sha512-6Y4yhL4fNhgzbZ/wUMQ4EjFUfoNNMpEXZnDw1JrlcEBHUT15gplchtFsZGk7FNi8PhLHJfCUwVKrEHzhfhKK+g== +"@csstools/postcss-stepped-value-functions@^4.0.9": + version "4.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-stepped-value-functions/-/postcss-stepped-value-functions-4.0.9.tgz#36036f1a0e5e5ee2308e72f3c9cb433567c387b9" + integrity sha512-h9btycWrsex4dNLeQfyU3y3w40LMQooJWFMm/SK9lrKguHDcFl4VMkncKKoXi2z5rM9YGWbUQABI8BT2UydIcA== dependencies: - "@csstools/css-calc" "^2.1.3" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" -"@csstools/postcss-text-decoration-shorthand@^4.0.2": - version "4.0.2" - resolved "https://registry.yarnpkg.com/@csstools/postcss-text-decoration-shorthand/-/postcss-text-decoration-shorthand-4.0.2.tgz#a3bcf80492e6dda36477538ab8e8943908c9f80a" - integrity sha512-8XvCRrFNseBSAGxeaVTaNijAu+FzUvjwFXtcrynmazGb/9WUdsPCpBX+mHEHShVRq47Gy4peYAoxYs8ltUnmzA== +"@csstools/postcss-text-decoration-shorthand@^4.0.3": + version "4.0.3" + resolved "https://registry.yarnpkg.com/@csstools/postcss-text-decoration-shorthand/-/postcss-text-decoration-shorthand-4.0.3.tgz#fae1b70f07d1b7beb4c841c86d69e41ecc6f743c" + integrity sha512-KSkGgZfx0kQjRIYnpsD7X2Om9BUXX/Kii77VBifQW9Ih929hK0KNjVngHDH0bFB9GmfWcR9vJYJJRvw/NQjkrA== dependencies: - "@csstools/color-helpers" "^5.0.2" + "@csstools/color-helpers" "^5.1.0" postcss-value-parser "^4.2.0" -"@csstools/postcss-trigonometric-functions@^4.0.8": - version "4.0.8" - resolved "https://registry.yarnpkg.com/@csstools/postcss-trigonometric-functions/-/postcss-trigonometric-functions-4.0.8.tgz#ad7940798fafadc77846e9ca47e2b594515d4f60" - integrity sha512-YcDvYTRu7f78/91B6bX+mE1WoAO91Su7/8KSRpuWbIGUB8hmaNSRu9wziaWSLJ1lOB1aQe+bvo9BIaLKqPOo/g== +"@csstools/postcss-trigonometric-functions@^4.0.9": + version "4.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-trigonometric-functions/-/postcss-trigonometric-functions-4.0.9.tgz#3f94ed2e319b57f2c59720b64e4d0a8a6fb8c3b2" + integrity sha512-Hnh5zJUdpNrJqK9v1/E3BbrQhaDTj5YiX7P61TOvUhoDHnUmsNNxcDAgkQ32RrcWx9GVUvfUNPcUkn8R3vIX6A== dependencies: - "@csstools/css-calc" "^2.1.3" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" "@csstools/postcss-unset-value@^4.0.0": version "4.0.0" resolved "https://registry.yarnpkg.com/@csstools/postcss-unset-value/-/postcss-unset-value-4.0.0.tgz#7caa981a34196d06a737754864baf77d64de4bba" integrity sha512-cBz3tOCI5Fw6NIFEwU3RiwK6mn3nKegjpJuzCndoGq3BZPkUjnsq7uQmIeMNeMbMk7YD2MfKcgCpZwX5jyXqCA== -"@csstools/selector-resolve-nested@^3.0.0": - version "3.0.0" - resolved "https://registry.yarnpkg.com/@csstools/selector-resolve-nested/-/selector-resolve-nested-3.0.0.tgz#704a9b637975680e025e069a4c58b3beb3e2752a" - integrity sha512-ZoK24Yku6VJU1gS79a5PFmC8yn3wIapiKmPgun0hZgEI5AOqgH2kiPRsPz1qkGv4HL+wuDLH83yQyk6inMYrJQ== +"@csstools/selector-resolve-nested@^3.1.0": + version "3.1.0" + resolved "https://registry.yarnpkg.com/@csstools/selector-resolve-nested/-/selector-resolve-nested-3.1.0.tgz#848c6f44cb65e3733e478319b9342b7aa436fac7" + integrity sha512-mf1LEW0tJLKfWyvn5KdDrhpxHyuxpbNwTIwOYLIvsTffeyOf85j5oIzfG0yosxDgx/sswlqBnESYUcQH0vgZ0g== "@csstools/selector-specificity@^5.0.0": version "5.0.0" @@ -1375,25 +1465,28 @@ resolved "https://registry.yarnpkg.com/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz#1d572bfbbe14b7704e0ba0f39b74815b84870d70" integrity sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw== -"@docsearch/css@3.9.0": - version "3.9.0" - resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-3.9.0.tgz#3bc29c96bf024350d73b0cfb7c2a7b71bf251cd5" - integrity sha512-cQbnVbq0rrBwNAKegIac/t6a8nWoUAn8frnkLFW6YARaRmAQr5/Eoe6Ln2fqkUCZ40KpdrKbpSAmgrkviOxuWA== +"@docsearch/css@4.2.0": + version "4.2.0" + resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-4.2.0.tgz#473bb4c51f4b2b037a71f423e569907ab19e6d72" + integrity sha512-65KU9Fw5fGsPPPlgIghonMcndyx1bszzrDQYLfierN+Ha29yotMHzVS94bPkZS6On9LS8dE4qmW4P/fGjtCf/g== -"@docsearch/react@^3.9.0": - version "3.9.0" - resolved "https://registry.yarnpkg.com/@docsearch/react/-/react-3.9.0.tgz#d0842b700c3ee26696786f3c8ae9f10c1a3f0db3" - integrity sha512-mb5FOZYZIkRQ6s/NWnM98k879vu5pscWqTLubLFBO87igYYT4VzVazh4h5o/zCvTIZgEt3PvsCOMOswOUo9yHQ== +"@docsearch/react@^3.9.0 || ^4.1.0": + version "4.2.0" + resolved "https://registry.yarnpkg.com/@docsearch/react/-/react-4.2.0.tgz#9dac48dfb4c1e5f18cf7323d8221d99c0d5f3e4e" + integrity sha512-zSN/KblmtBcerf7Z87yuKIHZQmxuXvYc6/m0+qnjyNu+Ir67AVOagTa1zBqcxkVUVkmBqUExdcyrdo9hbGbqTw== dependencies: - "@algolia/autocomplete-core" "1.17.9" - "@algolia/autocomplete-preset-algolia" "1.17.9" - "@docsearch/css" "3.9.0" - algoliasearch "^5.14.2" + "@ai-sdk/react" "^2.0.30" + "@algolia/autocomplete-core" "1.19.2" + "@docsearch/css" "4.2.0" + ai "^5.0.30" + algoliasearch "^5.28.0" + marked "^16.3.0" + zod "^4.1.8" -"@docusaurus/babel@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/babel/-/babel-3.8.0.tgz#2f390cc4e588a96ec496d87921e44890899738a6" - integrity sha512-9EJwSgS6TgB8IzGk1L8XddJLhZod8fXT4ULYMx6SKqyCBqCFpVCEjR/hNXXhnmtVM2irDuzYoVLGWv7srG/VOA== +"@docusaurus/babel@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/babel/-/babel-3.9.2.tgz#f956c638baeccf2040e482c71a742bc7e35fdb22" + integrity sha512-GEANdi/SgER+L7Japs25YiGil/AUDnFFHaCGPBbundxoWtCkA2lmy7/tFmgED4y1htAy6Oi4wkJEQdGssnw9MA== dependencies: "@babel/core" "^7.25.9" "@babel/generator" "^7.25.9" @@ -1405,54 +1498,54 @@ "@babel/runtime" "^7.25.9" "@babel/runtime-corejs3" "^7.25.9" "@babel/traverse" "^7.25.9" - "@docusaurus/logger" "3.8.0" - "@docusaurus/utils" "3.8.0" + "@docusaurus/logger" "3.9.2" + "@docusaurus/utils" "3.9.2" babel-plugin-dynamic-import-node "^2.3.3" fs-extra "^11.1.1" tslib "^2.6.0" -"@docusaurus/bundler@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/bundler/-/bundler-3.8.0.tgz#386f54dca594d81bac6b617c71822e0808d6e2f6" - integrity sha512-Rq4Z/MSeAHjVzBLirLeMcjLIAQy92pF1OI+2rmt18fSlMARfTGLWRE8Vb+ljQPTOSfJxwDYSzsK6i7XloD2rNA== +"@docusaurus/bundler@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/bundler/-/bundler-3.9.2.tgz#0ca82cda4acf13a493e3f66061aea351e9d356cf" + integrity sha512-ZOVi6GYgTcsZcUzjblpzk3wH1Fya2VNpd5jtHoCCFcJlMQ1EYXZetfAnRHLcyiFeBABaI1ltTYbOBtH/gahGVA== dependencies: "@babel/core" "^7.25.9" - "@docusaurus/babel" "3.8.0" - "@docusaurus/cssnano-preset" "3.8.0" - "@docusaurus/logger" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" + "@docusaurus/babel" "3.9.2" + "@docusaurus/cssnano-preset" "3.9.2" + "@docusaurus/logger" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" babel-loader "^9.2.1" - clean-css "^5.3.2" + clean-css "^5.3.3" copy-webpack-plugin "^11.0.0" - css-loader "^6.8.1" + css-loader "^6.11.0" css-minimizer-webpack-plugin "^5.0.1" cssnano "^6.1.2" file-loader "^6.2.0" html-minifier-terser "^7.2.0" - mini-css-extract-plugin "^2.9.1" + mini-css-extract-plugin "^2.9.2" null-loader "^4.0.1" - postcss "^8.4.26" - postcss-loader "^7.3.3" - postcss-preset-env "^10.1.0" + postcss "^8.5.4" + postcss-loader "^7.3.4" + postcss-preset-env "^10.2.1" terser-webpack-plugin "^5.3.9" tslib "^2.6.0" url-loader "^4.1.1" webpack "^5.95.0" webpackbar "^6.0.1" -"@docusaurus/core@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/core/-/core-3.8.0.tgz#79d5e1084415c8834a8a5cb87162ca13f52fe147" - integrity sha512-c7u6zFELmSGPEP9WSubhVDjgnpiHgDqMh1qVdCB7rTflh4Jx0msTYmMiO91Ez0KtHj4sIsDsASnjwfJ2IZp3Vw== +"@docusaurus/core@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/core/-/core-3.9.2.tgz#cc970f29b85a8926d63c84f8cffdcda43ed266ff" + integrity sha512-HbjwKeC+pHUFBfLMNzuSjqFE/58+rLVKmOU3lxQrpsxLBOGosYco/Q0GduBb0/jEMRiyEqjNT/01rRdOMWq5pw== dependencies: - "@docusaurus/babel" "3.8.0" - "@docusaurus/bundler" "3.8.0" - "@docusaurus/logger" "3.8.0" - "@docusaurus/mdx-loader" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-common" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/babel" "3.9.2" + "@docusaurus/bundler" "3.9.2" + "@docusaurus/logger" "3.9.2" + "@docusaurus/mdx-loader" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-common" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" boxen "^6.2.1" chalk "^4.1.2" chokidar "^3.5.3" @@ -1486,35 +1579,35 @@ update-notifier "^6.0.2" webpack "^5.95.0" webpack-bundle-analyzer "^4.10.2" - webpack-dev-server "^4.15.2" + webpack-dev-server "^5.2.2" webpack-merge "^6.0.1" -"@docusaurus/cssnano-preset@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/cssnano-preset/-/cssnano-preset-3.8.0.tgz#a70f19e2995be2299f5ef9c3da3e5d4d5c14bff2" - integrity sha512-UJ4hAS2T0R4WNy+phwVff2Q0L5+RXW9cwlH6AEphHR5qw3m/yacfWcSK7ort2pMMbDn8uGrD38BTm4oLkuuNoQ== +"@docusaurus/cssnano-preset@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/cssnano-preset/-/cssnano-preset-3.9.2.tgz#523aab65349db3c51a77f2489048d28527759428" + integrity sha512-8gBKup94aGttRduABsj7bpPFTX7kbwu+xh3K9NMCF5K4bWBqTFYW+REKHF6iBVDHRJ4grZdIPbvkiHd/XNKRMQ== dependencies: cssnano-preset-advanced "^6.1.2" - postcss "^8.4.38" + postcss "^8.5.4" postcss-sort-media-queries "^5.2.0" tslib "^2.6.0" -"@docusaurus/logger@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/logger/-/logger-3.8.0.tgz#c1abbb084a8058dc0047d57070fb9cd0241a679d" - integrity sha512-7eEMaFIam5Q+v8XwGqF/n0ZoCld4hV4eCCgQkfcN9Mq5inoZa6PHHW9Wu6lmgzoK5Kx3keEeABcO2SxwraoPDQ== +"@docusaurus/logger@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/logger/-/logger-3.9.2.tgz#6ec6364b90f5a618a438cc9fd01ac7376869f92a" + integrity sha512-/SVCc57ByARzGSU60c50rMyQlBuMIJCjcsJlkphxY6B0GV4UH3tcA1994N8fFfbJ9kX3jIBe/xg3XP5qBtGDbA== dependencies: chalk "^4.1.2" tslib "^2.6.0" -"@docusaurus/mdx-loader@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/mdx-loader/-/mdx-loader-3.8.0.tgz#2b225cd2b1159cc49b10b1cac63a927a8368274b" - integrity sha512-mDPSzssRnpjSdCGuv7z2EIAnPS1MHuZGTaRLwPn4oQwszu4afjWZ/60sfKjTnjBjI8Vl4OgJl2vMmfmiNDX4Ng== +"@docusaurus/mdx-loader@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/mdx-loader/-/mdx-loader-3.9.2.tgz#78d238de6c6203fa811cc2a7e90b9b79e111408c" + integrity sha512-wiYoGwF9gdd6rev62xDU8AAM8JuLI/hlwOtCzMmYcspEkzecKrP8J8X+KpYnTlACBUUtXNJpSoCwFWJhLRevzQ== dependencies: - "@docusaurus/logger" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/logger" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" "@mdx-js/mdx" "^3.0.0" "@slorber/remark-comment" "^1.0.0" escape-html "^1.0.3" @@ -1537,12 +1630,12 @@ vfile "^6.0.1" webpack "^5.88.1" -"@docusaurus/module-type-aliases@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/module-type-aliases/-/module-type-aliases-3.8.0.tgz#e487052c372538c5dcf2200999e13f328fa5ffaa" - integrity sha512-/uMb4Ipt5J/QnD13MpnoC/A4EYAe6DKNWqTWLlGrqsPJwJv73vSwkA25xnYunwfqWk0FlUQfGv/Swdh5eCCg7g== +"@docusaurus/module-type-aliases@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/module-type-aliases/-/module-type-aliases-3.9.2.tgz#993c7cb0114363dea5ef6855e989b3ad4b843a34" + integrity sha512-8qVe2QA9hVLzvnxP46ysuofJUIc/yYQ82tvA/rBTrnpXtCjNSFLxEZfd5U8cYZuJIVlkPxamsIgwd5tGZXfvew== dependencies: - "@docusaurus/types" "3.8.0" + "@docusaurus/types" "3.9.2" "@types/history" "^4.7.11" "@types/react" "*" "@types/react-router-config" "*" @@ -1550,19 +1643,19 @@ react-helmet-async "npm:@slorber/react-helmet-async@1.3.0" react-loadable "npm:@docusaurus/react-loadable@6.0.0" -"@docusaurus/plugin-content-blog@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.8.0.tgz#0c200b1fb821e09e9e975c45255e5ddfab06c392" - integrity sha512-0SlOTd9R55WEr1GgIXu+hhTT0hzARYx3zIScA5IzpdekZQesI/hKEa5LPHBd415fLkWMjdD59TaW/3qQKpJ0Lg== +"@docusaurus/plugin-content-blog@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.9.2.tgz#d5ce51eb7757bdab0515e2dd26a793ed4e119df9" + integrity sha512-3I2HXy3L1QcjLJLGAoTvoBnpOwa6DPUa3Q0dMK19UTY9mhPkKQg/DYhAGTiBUKcTR0f08iw7kLPqOhIgdV3eVQ== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/logger" "3.8.0" - "@docusaurus/mdx-loader" "3.8.0" - "@docusaurus/theme-common" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-common" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/logger" "3.9.2" + "@docusaurus/mdx-loader" "3.9.2" + "@docusaurus/theme-common" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-common" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" cheerio "1.0.0-rc.12" feed "^4.2.2" fs-extra "^11.1.1" @@ -1574,20 +1667,20 @@ utility-types "^3.10.0" webpack "^5.88.1" -"@docusaurus/plugin-content-docs@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.8.0.tgz#6aedb1261da1f0c8c2fa11cfaa6df4577a9b7826" - integrity sha512-fRDMFLbUN6eVRXcjP8s3Y7HpAt9pzPYh1F/7KKXOCxvJhjjCtbon4VJW0WndEPInVz4t8QUXn5QZkU2tGVCE2g== +"@docusaurus/plugin-content-docs@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.9.2.tgz#cd8f2d1c06e53c3fa3d24bdfcb48d237bf2d6b2e" + integrity sha512-C5wZsGuKTY8jEYsqdxhhFOe1ZDjH0uIYJ9T/jebHwkyxqnr4wW0jTkB72OMqNjsoQRcb0JN3PcSeTwFlVgzCZg== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/logger" "3.8.0" - "@docusaurus/mdx-loader" "3.8.0" - "@docusaurus/module-type-aliases" "3.8.0" - "@docusaurus/theme-common" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-common" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/logger" "3.9.2" + "@docusaurus/mdx-loader" "3.9.2" + "@docusaurus/module-type-aliases" "3.9.2" + "@docusaurus/theme-common" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-common" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" "@types/react-router-config" "^5.0.7" combine-promises "^1.1.0" fs-extra "^11.1.1" @@ -1598,148 +1691,148 @@ utility-types "^3.10.0" webpack "^5.88.1" -"@docusaurus/plugin-content-pages@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.8.0.tgz#2db5f990872684c621665d0d0d8d9b5831fd2999" - integrity sha512-39EDx2y1GA0Pxfion5tQZLNJxL4gq6susd1xzetVBjVIQtwpCdyloOfQBAgX0FylqQxfJrYqL0DIUuq7rd7uBw== +"@docusaurus/plugin-content-pages@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.9.2.tgz#22db6c88ade91cec0a9e87a00b8089898051b08d" + integrity sha512-s4849w/p4noXUrGpPUF0BPqIAfdAe76BLaRGAGKZ1gTDNiGxGcpsLcwJ9OTi1/V8A+AzvsmI9pkjie2zjIQZKA== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/mdx-loader" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/mdx-loader" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" fs-extra "^11.1.1" tslib "^2.6.0" webpack "^5.88.1" -"@docusaurus/plugin-css-cascade-layers@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-css-cascade-layers/-/plugin-css-cascade-layers-3.8.0.tgz#a0741ae32917a88ce7ce76b6f472495fa4bf576d" - integrity sha512-/VBTNymPIxQB8oA3ZQ4GFFRYdH4ZxDRRBECxyjRyv486mfUPXfcdk+im4S5mKWa6EK2JzBz95IH/Wu0qQgJ5yQ== +"@docusaurus/plugin-css-cascade-layers@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-css-cascade-layers/-/plugin-css-cascade-layers-3.9.2.tgz#358c85f63f1c6a11f611f1b8889d9435c11b22f8" + integrity sha512-w1s3+Ss+eOQbscGM4cfIFBlVg/QKxyYgj26k5AnakuHkKxH6004ZtuLe5awMBotIYF2bbGDoDhpgQ4r/kcj4rQ== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" tslib "^2.6.0" -"@docusaurus/plugin-debug@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-debug/-/plugin-debug-3.8.0.tgz#297c159ae99924e60042426d2ad6ee0d5e9126b3" - integrity sha512-teonJvJsDB9o2OnG6ifbhblg/PXzZvpUKHFgD8dOL1UJ58u0lk8o0ZOkvaYEBa9nDgqzoWrRk9w+e3qaG2mOhQ== +"@docusaurus/plugin-debug@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-debug/-/plugin-debug-3.9.2.tgz#b5df4db115583f5404a252dbf66f379ff933e53c" + integrity sha512-j7a5hWuAFxyQAkilZwhsQ/b3T7FfHZ+0dub6j/GxKNFJp2h9qk/P1Bp7vrGASnvA9KNQBBL1ZXTe7jlh4VdPdA== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" fs-extra "^11.1.1" react-json-view-lite "^2.3.0" tslib "^2.6.0" -"@docusaurus/plugin-google-analytics@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.8.0.tgz#fb97097af331beb13553a384081dc83607539b31" - integrity sha512-aKKa7Q8+3xRSRESipNvlFgNp3FNPELKhuo48Cg/svQbGNwidSHbZT03JqbW4cBaQnyyVchO1ttk+kJ5VC9Gx0w== +"@docusaurus/plugin-google-analytics@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.9.2.tgz#857fe075fdeccdf6959e62954d9efe39769fa247" + integrity sha512-mAwwQJ1Us9jL/lVjXtErXto4p4/iaLlweC54yDUK1a97WfkC6Z2k5/769JsFgwOwOP+n5mUQGACXOEQ0XDuVUw== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" tslib "^2.6.0" -"@docusaurus/plugin-google-gtag@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.8.0.tgz#b5a60006c28ac582859a469fb92e53d383b0a055" - integrity sha512-ugQYMGF4BjbAW/JIBtVcp+9eZEgT9HRdvdcDudl5rywNPBA0lct+lXMG3r17s02rrhInMpjMahN3Yc9Cb3H5/g== +"@docusaurus/plugin-google-gtag@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.9.2.tgz#df75b1a90ae9266b0471909ba0265f46d5dcae62" + integrity sha512-YJ4lDCphabBtw19ooSlc1MnxtYGpjFV9rEdzjLsUnBCeis2djUyCozZaFhCg6NGEwOn7HDDyMh0yzcdRpnuIvA== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" "@types/gtag.js" "^0.0.12" tslib "^2.6.0" -"@docusaurus/plugin-google-tag-manager@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.8.0.tgz#612aa63e161fb273bf7db2591034c0142951727d" - integrity sha512-9juRWxbwZD3SV02Jd9QB6yeN7eu+7T4zB0bvJLcVQwi+am51wAxn2CwbdL0YCCX+9OfiXbADE8D8Q65Hbopu/w== +"@docusaurus/plugin-google-tag-manager@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.9.2.tgz#d1a3cf935acb7d31b84685e92d70a1d342946677" + integrity sha512-LJtIrkZN/tuHD8NqDAW1Tnw0ekOwRTfobWPsdO15YxcicBo2ykKF0/D6n0vVBfd3srwr9Z6rzrIWYrMzBGrvNw== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" tslib "^2.6.0" -"@docusaurus/plugin-sitemap@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.8.0.tgz#a39e3b5aa2f059aba0052ed11a6b4fbf78ac0dad" - integrity sha512-fGpOIyJvNiuAb90nSJ2Gfy/hUOaDu6826e5w5UxPmbpCIc7KlBHNAZ5g4L4ZuHhc4hdfq4mzVBsQSnne+8Ze1g== +"@docusaurus/plugin-sitemap@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.9.2.tgz#e1d9f7012942562cc0c6543d3cb2cdc4ae713dc4" + integrity sha512-WLh7ymgDXjG8oPoM/T4/zUP7KcSuFYRZAUTl8vR6VzYkfc18GBM4xLhcT+AKOwun6kBivYKUJf+vlqYJkm+RHw== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/logger" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-common" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/logger" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-common" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" fs-extra "^11.1.1" sitemap "^7.1.1" tslib "^2.6.0" -"@docusaurus/plugin-svgr@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-svgr/-/plugin-svgr-3.8.0.tgz#6d2d43f14b32b4bb2dd8dc87a70c6e78754c1e85" - integrity sha512-kEDyry+4OMz6BWLG/lEqrNsL/w818bywK70N1gytViw4m9iAmoxCUT7Ri9Dgs7xUdzCHJ3OujolEmD88Wy44OA== +"@docusaurus/plugin-svgr@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-svgr/-/plugin-svgr-3.9.2.tgz#62857ed79d97c0150d25f7e7380fdee65671163a" + integrity sha512-n+1DE+5b3Lnf27TgVU5jM1d4x5tUh2oW5LTsBxJX4PsAPV0JGcmI6p3yLYtEY0LRVEIJh+8RsdQmRE66wSV8mw== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" "@svgr/core" "8.1.0" "@svgr/webpack" "^8.1.0" tslib "^2.6.0" webpack "^5.88.1" -"@docusaurus/preset-classic@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/preset-classic/-/preset-classic-3.8.0.tgz#ac8bc17e3b7b443d8a24f2f1da0c0be396950fef" - integrity sha512-qOu6tQDOWv+rpTlKu+eJATCJVGnABpRCPuqf7LbEaQ1mNY//N/P8cHQwkpAU+aweQfarcZ0XfwCqRHJfjeSV/g== +"@docusaurus/preset-classic@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/preset-classic/-/preset-classic-3.9.2.tgz#85cc4f91baf177f8146c9ce896dfa1f0fd377050" + integrity sha512-IgyYO2Gvaigi21LuDIe+nvmN/dfGXAiMcV/murFqcpjnZc7jxFAxW+9LEjdPt61uZLxG4ByW/oUmX/DDK9t/8w== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/plugin-content-blog" "3.8.0" - "@docusaurus/plugin-content-docs" "3.8.0" - "@docusaurus/plugin-content-pages" "3.8.0" - "@docusaurus/plugin-css-cascade-layers" "3.8.0" - "@docusaurus/plugin-debug" "3.8.0" - "@docusaurus/plugin-google-analytics" "3.8.0" - "@docusaurus/plugin-google-gtag" "3.8.0" - "@docusaurus/plugin-google-tag-manager" "3.8.0" - "@docusaurus/plugin-sitemap" "3.8.0" - "@docusaurus/plugin-svgr" "3.8.0" - "@docusaurus/theme-classic" "3.8.0" - "@docusaurus/theme-common" "3.8.0" - "@docusaurus/theme-search-algolia" "3.8.0" - "@docusaurus/types" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/plugin-content-blog" "3.9.2" + "@docusaurus/plugin-content-docs" "3.9.2" + "@docusaurus/plugin-content-pages" "3.9.2" + "@docusaurus/plugin-css-cascade-layers" "3.9.2" + "@docusaurus/plugin-debug" "3.9.2" + "@docusaurus/plugin-google-analytics" "3.9.2" + "@docusaurus/plugin-google-gtag" "3.9.2" + "@docusaurus/plugin-google-tag-manager" "3.9.2" + "@docusaurus/plugin-sitemap" "3.9.2" + "@docusaurus/plugin-svgr" "3.9.2" + "@docusaurus/theme-classic" "3.9.2" + "@docusaurus/theme-common" "3.9.2" + "@docusaurus/theme-search-algolia" "3.9.2" + "@docusaurus/types" "3.9.2" -"@docusaurus/theme-classic@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-classic/-/theme-classic-3.8.0.tgz#6d44fb801b86a7c7af01cda0325af1a3300b3ac2" - integrity sha512-nQWFiD5ZjoT76OaELt2n33P3WVuuCz8Dt5KFRP2fCBo2r9JCLsp2GJjZpnaG24LZ5/arRjv4VqWKgpK0/YLt7g== +"@docusaurus/theme-classic@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-classic/-/theme-classic-3.9.2.tgz#6e514f99a0ff42b80afcf42d5e5d042618311ce0" + integrity sha512-IGUsArG5hhekXd7RDb11v94ycpJpFdJPkLnt10fFQWOVxAtq5/D7hT6lzc2fhyQKaaCE62qVajOMKL7OiAFAIA== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/logger" "3.8.0" - "@docusaurus/mdx-loader" "3.8.0" - "@docusaurus/module-type-aliases" "3.8.0" - "@docusaurus/plugin-content-blog" "3.8.0" - "@docusaurus/plugin-content-docs" "3.8.0" - "@docusaurus/plugin-content-pages" "3.8.0" - "@docusaurus/theme-common" "3.8.0" - "@docusaurus/theme-translations" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-common" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/logger" "3.9.2" + "@docusaurus/mdx-loader" "3.9.2" + "@docusaurus/module-type-aliases" "3.9.2" + "@docusaurus/plugin-content-blog" "3.9.2" + "@docusaurus/plugin-content-docs" "3.9.2" + "@docusaurus/plugin-content-pages" "3.9.2" + "@docusaurus/theme-common" "3.9.2" + "@docusaurus/theme-translations" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-common" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" "@mdx-js/react" "^3.0.0" clsx "^2.0.0" - copy-text-to-clipboard "^3.2.0" infima "0.2.0-alpha.45" lodash "^4.17.21" nprogress "^0.2.0" - postcss "^8.4.26" + postcss "^8.5.4" prism-react-renderer "^2.3.0" prismjs "^1.29.0" react-router-dom "^5.3.4" @@ -1747,15 +1840,15 @@ tslib "^2.6.0" utility-types "^3.10.0" -"@docusaurus/theme-common@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-common/-/theme-common-3.8.0.tgz#102c385c3d1d3b7a6b52d1911c7e88c38d9a977e" - integrity sha512-YqV2vAWpXGLA+A3PMLrOMtqgTHJLDcT+1Caa6RF7N4/IWgrevy5diY8oIHFkXR/eybjcrFFjUPrHif8gSGs3Tw== +"@docusaurus/theme-common@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-common/-/theme-common-3.9.2.tgz#487172c6fef9815c2746ef62a71e4f5b326f9ba5" + integrity sha512-6c4DAbR6n6nPbnZhY2V3tzpnKnGL+6aOsLvFL26VRqhlczli9eWG0VDUNoCQEPnGwDMhPS42UhSAnz5pThm5Ag== dependencies: - "@docusaurus/mdx-loader" "3.8.0" - "@docusaurus/module-type-aliases" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-common" "3.8.0" + "@docusaurus/mdx-loader" "3.9.2" + "@docusaurus/module-type-aliases" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-common" "3.9.2" "@types/history" "^4.7.11" "@types/react" "*" "@types/react-router-config" "*" @@ -1765,21 +1858,21 @@ tslib "^2.6.0" utility-types "^3.10.0" -"@docusaurus/theme-search-algolia@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.8.0.tgz#21c2f18e07a73d13ca3b44fcf0ae9aac33bef60f" - integrity sha512-GBZ5UOcPgiu6nUw153+0+PNWvFKweSnvKIL6Rp04H9olKb475jfKjAwCCtju5D2xs5qXHvCMvzWOg5o9f6DtuQ== +"@docusaurus/theme-search-algolia@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.9.2.tgz#420fd5b27fc1673b48151fdc9fe7167ba135ed50" + integrity sha512-GBDSFNwjnh5/LdkxCKQHkgO2pIMX1447BxYUBG2wBiajS21uj64a+gH/qlbQjDLxmGrbrllBrtJkUHxIsiwRnw== dependencies: - "@docsearch/react" "^3.9.0" - "@docusaurus/core" "3.8.0" - "@docusaurus/logger" "3.8.0" - "@docusaurus/plugin-content-docs" "3.8.0" - "@docusaurus/theme-common" "3.8.0" - "@docusaurus/theme-translations" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" - algoliasearch "^5.17.1" - algoliasearch-helper "^3.22.6" + "@docsearch/react" "^3.9.0 || ^4.1.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/logger" "3.9.2" + "@docusaurus/plugin-content-docs" "3.9.2" + "@docusaurus/theme-common" "3.9.2" + "@docusaurus/theme-translations" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" + algoliasearch "^5.37.0" + algoliasearch-helper "^3.26.0" clsx "^2.0.0" eta "^2.2.0" fs-extra "^11.1.1" @@ -1787,26 +1880,27 @@ tslib "^2.6.0" utility-types "^3.10.0" -"@docusaurus/theme-translations@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-translations/-/theme-translations-3.8.0.tgz#deb64dccab74361624c3cb352a4949a7ac868c74" - integrity sha512-1DTy/snHicgkCkryWq54fZvsAglTdjTx4qjOXgqnXJ+DIty1B+aPQrAVUu8LiM+6BiILfmNxYsxhKTj+BS3PZg== +"@docusaurus/theme-translations@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-translations/-/theme-translations-3.9.2.tgz#238cd69c2da92d612be3d3b4f95944c1d0f1e041" + integrity sha512-vIryvpP18ON9T9rjgMRFLr2xJVDpw1rtagEGf8Ccce4CkTrvM/fRB8N2nyWYOW5u3DdjkwKw5fBa+3tbn9P4PA== dependencies: fs-extra "^11.1.1" tslib "^2.6.0" -"@docusaurus/tsconfig@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/tsconfig/-/tsconfig-3.8.0.tgz#ea7ee0917e1562cf0a6e95e049c42f1f61351f32" - integrity sha512-utLl48nNjSYBoq47RKukZ9fPLEX3nJWThzrujb0ndQQ1jc/gh4RhTRaAqItH9nImnsgGKmLMnyoMBpfGmoop+w== +"@docusaurus/tsconfig@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/tsconfig/-/tsconfig-3.9.2.tgz#7f440e0ae665b841e1d487749037f26a0275f9c1" + integrity sha512-j6/Fp4Rlpxsc632cnRnl5HpOWeb6ZKssDj6/XzzAzVGXXfm9Eptx3rxCC+fDzySn9fHTS+CWJjPineCR1bB5WQ== -"@docusaurus/types@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-3.8.0.tgz#f6cd31c4e3e392e0270b8137d7fe4365ea7a022e" - integrity sha512-RDEClpwNxZq02c+JlaKLWoS13qwWhjcNsi2wG1UpzmEnuti/z1Wx4SGpqbUqRPNSd8QWWePR8Cb7DvG0VN/TtA== +"@docusaurus/types@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-3.9.2.tgz#e482cf18faea0d1fa5ce0e3f1e28e0f32d2593eb" + integrity sha512-Ux1JUNswg+EfUEmajJjyhIohKceitY/yzjRUpu04WXgvVz+fbhVC0p+R0JhvEu4ytw8zIAys2hrdpQPBHRIa8Q== dependencies: "@mdx-js/mdx" "^3.0.0" "@types/history" "^4.7.11" + "@types/mdast" "^4.0.2" "@types/react" "*" commander "^5.1.0" joi "^17.9.2" @@ -1815,36 +1909,36 @@ webpack "^5.95.0" webpack-merge "^5.9.0" -"@docusaurus/utils-common@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/utils-common/-/utils-common-3.8.0.tgz#2b1a6b1ec4a7fac62f1898d523d42f8cc4a8258f" - integrity sha512-3TGF+wVTGgQ3pAc9+5jVchES4uXUAhAt9pwv7uws4mVOxL4alvU3ue/EZ+R4XuGk94pDy7CNXjRXpPjlfZXQfw== +"@docusaurus/utils-common@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/utils-common/-/utils-common-3.9.2.tgz#e89bfcf43d66359f43df45293fcdf22814847460" + integrity sha512-I53UC1QctruA6SWLvbjbhCpAw7+X7PePoe5pYcwTOEXD/PxeP8LnECAhTHHwWCblyUX5bMi4QLRkxvyZ+IT8Aw== dependencies: - "@docusaurus/types" "3.8.0" + "@docusaurus/types" "3.9.2" tslib "^2.6.0" -"@docusaurus/utils-validation@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/utils-validation/-/utils-validation-3.8.0.tgz#aa02e9d998e20998fbcaacd94873878bc3b9a4cd" - integrity sha512-MrnEbkigr54HkdFeg8e4FKc4EF+E9dlVwsY3XQZsNkbv3MKZnbHQ5LsNJDIKDROFe8PBf5C4qCAg5TPBpsjrjg== +"@docusaurus/utils-validation@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/utils-validation/-/utils-validation-3.9.2.tgz#04aec285604790806e2fc5aa90aa950dc7ba75ae" + integrity sha512-l7yk3X5VnNmATbwijJkexdhulNsQaNDwoagiwujXoxFbWLcxHQqNQ+c/IAlzrfMMOfa/8xSBZ7KEKDesE/2J7A== dependencies: - "@docusaurus/logger" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-common" "3.8.0" + "@docusaurus/logger" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-common" "3.9.2" fs-extra "^11.2.0" joi "^17.9.2" js-yaml "^4.1.0" lodash "^4.17.21" tslib "^2.6.0" -"@docusaurus/utils@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/utils/-/utils-3.8.0.tgz#92bad89d2a11f5f246196af153093b12cd79f9ac" - integrity sha512-2wvtG28ALCN/A1WCSLxPASFBFzXCnP0YKCAFIPcvEb6imNu1wg7ni/Svcp71b3Z2FaOFFIv4Hq+j4gD7gA0yfQ== +"@docusaurus/utils@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/utils/-/utils-3.9.2.tgz#ffab7922631c7e0febcb54e6d499f648bf8a89eb" + integrity sha512-lBSBiRruFurFKXr5Hbsl2thmGweAPmddhF3jb99U4EMDA5L+e5Y1rAkOS07Nvrup7HUMBDrCV45meaxZnt28nQ== dependencies: - "@docusaurus/logger" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils-common" "3.8.0" + "@docusaurus/logger" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils-common" "3.9.2" escape-string-regexp "^4.0.0" execa "5.1.1" file-loader "^6.2.0" @@ -1895,13 +1989,20 @@ "@types/yargs" "^17.0.8" chalk "^4.0.0" -"@jridgewell/gen-mapping@^0.3.5": - version "0.3.8" - resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.8.tgz#4f0e06362e01362f823d348f1872b08f666d8142" - integrity sha512-imAbBGkb+ebQyxKgzv5Hu2nmROxoDOXHh80evxdoXNOrvAnVx7zimzc1Oo5h9RlfV4vPXaE2iM5pOFbvOCClWA== +"@jridgewell/gen-mapping@^0.3.12", "@jridgewell/gen-mapping@^0.3.5": + version "0.3.13" + resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz#6342a19f44347518c93e43b1ac69deb3c4656a1f" + integrity sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA== dependencies: - "@jridgewell/set-array" "^1.2.1" - "@jridgewell/sourcemap-codec" "^1.4.10" + "@jridgewell/sourcemap-codec" "^1.5.0" + "@jridgewell/trace-mapping" "^0.3.24" + +"@jridgewell/remapping@^2.3.5": + version "2.3.5" + resolved "https://registry.yarnpkg.com/@jridgewell/remapping/-/remapping-2.3.5.tgz#375c476d1972947851ba1e15ae8f123047445aa1" + integrity sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ== + dependencies: + "@jridgewell/gen-mapping" "^0.3.5" "@jridgewell/trace-mapping" "^0.3.24" "@jridgewell/resolve-uri@^3.1.0": @@ -1909,46 +2010,87 @@ resolved "https://registry.yarnpkg.com/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz#7a0ee601f60f99a20c7c7c5ff0c80388c1189bd6" integrity sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw== -"@jridgewell/set-array@^1.2.1": - version "1.2.1" - resolved "https://registry.yarnpkg.com/@jridgewell/set-array/-/set-array-1.2.1.tgz#558fb6472ed16a4c850b889530e6b36438c49280" - integrity sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A== - "@jridgewell/source-map@^0.3.3": - version "0.3.6" - resolved "https://registry.yarnpkg.com/@jridgewell/source-map/-/source-map-0.3.6.tgz#9d71ca886e32502eb9362c9a74a46787c36df81a" - integrity sha512-1ZJTZebgqllO79ue2bm3rIGud/bOe0pP5BjSRCRxxYkEZS8STV7zN84UBbiYu7jy+eCKSnVIUgoWWE/tt+shMQ== + version "0.3.11" + resolved "https://registry.yarnpkg.com/@jridgewell/source-map/-/source-map-0.3.11.tgz#b21835cbd36db656b857c2ad02ebd413cc13a9ba" + integrity sha512-ZMp1V8ZFcPG5dIWnQLr3NSI1MiCU7UETdS/A0G8V/XWHvJv3ZsFqutJn1Y5RPmAPX6F3BiE397OqveU/9NCuIA== dependencies: "@jridgewell/gen-mapping" "^0.3.5" "@jridgewell/trace-mapping" "^0.3.25" -"@jridgewell/sourcemap-codec@^1.4.10", "@jridgewell/sourcemap-codec@^1.4.14": - version "1.5.0" - resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz#3188bcb273a414b0d215fd22a58540b989b9409a" - integrity sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ== +"@jridgewell/sourcemap-codec@^1.4.14", "@jridgewell/sourcemap-codec@^1.5.0": + version "1.5.5" + resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz#6912b00d2c631c0d15ce1a7ab57cd657f2a8f8ba" + integrity sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og== -"@jridgewell/trace-mapping@^0.3.18", "@jridgewell/trace-mapping@^0.3.24", "@jridgewell/trace-mapping@^0.3.25": - version "0.3.25" - resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.25.tgz#15f190e98895f3fc23276ee14bc76b675c2e50f0" - integrity sha512-vNk6aEwybGtawWmy/PzwnGDOjCkLWSD2wqvjGGAgOAwCGWySYXfYoxt00IJkTF+8Lb57DwOb3Aa0o9CApepiYQ== +"@jridgewell/trace-mapping@^0.3.18", "@jridgewell/trace-mapping@^0.3.24", "@jridgewell/trace-mapping@^0.3.25", "@jridgewell/trace-mapping@^0.3.28": + version "0.3.31" + resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz#db15d6781c931f3a251a3dac39501c98a6082fd0" + integrity sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw== dependencies: "@jridgewell/resolve-uri" "^3.1.0" "@jridgewell/sourcemap-codec" "^1.4.14" +"@jsonjoy.com/base64@^1.1.2": + version "1.1.2" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/base64/-/base64-1.1.2.tgz#cf8ea9dcb849b81c95f14fc0aaa151c6b54d2578" + integrity sha512-q6XAnWQDIMA3+FTiOYajoYqySkO+JSat0ytXGSuRdq9uXE7o92gzuQwQM14xaCRlBLGq3v5miDGC4vkVTn54xA== + +"@jsonjoy.com/buffers@^1.0.0", "@jsonjoy.com/buffers@^1.2.0": + version "1.2.1" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/buffers/-/buffers-1.2.1.tgz#8d99c7f67eaf724d3428dfd9826c6455266a5c83" + integrity sha512-12cdlDwX4RUM3QxmUbVJWqZ/mrK6dFQH4Zxq6+r1YXKXYBNgZXndx2qbCJwh3+WWkCSn67IjnlG3XYTvmvYtgA== + +"@jsonjoy.com/codegen@^1.0.0": + version "1.0.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/codegen/-/codegen-1.0.0.tgz#5c23f796c47675f166d23b948cdb889184b93207" + integrity sha512-E8Oy+08cmCf0EK/NMxpaJZmOxPqM+6iSe2S4nlSBrPZOORoDJILxtbSUEDKQyTamm/BVAhIGllOBNU79/dwf0g== + +"@jsonjoy.com/json-pack@^1.11.0": + version "1.21.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/json-pack/-/json-pack-1.21.0.tgz#93f8dd57fe3a3a92132b33d1eb182dcd9e7629fa" + integrity sha512-+AKG+R2cfZMShzrF2uQw34v3zbeDYUqnQ+jg7ORic3BGtfw9p/+N6RJbq/kkV8JmYZaINknaEQ2m0/f693ZPpg== + dependencies: + "@jsonjoy.com/base64" "^1.1.2" + "@jsonjoy.com/buffers" "^1.2.0" + "@jsonjoy.com/codegen" "^1.0.0" + "@jsonjoy.com/json-pointer" "^1.0.2" + "@jsonjoy.com/util" "^1.9.0" + hyperdyperid "^1.2.0" + thingies "^2.5.0" + tree-dump "^1.1.0" + +"@jsonjoy.com/json-pointer@^1.0.2": + version "1.0.2" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/json-pointer/-/json-pointer-1.0.2.tgz#049cb530ac24e84cba08590c5e36b431c4843408" + integrity sha512-Fsn6wM2zlDzY1U+v4Nc8bo3bVqgfNTGcn6dMgs6FjrEnt4ZCe60o6ByKRjOGlI2gow0aE/Q41QOigdTqkyK5fg== + dependencies: + "@jsonjoy.com/codegen" "^1.0.0" + "@jsonjoy.com/util" "^1.9.0" + +"@jsonjoy.com/util@^1.9.0": + version "1.9.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/util/-/util-1.9.0.tgz#7ee95586aed0a766b746cd8d8363e336c3c47c46" + integrity sha512-pLuQo+VPRnN8hfPqUTLTHk126wuYdXVxE6aDmjSeV4NCAgyxWbiOIeNJVtID3h1Vzpoi9m4jXezf73I6LgabgQ== + dependencies: + "@jsonjoy.com/buffers" "^1.0.0" + "@jsonjoy.com/codegen" "^1.0.0" + "@leichtgewicht/ip-codec@^2.0.1": version "2.0.5" resolved "https://registry.yarnpkg.com/@leichtgewicht/ip-codec/-/ip-codec-2.0.5.tgz#4fc56c15c580b9adb7dc3c333a134e540b44bfb1" integrity sha512-Vo+PSpZG2/fmgmiNzYK9qWRh8h/CHrwD0mo1h1DzL4yzHNSfWYujGTYsWGreD000gcgmZ7K4Ys6Tx9TxtsKdDw== "@mdx-js/mdx@^3.0.0": - version "3.1.0" - resolved "https://registry.yarnpkg.com/@mdx-js/mdx/-/mdx-3.1.0.tgz#10235cab8ad7d356c262e8c21c68df5850a97dc3" - integrity sha512-/QxEhPAvGwbQmy1Px8F899L5Uc2KZ6JtXwlCgJmjSTBedwOZkByYcBG4GceIGPXRDsmfxhHazuS+hlOShRLeDw== + version "3.1.1" + resolved "https://registry.yarnpkg.com/@mdx-js/mdx/-/mdx-3.1.1.tgz#c5ffd991a7536b149e17175eee57a1a2a511c6d1" + integrity sha512-f6ZO2ifpwAQIpzGWaBQT2TXxPv6z3RBzQKpVftEWN78Vl/YweF1uwussDx8ECAXVtr3Rs89fKyG9YlzUs9DyGQ== dependencies: "@types/estree" "^1.0.0" "@types/estree-jsx" "^1.0.0" "@types/hast" "^3.0.0" "@types/mdx" "^2.0.0" + acorn "^8.0.0" collapse-white-space "^2.0.0" devlop "^1.0.0" estree-util-is-identifier-name "^3.0.0" @@ -1971,9 +2113,9 @@ vfile "^6.0.0" "@mdx-js/react@^3.0.0": - version "3.1.0" - resolved "https://registry.yarnpkg.com/@mdx-js/react/-/react-3.1.0.tgz#c4522e335b3897b9a845db1dbdd2f966ae8fb0ed" - integrity sha512-QjHtSaoameoalGnKDT3FoIl4+9RwyTmo9ZJGBdLOks/YOiWHoRDI3PUwEzOE7kEmGcV3AFcp9K6dYu9rEuKLAQ== + version "3.1.1" + resolved "https://registry.yarnpkg.com/@mdx-js/react/-/react-3.1.1.tgz#24bda7fffceb2fe256f954482123cda1be5f5fef" + integrity sha512-f++rKLQgUVYDAtECQ6fn/is15GkEH9+nZPM3MS0RcxVqoTfawHvDlSCH7JbMhAM6uJ32v3eXLvLmLvjGu7PTQw== dependencies: "@types/mdx" "^2.0.0" @@ -1998,6 +2140,11 @@ "@nodelib/fs.scandir" "2.1.5" fastq "^1.6.0" +"@opentelemetry/api@1.9.0": + version "1.9.0" + resolved "https://registry.yarnpkg.com/@opentelemetry/api/-/api-1.9.0.tgz#d03eba68273dc0f7509e2a3d5cba21eae10379fe" + integrity sha512-3giAOQvZiH5F9bMlMiv8+GSPMeqg0dbaeo58/0SlA9sxSqZhnUtxzX9/2FzyhS9sWQf5S0GJE0AKBrFqjpeYcg== + "@pnpm/config.env-replace@^1.1.0": version "1.1.0" resolved "https://registry.yarnpkg.com/@pnpm/config.env-replace/-/config.env-replace-1.1.0.tgz#ab29da53df41e8948a00f2433f085f54de8b3a4c" @@ -2065,6 +2212,11 @@ micromark-util-character "^1.1.0" micromark-util-symbol "^1.0.1" +"@standard-schema/spec@^1.0.0": + version "1.0.0" + resolved "https://registry.yarnpkg.com/@standard-schema/spec/-/spec-1.0.0.tgz#f193b73dc316c4170f2e82a881da0f550d551b9c" + integrity sha512-m2bOd0f2RT9k8QJx1JN85cZYyH1RqFBdlwtkSlf4tBDYLCiiZnv1fIIwacK6cqwXavOydf0NPToMQgpKq+dVlA== + "@svgr/babel-plugin-add-jsx-attribute@8.0.0": version "8.0.0" resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-add-jsx-attribute/-/babel-plugin-add-jsx-attribute-8.0.0.tgz#4001f5d5dd87fa13303e36ee106e3ff3a7eb8b22" @@ -2184,21 +2336,21 @@ integrity sha512-L7z9BgrNEcYyUYtF+HaEfiS5ebkh9jXqbszz7pC0hRBPaatV0XjSD3+eHrpqFemQfgwiFF0QPIarnIihIDn7OA== "@types/body-parser@*": - version "1.19.5" - resolved "https://registry.yarnpkg.com/@types/body-parser/-/body-parser-1.19.5.tgz#04ce9a3b677dc8bd681a17da1ab9835dc9d3ede4" - integrity sha512-fB3Zu92ucau0iQ0JMCFQE7b/dv8Ot07NI3KaZIkIUNXq82k4eBAqUaneXfleGY9JWskeS9y+u0nXMyspcuQrCg== + version "1.19.6" + resolved "https://registry.yarnpkg.com/@types/body-parser/-/body-parser-1.19.6.tgz#1859bebb8fd7dac9918a45d54c1971ab8b5af474" + integrity sha512-HLFeCYgz89uk22N5Qg3dvGvsv46B8GLvKKo1zKG4NybA8U2DiEO3w9lqGg29t/tfLRJpJ6iQxnVw4OnB7MoM9g== dependencies: "@types/connect" "*" "@types/node" "*" -"@types/bonjour@^3.5.9": +"@types/bonjour@^3.5.13": version "3.5.13" resolved "https://registry.yarnpkg.com/@types/bonjour/-/bonjour-3.5.13.tgz#adf90ce1a105e81dd1f9c61fdc5afda1bfb92956" integrity sha512-z9fJ5Im06zvUL548KvYNecEVlA7cVDkGUi6kZusb04mpyEFKCIZJvloCcmpmLaIahDpOQGHaHmG6imtPMmPXGQ== dependencies: "@types/node" "*" -"@types/connect-history-api-fallback@^1.3.5": +"@types/connect-history-api-fallback@^1.5.4": version "1.5.4" resolved "https://registry.yarnpkg.com/@types/connect-history-api-fallback/-/connect-history-api-fallback-1.5.4.tgz#7de71645a103056b48ac3ce07b3520b819c1d5b3" integrity sha512-n6Cr2xS1h4uAulPRdlw6Jl6s1oG8KrVilPN2yUITEs+K48EzMJJ3W1xy8K5eWuFvjp3R74AOIGSmp2UfBJ8HFw== @@ -2243,25 +2395,25 @@ dependencies: "@types/estree" "*" -"@types/estree@*", "@types/estree@^1.0.0", "@types/estree@^1.0.6": - version "1.0.7" - resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.7.tgz#4158d3105276773d5b7695cd4834b1722e4f37a8" - integrity sha512-w28IoSUCJpidD/TGviZwwMJckNESJZXFu7NBZ5YJ4mEUnNraUn9Pm8HSZm/jDF1pDWYKspWE7oVphigUPRakIQ== +"@types/estree@*", "@types/estree@^1.0.0", "@types/estree@^1.0.8": + version "1.0.8" + resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.8.tgz#958b91c991b1867ced318bedea0e215ee050726e" + integrity sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w== "@types/express-serve-static-core@*", "@types/express-serve-static-core@^5.0.0": - version "5.0.6" - resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-5.0.6.tgz#41fec4ea20e9c7b22f024ab88a95c6bb288f51b8" - integrity sha512-3xhRnjJPkULekpSzgtoNYYcTWgEZkp4myc+Saevii5JPnHNvHMRlBSHDbs7Bh1iPPoVTERHEZXyhyLbMEsExsA== + version "5.1.0" + resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-5.1.0.tgz#74f47555b3d804b54cb7030e6f9aa0c7485cfc5b" + integrity sha512-jnHMsrd0Mwa9Cf4IdOzbz543y4XJepXrbia2T4b6+spXC2We3t1y6K44D3mR8XMFSXMCf3/l7rCgddfx7UNVBA== dependencies: "@types/node" "*" "@types/qs" "*" "@types/range-parser" "*" "@types/send" "*" -"@types/express-serve-static-core@^4.17.33": - version "4.19.6" - resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-4.19.6.tgz#e01324c2a024ff367d92c66f48553ced0ab50267" - integrity sha512-N4LZ2xG7DatVqhCZzOGb1Yi5lMbXSZcmdLDe9EzSndPV2HpWYWzRbaerl2n27irrm94EPpprqa8KpskPT085+A== +"@types/express-serve-static-core@^4.17.21", "@types/express-serve-static-core@^4.17.33": + version "4.19.7" + resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-4.19.7.tgz#f1d306dcc03b1aafbfb6b4fe684cce8a31cffc10" + integrity sha512-FvPtiIf1LfhzsaIXhv/PHan/2FeQBbtBDtfX2QfvPxdUelMDEckK08SM6nqo1MIZY3RUlfA+HV8+hFUSio78qg== dependencies: "@types/node" "*" "@types/qs" "*" @@ -2269,18 +2421,18 @@ "@types/send" "*" "@types/express@*": - version "5.0.2" - resolved "https://registry.yarnpkg.com/@types/express/-/express-5.0.2.tgz#7be9e337a5745d6b43ef5b0c352dad94a7f0c256" - integrity sha512-BtjL3ZwbCQriyb0DGw+Rt12qAXPiBTPs815lsUvtt1Grk0vLRMZNMUZ741d5rjk+UQOxfDiBZ3dxpX00vSkK3g== + version "5.0.3" + resolved "https://registry.yarnpkg.com/@types/express/-/express-5.0.3.tgz#6c4bc6acddc2e2a587142e1d8be0bce20757e956" + integrity sha512-wGA0NX93b19/dZC1J18tKWVIYWyyF2ZjT9vin/NRu0qzzvfVzWjs04iq2rQ3H65vCTQYlRqs3YHfY7zjdV+9Kw== dependencies: "@types/body-parser" "*" "@types/express-serve-static-core" "^5.0.0" "@types/serve-static" "*" -"@types/express@^4.17.13": - version "4.17.22" - resolved "https://registry.yarnpkg.com/@types/express/-/express-4.17.22.tgz#14cfcf120f7eb56ebb8ca77b7fa9a14d21de7c96" - integrity sha512-eZUmSnhRX9YRSkplpz0N+k6NljUUn5l3EWZIKZvYzhvMphEuNiyyy1viH/ejgt66JWgALwC/gtSUAeQKtSwW/w== +"@types/express@^4.17.21": + version "4.17.23" + resolved "https://registry.yarnpkg.com/@types/express/-/express-4.17.23.tgz#35af3193c640bfd4d7fe77191cd0ed411a433bef" + integrity sha512-Crp6WY9aTYP3qPi2wGDo9iUe/rceX01UMhnF1jmwDcKCFM6cx7YhGP/Mpr3y9AASpfHixIG0E6azCcL5OcDHsQ== dependencies: "@types/body-parser" "*" "@types/express-serve-static-core" "^4.17.33" @@ -2315,9 +2467,9 @@ integrity sha512-1m0bIFVc7eJWyve9S0RnuRgcQqF/Xd5QsUZAZeQFr1Q3/p9JWoQQEqmVy+DPTNpGXwhgIetAoYF8JSc33q29QA== "@types/http-errors@*": - version "2.0.4" - resolved "https://registry.yarnpkg.com/@types/http-errors/-/http-errors-2.0.4.tgz#7eb47726c391b7345a6ec35ad7f4de469cf5ba4f" - integrity sha512-D0CFMMtydbJAegzOyHjtiKPLlvnm3iTZyZRSZoLq2mRhDdmLfIWOCYPfQJ4cu2erKghU++QvjcUjp/5h7hESpA== + version "2.0.5" + resolved "https://registry.yarnpkg.com/@types/http-errors/-/http-errors-2.0.5.tgz#5b749ab2b16ba113423feb1a64a95dcd30398472" + integrity sha512-r8Tayk8HJnX0FztbZN7oVqGccWgw98T/0neJphO91KkmOzug1KkofZURD4UaD5uH8AqcFLfdPErnBod0u71/qg== "@types/http-proxy@^1.17.8": version "1.17.16" @@ -2373,18 +2525,18 @@ integrity sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA== "@types/node-forge@^1.3.0": - version "1.3.11" - resolved "https://registry.yarnpkg.com/@types/node-forge/-/node-forge-1.3.11.tgz#0972ea538ddb0f4d9c2fa0ec5db5724773a604da" - integrity sha512-FQx220y22OKNTqaByeBGqHWYz4cl94tpcxeFdvBo3wjG6XPBuZ0BNgNZRV5J5TFmmcsJ4IzsLkmGRiQbnYsBEQ== + version "1.3.14" + resolved "https://registry.yarnpkg.com/@types/node-forge/-/node-forge-1.3.14.tgz#006c2616ccd65550560c2757d8472eb6d3ecea0b" + integrity sha512-mhVF2BnD4BO+jtOp7z1CdzaK4mbuK0LLQYAvdOLqHTavxFNq4zA1EmYkpnFjP8HOUzedfQkRnp0E2ulSAYSzAw== dependencies: "@types/node" "*" "@types/node@*": - version "22.15.21" - resolved "https://registry.yarnpkg.com/@types/node/-/node-22.15.21.tgz#196ef14fe20d87f7caf1e7b39832767f9a995b77" - integrity sha512-EV/37Td6c+MgKAbkcLG6vqZ2zEYHD7bvSrzqqs2RIhbA6w3x+Dqz8MZM3sP6kGTeLrdoOgKZe+Xja7tUB2DNkQ== + version "24.8.1" + resolved "https://registry.yarnpkg.com/@types/node/-/node-24.8.1.tgz#74c8ae00b045a0a351f2837ec00f25dfed0053be" + integrity sha512-alv65KGRadQVfVcG69MuB4IzdYVpRwMG/mq8KWOaoOdyY617P5ivaDiMCGOFDWD2sAn5Q0mR3mRtUOgm99hL9Q== dependencies: - undici-types "~6.21.0" + undici-types "~7.14.0" "@types/node@^17.0.5": version "17.0.45" @@ -2433,16 +2585,16 @@ "@types/react" "*" "@types/react@*": - version "19.1.6" - resolved "https://registry.yarnpkg.com/@types/react/-/react-19.1.6.tgz#dee39f3e1e9a7d693f156a5840570b6d57f325ea" - integrity sha512-JeG0rEWak0N6Itr6QUx+X60uQmN+5t3j9r/OVDtWzFXKaj6kD1BwJzOksD0FF6iWxZlbE1kB0q9vtnU2ekqa1Q== + version "19.2.2" + resolved "https://registry.yarnpkg.com/@types/react/-/react-19.2.2.tgz#ba123a75d4c2a51158697160a4ea2ff70aa6bf36" + integrity sha512-6mDvHUFSjyT2B2yeNx2nUgMxh9LtOWvkhIU3uePn2I2oyNymUAX1NIsdgviM4CH+JSrp2D2hsMvJOkxY+0wNRA== dependencies: csstype "^3.0.2" -"@types/retry@0.12.0": - version "0.12.0" - resolved "https://registry.yarnpkg.com/@types/retry/-/retry-0.12.0.tgz#2b35eccfcee7d38cd72ad99232fbd58bffb3c84d" - integrity sha512-wWKOClTTiizcZhXnPY4wikVAwmdYHp8q6DmC+EJUzAMsycb7HB32Kh9RN4+0gExjmPmZSAQjgURXIGATPegAvA== +"@types/retry@0.12.2": + version "0.12.2" + resolved "https://registry.yarnpkg.com/@types/retry/-/retry-0.12.2.tgz#ed279a64fa438bb69f2480eda44937912bb7480a" + integrity sha512-XISRgDJ2Tc5q4TRqvgJtzsRkFYNJzZrhTdtMoGVBttwzzQJkPnS3WWTFc7kuDRoPtPakl+T+OfdEUjYJj7Jbow== "@types/sax@^1.2.1": version "1.2.7" @@ -2452,30 +2604,37 @@ "@types/node" "*" "@types/send@*": - version "0.17.4" - resolved "https://registry.yarnpkg.com/@types/send/-/send-0.17.4.tgz#6619cd24e7270793702e4e6a4b958a9010cfc57a" - integrity sha512-x2EM6TJOybec7c52BX0ZspPodMsQUd5L6PRwOunVyVUhXiBSKf3AezDL8Dgvgt5o0UfKNfuA0eMLr2wLT4AiBA== + version "1.2.0" + resolved "https://registry.yarnpkg.com/@types/send/-/send-1.2.0.tgz#ae9dfa0e3ab0306d3c566182324a54c4be2fb45a" + integrity sha512-zBF6vZJn1IaMpg3xUF25VK3gd3l8zwE0ZLRX7dsQyQi+jp4E8mMDJNGDYnYse+bQhYwWERTxVwHpi3dMOq7RKQ== + dependencies: + "@types/node" "*" + +"@types/send@<1": + version "0.17.5" + resolved "https://registry.yarnpkg.com/@types/send/-/send-0.17.5.tgz#d991d4f2b16f2b1ef497131f00a9114290791e74" + integrity sha512-z6F2D3cOStZvuk2SaP6YrwkNO65iTZcwA2ZkSABegdkAh/lf+Aa/YQndZVfmEXT5vgAp6zv06VQ3ejSVjAny4w== dependencies: "@types/mime" "^1" "@types/node" "*" -"@types/serve-index@^1.9.1": +"@types/serve-index@^1.9.4": version "1.9.4" resolved "https://registry.yarnpkg.com/@types/serve-index/-/serve-index-1.9.4.tgz#e6ae13d5053cb06ed36392110b4f9a49ac4ec898" integrity sha512-qLpGZ/c2fhSs5gnYsQxtDEq3Oy8SXPClIXkW5ghvAvsNuVSA8k+gCONcUCS/UjLEYvYps+e8uBtfgXgvhwfNug== dependencies: "@types/express" "*" -"@types/serve-static@*", "@types/serve-static@^1.13.10": - version "1.15.7" - resolved "https://registry.yarnpkg.com/@types/serve-static/-/serve-static-1.15.7.tgz#22174bbd74fb97fe303109738e9b5c2f3064f714" - integrity sha512-W8Ym+h8nhuRwaKPaDw34QUkwsGi6Rc4yYqvKFo5rm2FUEhCFbzVWrxXUxuKK8TASjWsysJY0nsmNCGhCOIsrOw== +"@types/serve-static@*", "@types/serve-static@^1.15.5": + version "1.15.9" + resolved "https://registry.yarnpkg.com/@types/serve-static/-/serve-static-1.15.9.tgz#f9b08ab7dd8bbb076f06f5f983b683654fe0a025" + integrity sha512-dOTIuqpWLyl3BBXU3maNQsS4A3zuuoYRNIvYSxxhebPfXg2mzWQEPne/nlJ37yOse6uGgR386uTpdsx4D0QZWA== dependencies: "@types/http-errors" "*" "@types/node" "*" - "@types/send" "*" + "@types/send" "<1" -"@types/sockjs@^0.3.33": +"@types/sockjs@^0.3.36": version "0.3.36" resolved "https://registry.yarnpkg.com/@types/sockjs/-/sockjs-0.3.36.tgz#ce322cf07bcc119d4cbf7f88954f3a3bd0f67535" integrity sha512-MK9V6NzAS1+Ud7JV9lJLFqW85VbC9dq3LmwZCuBe4wBDgKC0Kj/jd8Xl+nSviU+Qc3+m7umHHyHg//2KSa0a0Q== @@ -2492,7 +2651,7 @@ resolved "https://registry.yarnpkg.com/@types/unist/-/unist-2.0.11.tgz#11af57b127e32487774841f7a4e54eab166d03c4" integrity sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA== -"@types/ws@^8.5.5": +"@types/ws@^8.5.10": version "8.18.1" resolved "https://registry.yarnpkg.com/@types/ws/-/ws-8.18.1.tgz#48464e4bf2ddfd17db13d845467f6070ffea4aa9" integrity sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg== @@ -2516,6 +2675,11 @@ resolved "https://registry.yarnpkg.com/@ungap/structured-clone/-/structured-clone-1.3.0.tgz#d06bbb384ebcf6c505fde1c3d0ed4ddffe0aaff8" integrity sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g== +"@vercel/oidc@3.0.3": + version "3.0.3" + resolved "https://registry.yarnpkg.com/@vercel/oidc/-/oidc-3.0.3.tgz#82c2b6dd4d5c3b37dcb1189718cdeb9db402d052" + integrity sha512-yNEQvPcVrK9sIe637+I0jD6leluPxzwJKx/Haw6F4H77CdDsszUn5V3o96LPziXkSNE2B83+Z3mjqGKBK/R6Gg== + "@webassemblyjs/ast@1.14.1", "@webassemblyjs/ast@^1.14.1": version "1.14.1" resolved "https://registry.yarnpkg.com/@webassemblyjs/ast/-/ast-1.14.1.tgz#a9f6a07f2b03c95c8d38c4536a1fdfb521ff55b6" @@ -2655,6 +2819,11 @@ accepts@~1.3.4, accepts@~1.3.8: mime-types "~2.1.34" negotiator "0.6.3" +acorn-import-phases@^1.0.3: + version "1.0.4" + resolved "https://registry.yarnpkg.com/acorn-import-phases/-/acorn-import-phases-1.0.4.tgz#16eb850ba99a056cb7cbfe872ffb8972e18c8bd7" + integrity sha512-wKmbr/DDiIXzEOiWrTTUcDm24kQ2vGfZQvM2fwg2vXqR5uW6aapr7ObPtj1th32b9u90/Pf4AItvdTh42fBmVQ== + acorn-jsx@^5.0.0: version "5.3.2" resolved "https://registry.yarnpkg.com/acorn-jsx/-/acorn-jsx-5.3.2.tgz#7ed5bb55908b3b2f1bc55c6af1653bada7f07937" @@ -2667,10 +2836,10 @@ acorn-walk@^8.0.0: dependencies: acorn "^8.11.0" -acorn@^8.0.0, acorn@^8.0.4, acorn@^8.11.0, acorn@^8.14.0: - version "8.14.1" - resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.14.1.tgz#721d5dc10f7d5b5609a891773d47731796935dfb" - integrity sha512-OvQ/2pUDKmgfCg++xsTX1wGxfTaszcHVcTctW4UJB4hibJx2HXxxO5UmVgyjMa+ZDsiaf5wWLXYpRWMmBI0QHg== +acorn@^8.0.0, acorn@^8.0.4, acorn@^8.11.0, acorn@^8.15.0: + version "8.15.0" + resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.15.0.tgz#a360898bc415edaac46c8241f6383975b930b816" + integrity sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg== address@^1.0.1: version "1.2.2" @@ -2685,6 +2854,16 @@ aggregate-error@^3.0.0: clean-stack "^2.0.0" indent-string "^4.0.0" +ai@5.0.76, ai@^5.0.30: + version "5.0.76" + resolved "https://registry.yarnpkg.com/ai/-/ai-5.0.76.tgz#cb34925808ecf557120aaa7648026c4b2d232d5d" + integrity sha512-ZCxi1vrpyCUnDbtYrO/W8GLvyacV9689f00yshTIQ3mFFphbD7eIv40a2AOZBv3GGRA7SSRYIDnr56wcS/gyQg== + dependencies: + "@ai-sdk/gateway" "2.0.0" + "@ai-sdk/provider" "2.0.0" + "@ai-sdk/provider-utils" "3.0.12" + "@opentelemetry/api" "1.9.0" + ajv-formats@^2.1.1: version "2.1.1" resolved "https://registry.yarnpkg.com/ajv-formats/-/ajv-formats-2.1.1.tgz#6e669400659eb74973bbf2e33327180a0996b520" @@ -2724,31 +2903,32 @@ ajv@^8.0.0, ajv@^8.9.0: json-schema-traverse "^1.0.0" require-from-string "^2.0.2" -algoliasearch-helper@^3.22.6: - version "3.25.0" - resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.25.0.tgz#15cc79ad7909db66b8bb5a5a9c38b40e3941fa2f" - integrity sha512-vQoK43U6HXA9/euCqLjvyNdM4G2Fiu/VFp4ae0Gau9sZeIKBPvUPnXfLYAe65Bg7PFuw03coeu5K6lTPSXRObw== +algoliasearch-helper@^3.26.0: + version "3.26.0" + resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.26.0.tgz#d6e283396a9fc5bf944f365dc3b712570314363f" + integrity sha512-Rv2x3GXleQ3ygwhkhJubhhYGsICmShLAiqtUuJTUkr9uOCOXyF2E71LVT4XDnVffbknv8XgScP4U0Oxtgm+hIw== dependencies: "@algolia/events" "^4.0.1" -algoliasearch@^5.14.2, algoliasearch@^5.17.1: - version "5.25.0" - resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-5.25.0.tgz#7337b097deadeca0e6e985c0f8724abea189994f" - integrity sha512-n73BVorL4HIwKlfJKb4SEzAYkR3Buwfwbh+MYxg2mloFph2fFGV58E90QTzdbfzWrLn4HE5Czx/WTjI8fcHaMg== +algoliasearch@^5.28.0, algoliasearch@^5.37.0: + version "5.40.1" + resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-5.40.1.tgz#e46565cb473fa967a12191398e2ddfa2596bf82b" + integrity sha512-iUNxcXUNg9085TJx0HJLjqtDE0r1RZ0GOGrt8KNQqQT5ugu8lZsHuMUYW/e0lHhq6xBvmktU9Bw4CXP9VQeKrg== dependencies: - "@algolia/client-abtesting" "5.25.0" - "@algolia/client-analytics" "5.25.0" - "@algolia/client-common" "5.25.0" - "@algolia/client-insights" "5.25.0" - "@algolia/client-personalization" "5.25.0" - "@algolia/client-query-suggestions" "5.25.0" - "@algolia/client-search" "5.25.0" - "@algolia/ingestion" "1.25.0" - "@algolia/monitoring" "1.25.0" - "@algolia/recommend" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/abtesting" "1.6.1" + "@algolia/client-abtesting" "5.40.1" + "@algolia/client-analytics" "5.40.1" + "@algolia/client-common" "5.40.1" + "@algolia/client-insights" "5.40.1" + "@algolia/client-personalization" "5.40.1" + "@algolia/client-query-suggestions" "5.40.1" + "@algolia/client-search" "5.40.1" + "@algolia/ingestion" "1.40.1" + "@algolia/monitoring" "1.40.1" + "@algolia/recommend" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" ansi-align@^3.0.1: version "3.0.1" @@ -2775,9 +2955,9 @@ ansi-regex@^5.0.1: integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== ansi-regex@^6.0.1: - version "6.1.0" - resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.1.0.tgz#95ec409c69619d6cb1b8b34f14b660ef28ebd654" - integrity sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA== + version "6.2.2" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.2.2.tgz#60216eea464d864597ce2832000738a0589650c1" + integrity sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg== ansi-styles@^4.0.0, ansi-styles@^4.1.0: version "4.3.0" @@ -2787,9 +2967,9 @@ ansi-styles@^4.0.0, ansi-styles@^4.1.0: color-convert "^2.0.1" ansi-styles@^6.1.0: - version "6.2.1" - resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-6.2.1.tgz#0e62320cf99c21afff3b3012192546aacbfb05c5" - integrity sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug== + version "6.2.3" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-6.2.3.tgz#c044d5dcc521a076413472597a1acb1f103c4041" + integrity sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg== anymatch@~3.1.2: version "3.1.3" @@ -2858,29 +3038,29 @@ babel-plugin-dynamic-import-node@^2.3.3: dependencies: object.assign "^4.1.0" -babel-plugin-polyfill-corejs2@^0.4.10: - version "0.4.13" - resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.13.tgz#7d445f0e0607ebc8fb6b01d7e8fb02069b91dd8b" - integrity sha512-3sX/eOms8kd3q2KZ6DAhKPc0dgm525Gqq5NtWKZ7QYYZEv57OQ54KtblzJzH1lQF/eQxO8KjWGIK9IPUJNus5g== +babel-plugin-polyfill-corejs2@^0.4.14: + version "0.4.14" + resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.14.tgz#8101b82b769c568835611542488d463395c2ef8f" + integrity sha512-Co2Y9wX854ts6U8gAAPXfn0GmAyctHuK8n0Yhfjd6t30g7yvKjspvvOo9yG+z52PZRgFErt7Ka2pYnXCjLKEpg== dependencies: - "@babel/compat-data" "^7.22.6" - "@babel/helper-define-polyfill-provider" "^0.6.4" + "@babel/compat-data" "^7.27.7" + "@babel/helper-define-polyfill-provider" "^0.6.5" semver "^6.3.1" -babel-plugin-polyfill-corejs3@^0.11.0: - version "0.11.1" - resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.11.1.tgz#4e4e182f1bb37c7ba62e2af81d8dd09df31344f6" - integrity sha512-yGCqvBT4rwMczo28xkH/noxJ6MZ4nJfkVYdoDaC/utLtWrXxv27HVrzAeSbqR8SxDsp46n0YF47EbHoixy6rXQ== +babel-plugin-polyfill-corejs3@^0.13.0: + version "0.13.0" + resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.13.0.tgz#bb7f6aeef7addff17f7602a08a6d19a128c30164" + integrity sha512-U+GNwMdSFgzVmfhNm8GJUX88AadB3uo9KpJqS3FaqNIPKgySuvMb+bHPsOmmuWyIcuqZj/pzt1RUIUZns4y2+A== dependencies: - "@babel/helper-define-polyfill-provider" "^0.6.3" - core-js-compat "^3.40.0" + "@babel/helper-define-polyfill-provider" "^0.6.5" + core-js-compat "^3.43.0" -babel-plugin-polyfill-regenerator@^0.6.1: - version "0.6.4" - resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.4.tgz#428c615d3c177292a22b4f93ed99e358d7906a9b" - integrity sha512-7gD3pRadPrbjhjLyxebmx/WrFYcuSjZ0XbdUujQMZ/fcE9oeewk2U/7PCvez84UeuK3oSjmPZ0Ch0dlupQvGzw== +babel-plugin-polyfill-regenerator@^0.6.5: + version "0.6.5" + resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.5.tgz#32752e38ab6f6767b92650347bf26a31b16ae8c5" + integrity sha512-ISqQ2frbiNU9vIJkzg7dlPpznPZ4jOiUQ1uSmB0fEHeowtN3COYRsXr/xexn64NpU13P06jc/L5TgiJXOgrbEg== dependencies: - "@babel/helper-define-polyfill-provider" "^0.6.4" + "@babel/helper-define-polyfill-provider" "^0.6.5" bail@^2.0.0: version "2.0.2" @@ -2892,6 +3072,11 @@ balanced-match@^1.0.0: resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== +baseline-browser-mapping@^2.8.9: + version "2.8.17" + resolved "https://registry.yarnpkg.com/baseline-browser-mapping/-/baseline-browser-mapping-2.8.17.tgz#85aff3f7dd6326ea25b77ce834b96bb698545dc6" + integrity sha512-j5zJcx6golJYTG6c05LUZ3Z8Gi+M62zRT/ycz4Xq4iCOdpcxwg7ngEYD4KA0eWZC7U17qh/Smq8bYbACJ0ipBA== + batch@0.6.1: version "0.6.1" resolved "https://registry.yarnpkg.com/batch/-/batch-0.6.1.tgz#dc34314f4e679318093fc760272525f94bf25c16" @@ -2925,7 +3110,7 @@ body-parser@1.20.3: type-is "~1.6.18" unpipe "1.0.0" -bonjour-service@^1.0.11: +bonjour-service@^1.2.1: version "1.3.0" resolved "https://registry.yarnpkg.com/bonjour-service/-/bonjour-service-1.3.0.tgz#80d867430b5a0da64e82a8047fc1e355bdb71722" integrity sha512-3YuAUiSkWykd+2Azjgyxei8OWf8thdn8AITIog2M4UICzoqfjlqr64WIjEXZllf/W6vK1goqleSR6brGomxQqA== @@ -2967,9 +3152,9 @@ boxen@^7.0.0: wrap-ansi "^8.1.0" brace-expansion@^1.1.7: - version "1.1.11" - resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.11.tgz#3c7fcbf529d87226f3d2f52b966ff5271eb441dd" - integrity sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA== + version "1.1.12" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.12.tgz#ab9b454466e5a8cc3a187beaad580412a9c5b843" + integrity sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg== dependencies: balanced-match "^1.0.0" concat-map "0.0.1" @@ -2981,14 +3166,15 @@ braces@^3.0.3, braces@~3.0.2: dependencies: fill-range "^7.1.1" -browserslist@^4.0.0, browserslist@^4.23.0, browserslist@^4.24.0, browserslist@^4.24.4: - version "4.24.5" - resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.24.5.tgz#aa0f5b8560fe81fde84c6dcb38f759bafba0e11b" - integrity sha512-FDToo4Wo82hIdgc1CQ+NQD0hEhmpPjrZ3hiUgwgOG6IuTdlpr8jdjyG24P6cNP1yJpTLzS5OcGgSw0xmDU1/Tw== +browserslist@^4.0.0, browserslist@^4.23.0, browserslist@^4.24.0, browserslist@^4.24.4, browserslist@^4.26.0, browserslist@^4.26.3: + version "4.26.3" + resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.26.3.tgz#40fbfe2d1cd420281ce5b1caa8840049c79afb56" + integrity sha512-lAUU+02RFBuCKQPj/P6NgjlbCnLBMp4UtgTx7vNHd3XSIJF87s9a5rA3aH2yw3GS9DqZAUbOtZdCCiZeVRqt0w== dependencies: - caniuse-lite "^1.0.30001716" - electron-to-chromium "^1.5.149" - node-releases "^2.0.19" + baseline-browser-mapping "^2.8.9" + caniuse-lite "^1.0.30001746" + electron-to-chromium "^1.5.227" + node-releases "^2.0.21" update-browserslist-db "^1.1.3" buffer-from@^1.0.0: @@ -2996,6 +3182,13 @@ buffer-from@^1.0.0: resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.1.2.tgz#2b146a6fd72e80b4f55d255f35ed59a3a9a41bd5" integrity sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ== +bundle-name@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/bundle-name/-/bundle-name-4.1.0.tgz#f3b96b34160d6431a19d7688135af7cfb8797889" + integrity sha512-tjwM5exMg6BGRI+kNmTntNsvdZS1X8BFYS6tnJ2hdH0kVxM6/eVZ2xy+FqStSWvYmtfFMDLIxurorHwDKfDz5Q== + dependencies: + run-applescript "^7.0.0" + bytes@3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/bytes/-/bytes-3.0.0.tgz#d32815404d689699f85a4ea4fa8755dd13a96048" @@ -3083,10 +3276,10 @@ caniuse-api@^3.0.0: lodash.memoize "^4.1.2" lodash.uniq "^4.5.0" -caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001702, caniuse-lite@^1.0.30001716: - version "1.0.30001718" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001718.tgz#dae13a9c80d517c30c6197515a96131c194d8f82" - integrity sha512-AflseV1ahcSunK53NfEs9gFWgOEmzr0f+kaMFA4xiLZlr9Hzt7HxcSpIFcnNCUkz6R6dWKa54rUz3HUmI3nVcw== +caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001702, caniuse-lite@^1.0.30001746: + version "1.0.30001751" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001751.tgz#dacd5d9f4baeea841641640139d2b2a4df4226ad" + integrity sha512-A0QJhug0Ly64Ii3eIqHu5X51ebln3k4yTUkY1j8drqpWHVreg/VLijN48cZ1bYPiqOQuqpkIKnzr/Ul8V+p6Cw== ccount@^2.0.0: version "2.0.1" @@ -3102,9 +3295,9 @@ chalk@^4.0.0, chalk@^4.1.2: supports-color "^7.1.0" chalk@^5.0.1, chalk@^5.2.0: - version "5.4.1" - resolved "https://registry.yarnpkg.com/chalk/-/chalk-5.4.1.tgz#1b48bf0963ec158dce2aacf69c093ae2dd2092d8" - integrity sha512-zgVZuo2WcZgfUEmsn6eO3kINexW8RAE4maiQ8QNs8CtpPCSyMiYsULR3HQYkm3w8FIA3SberyMJMSldGsW+U3w== + version "5.6.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-5.6.2.tgz#b1238b6e23ea337af71c7f8a295db5af0c158aea" + integrity sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA== char-regex@^1.0.2: version "1.0.2" @@ -3156,7 +3349,7 @@ cheerio@1.0.0-rc.12: parse5 "^7.0.0" parse5-htmlparser2-tree-adapter "^7.0.0" -chokidar@^3.5.3: +chokidar@^3.5.3, chokidar@^3.6.0: version "3.6.0" resolved "https://registry.yarnpkg.com/chokidar/-/chokidar-3.6.0.tgz#197c6cc669ef2a8dc5e7b4d97ee4e092c3eb0d5b" integrity sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw== @@ -3181,7 +3374,7 @@ ci-info@^3.2.0: resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-3.9.0.tgz#4279a62028a7b1f262f3473fc9605f5e218c59b4" integrity sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ== -clean-css@^5.2.2, clean-css@^5.3.2, clean-css@~5.3.2: +clean-css@^5.2.2, clean-css@^5.3.3, clean-css@~5.3.2: version "5.3.3" resolved "https://registry.yarnpkg.com/clean-css/-/clean-css-5.3.3.tgz#b330653cd3bd6b75009cc25c714cae7b93351ccd" integrity sha512-D5J+kHaVb/wKSFcyyV75uCn8fiY4sV38XJoe4CUyGQ+mOU/fMVYUdH1hJC+CJQ5uY3EnW27SbJYS4X8BiLrAFg== @@ -3296,15 +3489,15 @@ compressible@~2.0.18: mime-db ">= 1.43.0 < 2" compression@^1.7.4: - version "1.8.0" - resolved "https://registry.yarnpkg.com/compression/-/compression-1.8.0.tgz#09420efc96e11a0f44f3a558de59e321364180f7" - integrity sha512-k6WLKfunuqCYD3t6AsuPGvQWaKwuLLh2/xHNcX4qE+vIfDNXpSqnrhwA7O53R7WVQUnt8dVAIW+YHr7xTgOgGA== + version "1.8.1" + resolved "https://registry.yarnpkg.com/compression/-/compression-1.8.1.tgz#4a45d909ac16509195a9a28bd91094889c180d79" + integrity sha512-9mAqGPHLakhCLeNyxPkK4xVo746zQ/czLH1Ky+vkitMnWfWZps8r0qXuwhwizagCRttsL4lfG4pIOvaWLpAP0w== dependencies: bytes "3.1.2" compressible "~2.0.18" debug "2.6.9" negotiator "~0.6.4" - on-headers "~1.0.2" + on-headers "~1.1.0" safe-buffer "5.2.1" vary "~1.1.2" @@ -3374,11 +3567,6 @@ cookie@0.7.1: resolved "https://registry.yarnpkg.com/cookie/-/cookie-0.7.1.tgz#2f73c42142d5d5cf71310a74fc4ae61670e5dbc9" integrity sha512-6DnInpx7SJ2AK3+CTUE/ZM0vWTUboZCegxhC2xiIydHR9jNuTAASBrfEpHhiGOZw/nX51bHt6YQl8jsGo4y/0w== -copy-text-to-clipboard@^3.2.0: - version "3.2.0" - resolved "https://registry.yarnpkg.com/copy-text-to-clipboard/-/copy-text-to-clipboard-3.2.0.tgz#0202b2d9bdae30a49a53f898626dcc3b49ad960b" - integrity sha512-RnJFp1XR/LOBDckxTib5Qjr/PMfkatD0MUCQgdpqS8MdKiNUzBjAQBEN6oUy+jW7LI93BBG3DtMB2KOOKpGs2Q== - copy-webpack-plugin@^11.0.0: version "11.0.0" resolved "https://registry.yarnpkg.com/copy-webpack-plugin/-/copy-webpack-plugin-11.0.0.tgz#96d4dbdb5f73d02dd72d0528d1958721ab72e04a" @@ -3391,22 +3579,22 @@ copy-webpack-plugin@^11.0.0: schema-utils "^4.0.0" serialize-javascript "^6.0.0" -core-js-compat@^3.40.0: - version "3.42.0" - resolved "https://registry.yarnpkg.com/core-js-compat/-/core-js-compat-3.42.0.tgz#ce19c29706ee5806e26d3cb3c542d4cfc0ed51bb" - integrity sha512-bQasjMfyDGyaeWKBIu33lHh9qlSR0MFE/Nmc6nMjf/iU9b3rSMdAYz1Baxrv4lPdGUsTqZudHA4jIGSJy0SWZQ== +core-js-compat@^3.43.0: + version "3.46.0" + resolved "https://registry.yarnpkg.com/core-js-compat/-/core-js-compat-3.46.0.tgz#0c87126a19a1af00371e12b02a2b088a40f3c6f7" + integrity sha512-p9hObIIEENxSV8xIu+V68JjSeARg6UVMG5mR+JEUguG3sI6MsiS1njz2jHmyJDvA+8jX/sytkBHup6kxhM9law== dependencies: - browserslist "^4.24.4" + browserslist "^4.26.3" -core-js-pure@^3.30.2: - version "3.42.0" - resolved "https://registry.yarnpkg.com/core-js-pure/-/core-js-pure-3.42.0.tgz#e86c45a7f3bdcb608823e872f73d1ad9ddf0531d" - integrity sha512-007bM04u91fF4kMgwom2I5cQxAFIy8jVulgr9eozILl/SZE53QOqnW/+vviC+wQWLv+AunBG+8Q0TLoeSsSxRQ== +core-js-pure@^3.43.0: + version "3.46.0" + resolved "https://registry.yarnpkg.com/core-js-pure/-/core-js-pure-3.46.0.tgz#9bb80248584c6334bb54cd381b0f41c619ef1b43" + integrity sha512-NMCW30bHNofuhwLhYPt66OLOKTMbOhgTTatKVbaQC3KRHpTCiRIBYvtshr+NBYSnBxwAFhjW/RfJ0XbIjS16rw== core-js@^3.31.1: - version "3.42.0" - resolved "https://registry.yarnpkg.com/core-js/-/core-js-3.42.0.tgz#edbe91f78ac8cfb6df8d997e74d368a68082fe37" - integrity sha512-Sz4PP4ZA+Rq4II21qkNqOEDTDrCvcANId3xpIgB34NDkWc3UduWj2dqEtN9yZIq8Dk3HyPI33x9sqqU5C8sr0g== + version "3.46.0" + resolved "https://registry.yarnpkg.com/core-js/-/core-js-3.46.0.tgz#323a092b96381a9184d0cd49ee9083b2f93373bb" + integrity sha512-vDMm9B0xnqqZ8uSBpZ8sNtRtOdmfShrvT6h2TuQGLs0Is+cR0DYbj/KWP6ALVNbWPpqA/qPLoOuppJN07humpA== core-util-is@~1.0.0: version "1.0.3" @@ -3447,20 +3635,20 @@ css-blank-pseudo@^7.0.1: postcss-selector-parser "^7.0.0" css-declaration-sorter@^7.2.0: - version "7.2.0" - resolved "https://registry.yarnpkg.com/css-declaration-sorter/-/css-declaration-sorter-7.2.0.tgz#6dec1c9523bc4a643e088aab8f09e67a54961024" - integrity sha512-h70rUM+3PNFuaBDTLe8wF/cdWu+dOZmb7pJt8Z2sedYbAcQVQV/tEchueg3GWxwqS0cxtbxmaHEdkNACqcvsow== + version "7.3.0" + resolved "https://registry.yarnpkg.com/css-declaration-sorter/-/css-declaration-sorter-7.3.0.tgz#edc45c36bcdfea0788b1d4452829f142ef1c4a4a" + integrity sha512-LQF6N/3vkAMYF4xoHLJfG718HRJh34Z8BnNhd6bosOMIVjMlhuZK5++oZa3uYAgrI5+7x2o27gUqTR2U/KjUOQ== -css-has-pseudo@^7.0.2: - version "7.0.2" - resolved "https://registry.yarnpkg.com/css-has-pseudo/-/css-has-pseudo-7.0.2.tgz#fb42e8de7371f2896961e1f6308f13c2c7019b72" - integrity sha512-nzol/h+E0bId46Kn2dQH5VElaknX2Sr0hFuB/1EomdC7j+OISt2ZzK7EHX9DZDY53WbIVAR7FYKSO2XnSf07MQ== +css-has-pseudo@^7.0.3: + version "7.0.3" + resolved "https://registry.yarnpkg.com/css-has-pseudo/-/css-has-pseudo-7.0.3.tgz#a5ee2daf5f70a2032f3cefdf1e36e7f52a243873" + integrity sha512-oG+vKuGyqe/xvEMoxAQrhi7uY16deJR3i7wwhBerVrGQKSqUC5GiOVxTpM9F9B9hw0J+eKeOWLH7E9gZ1Dr5rA== dependencies: "@csstools/selector-specificity" "^5.0.0" postcss-selector-parser "^7.0.0" postcss-value-parser "^4.2.0" -css-loader@^6.8.1: +css-loader@^6.11.0: version "6.11.0" resolved "https://registry.yarnpkg.com/css-loader/-/css-loader-6.11.0.tgz#33bae3bf6363d0a7c2cf9031c96c744ff54d85ba" integrity sha512-CTJ+AEQJjq5NzLga5pE39qdiSV56F8ywCIsqNIRF0r7BDgWsN25aazToqAFg7ZrtA/U016xudB3ffgweORxX7g== @@ -3503,9 +3691,9 @@ css-select@^4.1.3: nth-check "^2.0.1" css-select@^5.1.0: - version "5.1.0" - resolved "https://registry.yarnpkg.com/css-select/-/css-select-5.1.0.tgz#b8ebd6554c3637ccc76688804ad3f6a6fdaea8a6" - integrity sha512-nwoRF1rvRRnnCqqY7updORDsuqKzqYJ28+oSMaJMMgOauh3fvwHqMS7EZpIPqK8GL+g9mKxF1vP/ZjSeNjEVHg== + version "5.2.2" + resolved "https://registry.yarnpkg.com/css-select/-/css-select-5.2.2.tgz#01b6e8d163637bb2dd6c982ca4ed65863682786e" + integrity sha512-TizTzUddG/xYLA3NXodFM0fSbNizXjOKhqiQQwvhlspadZokn1KDy0NZFS0wuEubIYAV5/c1/lAr0TaaFXEXzw== dependencies: boolbase "^1.0.0" css-what "^6.1.0" @@ -3530,14 +3718,14 @@ css-tree@~2.2.0: source-map-js "^1.0.1" css-what@^6.0.1, css-what@^6.1.0: - version "6.1.0" - resolved "https://registry.yarnpkg.com/css-what/-/css-what-6.1.0.tgz#fb5effcf76f1ddea2c81bdfaa4de44e79bac70f4" - integrity sha512-HTUrgRJ7r4dsZKU6GjmpfRK1O76h97Z8MfS1G0FozR+oF2kG6Vfe8JE6zwrkbxigziPHinCJ+gCPjA9EaBDtRw== + version "6.2.2" + resolved "https://registry.yarnpkg.com/css-what/-/css-what-6.2.2.tgz#cdcc8f9b6977719fdfbd1de7aec24abf756b9dea" + integrity sha512-u/O3vwbptzhMs3L1fQE82ZSLHQQfto5gyZzwteVIEyeaY5Fc7R4dapF/BvRoSYFeqfBk4m0V1Vafq5Pjv25wvA== -cssdb@^8.2.5: - version "8.3.0" - resolved "https://registry.yarnpkg.com/cssdb/-/cssdb-8.3.0.tgz#940becad497b8509ad822a28fb0cfe54c969ccfe" - integrity sha512-c7bmItIg38DgGjSwDPZOYF/2o0QU/sSgkWOMyl8votOfgFuyiFKWPesmCGEsrGLxEA9uL540cp8LdaGEjUGsZQ== +cssdb@^8.4.2: + version "8.4.2" + resolved "https://registry.yarnpkg.com/cssdb/-/cssdb-8.4.2.tgz#1a367ab1904c97af0bb2c7ae179764deae7b078b" + integrity sha512-PzjkRkRUS+IHDJohtxkIczlxPPZqRo0nXplsYXOMBRPjcVRjj1W4DfvRgshUYTVuUigU7ptVYkFJQ7abUB0nyg== cssesc@^3.0.0: version "3.0.0" @@ -3630,17 +3818,17 @@ debug@2.6.9: dependencies: ms "2.0.0" -debug@4, debug@^4.0.0, debug@^4.1.0, debug@^4.1.1, debug@^4.3.1: - version "4.4.1" - resolved "https://registry.yarnpkg.com/debug/-/debug-4.4.1.tgz#e5a8bc6cbc4c6cd3e64308b0693a3d4fa550189b" - integrity sha512-KcKCqiftBJcZr++7ykoDIEwSa3XWowTfNPo92BYxjXiyYEVrUQh2aLyhxBCwww+heortUFxEJYcRzosstTEBYQ== +debug@4, debug@^4.0.0, debug@^4.1.0, debug@^4.3.1, debug@^4.4.1: + version "4.4.3" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.4.3.tgz#c6ae432d9bd9662582fce08709b038c58e9e3d6a" + integrity sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA== dependencies: ms "^2.1.3" decode-named-character-reference@^1.0.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/decode-named-character-reference/-/decode-named-character-reference-1.1.0.tgz#5d6ce68792808901210dac42a8e9853511e2b8bf" - integrity sha512-Wy+JTSbFThEOXQIR2L6mxJvEs+veIzpmqD7ynWxMXGpnk3smkHQOp6forLdHsKpAMW9iJpaBBIxz285t1n1C3w== + version "1.2.0" + resolved "https://registry.yarnpkg.com/decode-named-character-reference/-/decode-named-character-reference-1.2.0.tgz#25c32ae6dd5e21889549d40f676030e9514cc0ed" + integrity sha512-c6fcElNV6ShtZXmsgNgFFV5tVX2PaV4g+MOAkb8eXHvn6sryJBrZa9r0zV6+dtTyoCKxtDy5tyQ5ZwQuidtd+Q== dependencies: character-entities "^2.0.0" @@ -3661,12 +3849,18 @@ deepmerge@^4.3.1: resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-4.3.1.tgz#44b5f2147cd3b00d4b56137685966f26fd25dd4a" integrity sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A== -default-gateway@^6.0.3: - version "6.0.3" - resolved "https://registry.yarnpkg.com/default-gateway/-/default-gateway-6.0.3.tgz#819494c888053bdb743edbf343d6cdf7f2943a71" - integrity sha512-fwSOJsbbNzZ/CUFpqFBqYfYNLj1NbMPm8MMCIzHjC83iSJRBEGmDUxU+WP661BaBQImeC2yHwXtz+P/O9o+XEg== +default-browser-id@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/default-browser-id/-/default-browser-id-5.0.0.tgz#a1d98bf960c15082d8a3fa69e83150ccccc3af26" + integrity sha512-A6p/pu/6fyBcA1TRz/GqWYPViplrftcW2gZC9q79ngNCKAeR/X3gcEdXQHl4KNXV+3wgIJ1CPkJQ3IHM6lcsyA== + +default-browser@^5.2.1: + version "5.2.1" + resolved "https://registry.yarnpkg.com/default-browser/-/default-browser-5.2.1.tgz#7b7ba61204ff3e425b556869ae6d3e9d9f1712cf" + integrity sha512-WY/3TUME0x3KPYdRRxEJJvXRHV4PyPoUsxtZa78lwItwRQRHhd2U9xOscaT/YTf8uCXIAjeJOFBVEh/7FtD8Xg== dependencies: - execa "^5.0.0" + bundle-name "^4.1.0" + default-browser-id "^5.0.0" defer-to-connect@^2.0.1: version "2.0.1" @@ -3687,6 +3881,11 @@ define-lazy-prop@^2.0.0: resolved "https://registry.yarnpkg.com/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz#3f7ae421129bcaaac9bc74905c98a0009ec9ee7f" integrity sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og== +define-lazy-prop@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/define-lazy-prop/-/define-lazy-prop-3.0.0.tgz#dbb19adfb746d7fc6d734a06b72f4a00d021255f" + integrity sha512-N+MeXYoqr3pOgn8xfyRPREN7gHakLYjhsHhWGT3fWAiL4IkAt0iDw14QiiEm2bE30c5XX5q0FtAA3CK5f9/BUg== + define-properties@^1.2.1: version "1.2.1" resolved "https://registry.yarnpkg.com/define-properties/-/define-properties-1.2.1.tgz#10781cc616eb951a80a034bafcaa7377f6af2b6c" @@ -3706,7 +3905,7 @@ depd@~1.1.2: resolved "https://registry.yarnpkg.com/depd/-/depd-1.1.2.tgz#9bcd52e14c097763e749b274c4346ed2e560b5a9" integrity sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ== -dequal@^2.0.0: +dequal@^2.0.0, dequal@^2.0.3: version "2.0.3" resolved "https://registry.yarnpkg.com/dequal/-/dequal-2.0.3.tgz#2644214f1997d39ed0ee0ece72335490a7ac67be" integrity sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA== @@ -3851,10 +4050,10 @@ ee-first@1.1.1: resolved "https://registry.yarnpkg.com/ee-first/-/ee-first-1.1.1.tgz#590c61156b0ae2f4f0255732a158b266bc56b21d" integrity sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow== -electron-to-chromium@^1.5.149: - version "1.5.158" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.158.tgz#e5f01fc7fdf810d9d223e30593e0839c306276d4" - integrity sha512-9vcp2xHhkvraY6AHw2WMi+GDSLPX42qe2xjYaVoZqFRJiOcilVQFq9mZmpuHEQpzlgGDelKlV7ZiGcmMsc8WxQ== +electron-to-chromium@^1.5.227: + version "1.5.237" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.237.tgz#eacf61cef3f6345d0069ab427585c5a04d7084f0" + integrity sha512-icUt1NvfhGLar5lSWH3tHNzablaA5js3HVHacQimfP8ViEBOQv+L7DKEuHdbTZ0SKCO1ogTJTIL1Gwk9S6Qvcg== emoji-regex@^8.0.0: version "8.0.0" @@ -3891,10 +4090,10 @@ encodeurl@~2.0.0: resolved "https://registry.yarnpkg.com/encodeurl/-/encodeurl-2.0.0.tgz#7b8ea898077d7e409d3ac45474ea38eaf0857a58" integrity sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg== -enhanced-resolve@^5.17.1: - version "5.18.1" - resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.18.1.tgz#728ab082f8b7b6836de51f1637aab5d3b9568faf" - integrity sha512-ZSW3ma5GkcQBIpwZTSRAI8N71Uuwgs93IezB7mf7R60tC8ZbJideoDNKjHn2O9KIlx6rkGTTEk1xUCK2E1Y2Yg== +enhanced-resolve@^5.17.3: + version "5.18.3" + resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.18.3.tgz#9b5f4c5c076b8787c78fe540392ce76a88855b44" + integrity sha512-d4lC8xfavMeBjzGr2vECC3fsGXziXZQyJxD868h2M/mBI3PwAuODxAkLkq5HYuvrPYcUtiLzsTo8U3PgX3Ocww== dependencies: graceful-fs "^4.2.4" tapable "^2.2.0" @@ -3910,14 +4109,14 @@ entities@^4.2.0, entities@^4.4.0: integrity sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw== entities@^6.0.0: - version "6.0.0" - resolved "https://registry.yarnpkg.com/entities/-/entities-6.0.0.tgz#09c9e29cb79b0a6459a9b9db9efb418ac5bb8e51" - integrity sha512-aKstq2TDOndCn4diEyp9Uq/Flu2i1GlLkc6XIDQSDMuaFE3OPW5OphLCyQ5SpSJZTb4reN+kTcYru5yIfXoRPw== + version "6.0.1" + resolved "https://registry.yarnpkg.com/entities/-/entities-6.0.1.tgz#c28c34a43379ca7f61d074130b2f5f7020a30694" + integrity sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g== error-ex@^1.3.1: - version "1.3.2" - resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.2.tgz#b4ac40648107fdcdcfae242f428bea8a14d4f1bf" - integrity sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g== + version "1.3.4" + resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.4.tgz#b3a8d8bb6f92eecc1629e3e27d3c8607a8a32414" + integrity sha512-sqQamAnR14VgCr1A618A3sGrygcpK+HEbenA/HiEAkkUwcZIIB/tgWqHFxWgOyDh4nB4JCRimh79dR5Ywc9MDQ== dependencies: is-arrayish "^0.2.1" @@ -4117,7 +4316,12 @@ events@^3.2.0: resolved "https://registry.yarnpkg.com/events/-/events-3.3.0.tgz#31a95ad0a924e2d2c419a813aeb2c4e878ea7400" integrity sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q== -execa@5.1.1, execa@^5.0.0: +eventsource-parser@^3.0.5: + version "3.0.6" + resolved "https://registry.yarnpkg.com/eventsource-parser/-/eventsource-parser-3.0.6.tgz#292e165e34cacbc936c3c92719ef326d4aeb4e90" + integrity sha512-Vo1ab+QXPzZ4tCa8SwIHJFaSzy4R6SHf7BY79rFBDf0idraZWAkYrDjDj8uWaSm3S2TK+hJ7/t1CEmZ7jXw+pg== + +execa@5.1.1: version "5.1.1" resolved "https://registry.yarnpkg.com/execa/-/execa-5.1.1.tgz#f80ad9cbf4298f7bd1d4c9555c21e93741c411dd" integrity sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg== @@ -4132,7 +4336,7 @@ execa@5.1.1, execa@^5.0.0: signal-exit "^3.0.3" strip-final-newline "^2.0.0" -express@^4.17.3: +express@^4.21.2: version "4.21.2" resolved "https://registry.yarnpkg.com/express/-/express-4.21.2.tgz#cf250e48362174ead6cea4a566abef0162c1ec32" integrity sha512-28HqgMZAmih1Czt9ny7qr6ek2qddF4FclbMzwhCREB6OFfH+rXAnuNCwo1/wFvrtbgsQDb4kSbX9de9lFbrXnA== @@ -4203,9 +4407,9 @@ fast-json-stable-stringify@^2.0.0: integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== fast-uri@^3.0.1: - version "3.0.6" - resolved "https://registry.yarnpkg.com/fast-uri/-/fast-uri-3.0.6.tgz#88f130b77cfaea2378d56bf970dea21257a68748" - integrity sha512-Atfo14OibSv5wAp4VWNsFYE1AchQRTv9cBGWET4pZWHzYshFSS9NQI6I57rdKn9croWVMbYFbLhJ+yJvmZIIHw== + version "3.1.0" + resolved "https://registry.yarnpkg.com/fast-uri/-/fast-uri-3.1.0.tgz#66eecff6c764c0df9b762e62ca7edcfb53b4edfa" + integrity sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA== fastq@^1.6.0: version "1.19.1" @@ -4292,9 +4496,9 @@ flat@^5.0.2: integrity sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ== follow-redirects@^1.0.0: - version "1.15.9" - resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.9.tgz#a604fa10e443bf98ca94228d9eebcc2e8a2c8ee1" - integrity sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ== + version "1.15.11" + resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.11.tgz#777d73d72a92f8ec4d2e410eb47352a56b8e8340" + integrity sha512-deG2P0JfjrTxl50XGCDyfI97ZGVCxIpfKYmfyrQ54n5FO/0gfIES8C/Psl6kWVDolizcaaxZJnTS0QSMxvnsBQ== form-data-encoder@^2.1.2: version "2.1.4" @@ -4322,24 +4526,14 @@ fresh@0.5.2: integrity sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q== fs-extra@^11.1.1, fs-extra@^11.2.0: - version "11.3.0" - resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-11.3.0.tgz#0daced136bbaf65a555a326719af931adc7a314d" - integrity sha512-Z4XaCL6dUDHfP/jT25jJKMmtxvuwbkrD1vNSMFlo9lNLY2c5FHYSQgHPRZUjAB26TpDEoW9HCOgplrdbaPV/ew== + version "11.3.2" + resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-11.3.2.tgz#c838aeddc6f4a8c74dd15f85e11fe5511bfe02a4" + integrity sha512-Xr9F6z6up6Ws+NjzMCZc6WXg2YFRlrLP9NQDO3VQrWrfiojdhS56TzueT88ze0uBdCTwEIhQ3ptnmKeWGFAe0A== dependencies: graceful-fs "^4.2.0" jsonfile "^6.0.1" universalify "^2.0.0" -fs-monkey@^1.0.4: - version "1.0.6" - resolved "https://registry.yarnpkg.com/fs-monkey/-/fs-monkey-1.0.6.tgz#8ead082953e88d992cf3ff844faa907b26756da2" - integrity sha512-b1FMfwetIKymC0eioW7mTywihSQE4oLzQn1dB6rZB5fx/3NpNEdAWeCSMB+60/AeT0TCXsxzAlcYVEFCTAksWg== - -fs.realpath@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" - integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw== - fsevents@~2.3.2: version "2.3.3" resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.3.tgz#cac6407785d03675a2a5e1a5305c697b347d90d6" @@ -4408,23 +4602,16 @@ glob-parent@^6.0.1: dependencies: is-glob "^4.0.3" +glob-to-regex.js@^1.0.1: + version "1.2.0" + resolved "https://registry.yarnpkg.com/glob-to-regex.js/-/glob-to-regex.js-1.2.0.tgz#2b323728271d133830850e32311f40766c5f6413" + integrity sha512-QMwlOQKU/IzqMUOAZWubUOT8Qft+Y0KQWnX9nK3ch0CJg0tTp4TvGZsTfudYKv2NzoQSyPcnA6TYeIQ3jGichQ== + glob-to-regexp@^0.4.1: version "0.4.1" resolved "https://registry.yarnpkg.com/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz#c75297087c851b9a578bd217dd59a92f59fe546e" integrity sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw== -glob@^7.1.3: - version "7.2.3" - resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.3.tgz#b8df0fb802bbfa8e89bd1d938b4e16578ed44f2b" - integrity sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q== - dependencies: - fs.realpath "^1.0.0" - inflight "^1.0.4" - inherits "2" - minimatch "^3.1.1" - once "^1.3.0" - path-is-absolute "^1.0.0" - global-dirs@^3.0.0: version "3.0.1" resolved "https://registry.yarnpkg.com/global-dirs/-/global-dirs-3.0.1.tgz#0c488971f066baceda21447aecb1a8b911d22485" @@ -4432,11 +4619,6 @@ global-dirs@^3.0.0: dependencies: ini "2.0.0" -globals@^11.1.0: - version "11.12.0" - resolved "https://registry.yarnpkg.com/globals/-/globals-11.12.0.tgz#ab8795338868a0babd8525758018c2a7eb95c42e" - integrity sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA== - globby@^11.1.0: version "11.1.0" resolved "https://registry.yarnpkg.com/globby/-/globby-11.1.0.tgz#bd4be98bb042f83d796f7e3811991fbe82a0d34b" @@ -4691,11 +4873,6 @@ hpack.js@^2.1.6: readable-stream "^2.0.1" wbuf "^1.1.0" -html-entities@^2.3.2: - version "2.6.0" - resolved "https://registry.yarnpkg.com/html-entities/-/html-entities-2.6.0.tgz#7c64f1ea3b36818ccae3d3fb48b6974208e984f8" - integrity sha512-kig+rMn/QOVRvr7c86gQ8lWXq+Hkv6CbAH1hLu+RG338StTpE8Z0b44SDVaqVu7HGKf27frdmUYEs9hTUX/cLQ== - html-escaper@^2.0.2: version "2.0.2" resolved "https://registry.yarnpkg.com/html-escaper/-/html-escaper-2.0.2.tgz#dfd60027da36a36dfcbe236262c00a5822681453" @@ -4738,9 +4915,9 @@ html-void-elements@^3.0.0: integrity sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg== html-webpack-plugin@^5.6.0: - version "5.6.3" - resolved "https://registry.yarnpkg.com/html-webpack-plugin/-/html-webpack-plugin-5.6.3.tgz#a31145f0fee4184d53a794f9513147df1e653685" - integrity sha512-QSf1yjtSAsmf7rYBV7XX86uua4W/vkhIt0xNXKbsi2foEeW7vjJQz4bhnpL3xH+l1ryl1680uNv968Z+X6jSYg== + version "5.6.4" + resolved "https://registry.yarnpkg.com/html-webpack-plugin/-/html-webpack-plugin-5.6.4.tgz#d8cb0f7edff7745ae7d6cccb0bff592e9f7f7959" + integrity sha512-V/PZeWsqhfpE27nKeX9EO2sbR+D17A+tLf6qU+ht66jdUsN0QLKJN27Z+1+gHrVMKgndBahes0PU6rRihDgHTw== dependencies: "@types/html-minifier-terser" "^6.0.0" html-minifier-terser "^6.0.2" @@ -4804,7 +4981,7 @@ http-parser-js@>=0.5.1: resolved "https://registry.yarnpkg.com/http-parser-js/-/http-parser-js-0.5.10.tgz#b3277bd6d7ed5588e20ea73bf724fcbe44609075" integrity sha512-Pysuw9XpUq5dVc/2SMHpuTY01RFl8fttgcyunjL7eEMhGM3cI4eOmiCycJDVCo/7O7ClfQD3SaI6ftDzqOXYMA== -http-proxy-middleware@^2.0.3: +http-proxy-middleware@^2.0.9: version "2.0.9" resolved "https://registry.yarnpkg.com/http-proxy-middleware/-/http-proxy-middleware-2.0.9.tgz#e9e63d68afaa4eee3d147f39149ab84c0c2815ef" integrity sha512-c1IyJYLYppU574+YI7R4QyX2ystMtVXZwIdzazUIPIJsHuWNd+mho2j+bKoHftndicGj9yh+xjd+l0yj7VeT1Q== @@ -4837,6 +5014,11 @@ human-signals@^2.1.0: resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0" integrity sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw== +hyperdyperid@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/hyperdyperid/-/hyperdyperid-1.2.0.tgz#59668d323ada92228d2a869d3e474d5a33b69e6b" + integrity sha512-Y93lCzHYgGWdrJ66yIktxiaGULYc6oGiABxhcO5AufBeOyoIdZF7bIfLaOrbM0iGIOXQQgxxRrFEnb+Y6w1n4A== + iconv-lite@0.4.24: version "0.4.24" resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b" @@ -4887,24 +5069,16 @@ infima@0.2.0-alpha.45: resolved "https://registry.yarnpkg.com/infima/-/infima-0.2.0-alpha.45.tgz#542aab5a249274d81679631b492973dd2c1e7466" integrity sha512-uyH0zfr1erU1OohLk0fT4Rrb94AOhguWNOcD9uGrSpRvNB+6gZXUoJX5J0NtvzBO10YZ9PgvA4NFgt+fYg8ojw== -inflight@^1.0.4: - version "1.0.6" - resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" - integrity sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA== - dependencies: - once "^1.3.0" - wrappy "1" - -inherits@2, inherits@2.0.4, inherits@^2.0.1, inherits@^2.0.3, inherits@~2.0.3: - version "2.0.4" - resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" - integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== - inherits@2.0.3: version "2.0.3" resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.3.tgz#633c2c83e3da42a502f52466022480f4208261de" integrity sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw== +inherits@2.0.4, inherits@^2.0.1, inherits@^2.0.3, inherits@~2.0.3: + version "2.0.4" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" + integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== + ini@2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/ini/-/ini-2.0.0.tgz#e5fd556ecdd5726be978fa1001862eacb0a94bc5" @@ -4932,7 +5106,7 @@ ipaddr.js@1.9.1: resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-1.9.1.tgz#bff38543eeb8984825079ff3a2a8e6cbd46781b3" integrity sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g== -ipaddr.js@^2.0.1: +ipaddr.js@^2.1.0: version "2.2.0" resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-2.2.0.tgz#d33fa7bac284f4de7af949638c9d68157c6b92e8" integrity sha512-Ag3wB2o37wslZS19hZqorUnrnzSkpOVy+IiiDEiTqNubEYpYuHWIf6K4psgN2ZWKExS4xhVCrRVfb/wfW8fWJA== @@ -4986,6 +5160,11 @@ is-docker@^2.0.0, is-docker@^2.1.1: resolved "https://registry.yarnpkg.com/is-docker/-/is-docker-2.2.1.tgz#33eeabe23cfe86f14bde4408a02c0cfb853acdaa" integrity sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ== +is-docker@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-docker/-/is-docker-3.0.0.tgz#90093aa3106277d8a77a5910dbae71747e15a200" + integrity sha512-eljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ== + is-extendable@^0.1.0: version "0.1.1" resolved "https://registry.yarnpkg.com/is-extendable/-/is-extendable-0.1.1.tgz#62b110e289a471418e3ec36a617d472e301dfc89" @@ -5013,6 +5192,13 @@ is-hexadecimal@^2.0.0: resolved "https://registry.yarnpkg.com/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz#86b5bf668fca307498d319dfc03289d781a90027" integrity sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg== +is-inside-container@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-inside-container/-/is-inside-container-1.0.0.tgz#e81fba699662eb31dbdaf26766a61d4814717ea4" + integrity sha512-KIYLCCJghfHZxqjYBE7rEy0OBuTd5xCHS7tHVgvCLkx7StIoaxwNW3hCALgEUjFfeRk+MG/Qxmp/vtETEF3tRA== + dependencies: + is-docker "^3.0.0" + is-installed-globally@^0.4.0: version "0.4.0" resolved "https://registry.yarnpkg.com/is-installed-globally/-/is-installed-globally-0.4.0.tgz#9a0fd407949c30f86eb6959ef1b7994ed0b7b520" @@ -5021,10 +5207,15 @@ is-installed-globally@^0.4.0: global-dirs "^3.0.0" is-path-inside "^3.0.2" +is-network-error@^1.0.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/is-network-error/-/is-network-error-1.3.0.tgz#2ce62cbca444abd506f8a900f39d20b898d37512" + integrity sha512-6oIwpsgRfnDiyEDLMay/GqCl3HoAtH5+RUKW29gYkL0QA+ipzpDLA16yQs7/RHCSu+BwgbJaOUqa4A99qNVQVw== + is-npm@^6.0.0: - version "6.0.0" - resolved "https://registry.yarnpkg.com/is-npm/-/is-npm-6.0.0.tgz#b59e75e8915543ca5d881ecff864077cba095261" - integrity sha512-JEjxbSmtPSt1c8XTkVrlujcXdKV1/tvuQ7GwKcAlyiVLeYFQ2VHat8xfrDJsIkhCdF/tZ7CiIR3sy141c6+gPQ== + version "6.1.0" + resolved "https://registry.yarnpkg.com/is-npm/-/is-npm-6.1.0.tgz#f70e0b6c132dfc817ac97d3badc0134945b098d3" + integrity sha512-O2z4/kNgyjhQwVR1Wpkbfc19JIhggF97NZNCpWTnjH7kVcZMUrnut9XSN7txI7VdyIYk5ZatOq3zvSuWpU8hoA== is-number@^7.0.0: version "7.0.0" @@ -5085,6 +5276,13 @@ is-wsl@^2.2.0: dependencies: is-docker "^2.0.0" +is-wsl@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/is-wsl/-/is-wsl-3.1.0.tgz#e1c657e39c10090afcbedec61720f6b924c3cbd2" + integrity sha512-UcVfVfaK4Sc4m7X3dUSoHoozQGBEFeDC+zVo06t98xe8CzHSZZBekNXH+tu0NalHolcJ/QAGqS46Hef7QXBIMw== + dependencies: + is-inside-container "^1.0.0" + is-yarn-global@^0.4.0: version "0.4.1" resolved "https://registry.yarnpkg.com/is-yarn-global/-/is-yarn-global-0.4.1.tgz#b312d902b313f81e4eaf98b6361ba2b45cd694bb" @@ -5177,16 +5375,11 @@ js-yaml@^4.1.0: dependencies: argparse "^2.0.1" -jsesc@^3.0.2: +jsesc@^3.0.2, jsesc@~3.1.0: version "3.1.0" resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-3.1.0.tgz#74d335a234f67ed19907fdadfac7ccf9d409825d" integrity sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA== -jsesc@~3.0.2: - version "3.0.2" - resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-3.0.2.tgz#bb8b09a6597ba426425f2e4a07245c3d00b9343e" - integrity sha512-xKqzzWXDttJuOcawBt4KnKHHIf5oQ/Cxax+0PWFG+DFDgHNAdi+TXECADI+RYiFUMmx8792xsMbbgXj4CwnP4g== - json-buffer@3.0.1: version "3.0.1" resolved "https://registry.yarnpkg.com/json-buffer/-/json-buffer-3.0.1.tgz#9338802a30d3b6605fbe0613e094008ca8c05a13" @@ -5207,15 +5400,20 @@ json-schema-traverse@^1.0.0: resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz#ae7bcb3656ab77a73ba5c49bf654f38e6b6860e2" integrity sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug== +json-schema@^0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/json-schema/-/json-schema-0.4.0.tgz#f7de4cf6efab838ebaeb3236474cbba5a1930ab5" + integrity sha512-es94M3nTIfsEPisRafak+HDLfHXnKBhV3vU5eqPcS3flIWqcxJWgXHXiey3YrpaNsanY5ei1VoYEbOzijuq9BA== + json5@^2.1.2, json5@^2.2.3: version "2.2.3" resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283" integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg== jsonfile@^6.0.1: - version "6.1.0" - resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.1.0.tgz#bc55b2634793c679ec6403094eb13698a6ec0aae" - integrity sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ== + version "6.2.0" + resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.2.0.tgz#7c265bd1b65de6977478300087c99f1c84383f62" + integrity sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg== dependencies: universalify "^2.0.0" optionalDependencies: @@ -5245,13 +5443,13 @@ latest-version@^7.0.0: dependencies: package-json "^8.1.0" -launch-editor@^2.6.0: - version "2.10.0" - resolved "https://registry.yarnpkg.com/launch-editor/-/launch-editor-2.10.0.tgz#5ca3edfcb9667df1e8721310f3a40f1127d4bc42" - integrity sha512-D7dBRJo/qcGX9xlvt/6wUYzQxjh5G1RvZPgPv8vi4KRU99DVQL/oW7tnVOCCTm2HGeo3C5HvGE5Yrh6UBoZ0vA== +launch-editor@^2.6.1: + version "2.11.1" + resolved "https://registry.yarnpkg.com/launch-editor/-/launch-editor-2.11.1.tgz#61a0b7314a42fd84a6cbb564573d9e9ffcf3d72b" + integrity sha512-SEET7oNfgSaB6Ym0jufAdCeo3meJVeCaaDyzRygy0xsp2BFKCprcfHljTq4QkzTLUxEKkFK6OK4811YM2oSrRg== dependencies: - picocolors "^1.0.0" - shell-quote "^1.8.1" + picocolors "^1.1.1" + shell-quote "^1.8.3" leven@^3.1.0: version "3.1.0" @@ -5269,9 +5467,9 @@ lines-and-columns@^1.1.6: integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg== loader-runner@^4.2.0: - version "4.3.0" - resolved "https://registry.yarnpkg.com/loader-runner/-/loader-runner-4.3.0.tgz#c1b4a163b99f614830353b16755e7149ac2314e1" - integrity sha512-3R/1M+yS3j5ou80Me59j7F9IMs4PXs3VqRrm0TU3AbKPxlmpoY1TNscJV/oGJXo8qCatFGTfDbY6W6ipGOYXfg== + version "4.3.1" + resolved "https://registry.yarnpkg.com/loader-runner/-/loader-runner-4.3.1.tgz#6c76ed29b0ccce9af379208299f07f876de737e3" + integrity sha512-IWqP2SCPhyVFTBtRcgMHdzlf9ul25NwaFx4wCEH/KjAXuuHY4yNjvPXsBokp8jCB936PyWRaPKUNh8NvylLp2Q== loader-utils@^2.0.0: version "2.0.4" @@ -5357,6 +5555,11 @@ markdown-table@^3.0.0: resolved "https://registry.yarnpkg.com/markdown-table/-/markdown-table-3.0.4.tgz#fe44d6d410ff9d6f2ea1797a3f60aa4d2b631c2a" integrity sha512-wiYz4+JrLyb/DqW2hkFJxP7Vd7JuTDm77fvbM8VfEQdmSMqcImWeeRbHwZjBjIFki/VaMK2BhFi7oUUZeM5bqw== +marked@^16.3.0: + version "16.4.1" + resolved "https://registry.yarnpkg.com/marked/-/marked-16.4.1.tgz#db37c878cfa28fa57b8dd471fe92a83282911052" + integrity sha512-ntROs7RaN3EvWfy3EZi14H4YxmT6A5YvywfhO+0pm+cH/dnSQRmdAmoFIc3B9aiwTehyk7pESH4ofyBY+V5hZg== + math-intrinsics@^1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/math-intrinsics/-/math-intrinsics-1.1.0.tgz#a0dd74be81e2aa5c2f27e65ce283605ee4e2b7f9" @@ -5595,12 +5798,17 @@ media-typer@0.3.0: resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748" integrity sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ== -memfs@^3.4.3: - version "3.6.0" - resolved "https://registry.yarnpkg.com/memfs/-/memfs-3.6.0.tgz#d7a2110f86f79dd950a8b6df6d57bc984aa185f6" - integrity sha512-EGowvkkgbMcIChjMTMkESFDbZeSh8xZ7kNSF0hAiAN4Jh6jgHCRS0Ga/+C8y6Au+oqpezRHCfPsmJ2+DwAgiwQ== +memfs@^4.43.1: + version "4.49.0" + resolved "https://registry.yarnpkg.com/memfs/-/memfs-4.49.0.tgz#bc35069570d41a31c62e31f1a6ec6057a8ea82f0" + integrity sha512-L9uC9vGuc4xFybbdOpRLoOAOq1YEBBsocCs5NVW32DfU+CZWWIn3OVF+lB8Gp4ttBVSMazwrTrjv8ussX/e3VQ== dependencies: - fs-monkey "^1.0.4" + "@jsonjoy.com/json-pack" "^1.11.0" + "@jsonjoy.com/util" "^1.9.0" + glob-to-regex.js "^1.0.1" + thingies "^2.5.0" + tree-dump "^1.0.3" + tslib "^2.0.0" merge-descriptors@1.0.3: version "1.0.3" @@ -6051,7 +6259,7 @@ mime-db@1.52.0: resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.52.0.tgz#bbabcdc02859f4987301c856e3387ce5ec43bf70" integrity sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg== -"mime-db@>= 1.43.0 < 2": +"mime-db@>= 1.43.0 < 2", mime-db@^1.54.0: version "1.54.0" resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.54.0.tgz#cddb3ee4f9c64530dff640236661d42cb6a314f5" integrity sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ== @@ -6068,13 +6276,20 @@ mime-types@2.1.18: dependencies: mime-db "~1.33.0" -mime-types@^2.1.27, mime-types@^2.1.31, mime-types@~2.1.17, mime-types@~2.1.24, mime-types@~2.1.34: +mime-types@^2.1.27, mime-types@~2.1.17, mime-types@~2.1.24, mime-types@~2.1.34: version "2.1.35" resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.35.tgz#381a871b62a734450660ae3deee44813f70d959a" integrity sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw== dependencies: mime-db "1.52.0" +mime-types@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-3.0.1.tgz#b1d94d6997a9b32fd69ebaed0db73de8acb519ce" + integrity sha512-xRc4oEhT6eaBpU1XF7AjpOFD+xQmXNB5OVKwp4tqCuBpHLS/ZbBDrc07mYTDqVMg6PfxUjjNp85O6Cd2Z/5HWA== + dependencies: + mime-db "^1.54.0" + mime@1.6.0: version "1.6.0" resolved "https://registry.yarnpkg.com/mime/-/mime-1.6.0.tgz#32cd9e5c64553bd58d19a568af452acff04981b1" @@ -6095,10 +6310,10 @@ mimic-response@^4.0.0: resolved "https://registry.yarnpkg.com/mimic-response/-/mimic-response-4.0.0.tgz#35468b19e7c75d10f5165ea25e75a5ceea7cf70f" integrity sha512-e5ISH9xMYU0DzrT+jl8q2ze9D6eWBto+I8CNpe+VI+K2J/F/k3PdkdTdz4wvGVH4NTpo+NRYTVIuMQEMMcsLqg== -mini-css-extract-plugin@^2.9.1: - version "2.9.2" - resolved "https://registry.yarnpkg.com/mini-css-extract-plugin/-/mini-css-extract-plugin-2.9.2.tgz#966031b468917a5446f4c24a80854b2947503c5b" - integrity sha512-GJuACcS//jtq4kCtd5ii/M0SZf7OZRH+BxdqXZHaJfb8TJiVl+NgQRPwiYt2EuqeSkNydn/7vP+bcE27C5mb9w== +mini-css-extract-plugin@^2.9.2: + version "2.9.4" + resolved "https://registry.yarnpkg.com/mini-css-extract-plugin/-/mini-css-extract-plugin-2.9.4.tgz#cafa1a42f8c71357f49cd1566810d74ff1cb0200" + integrity sha512-ZWYT7ln73Hptxqxk2DxPU9MmapXRhxkJD6tkSR04dnQxm8BGu2hzgKLugK5yySD97u/8yy7Ma7E76k9ZdvtjkQ== dependencies: schema-utils "^4.0.0" tapable "^2.2.1" @@ -6108,7 +6323,7 @@ minimalistic-assert@^1.0.0: resolved "https://registry.yarnpkg.com/minimalistic-assert/-/minimalistic-assert-1.0.1.tgz#2e194de044626d4a10e7f7fbc00ce73e83e4d5c7" integrity sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A== -minimatch@3.1.2, minimatch@^3.1.1: +minimatch@3.1.2: version "3.1.2" resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b" integrity sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw== @@ -6143,7 +6358,7 @@ multicast-dns@^7.2.5: dns-packet "^5.2.2" thunky "^1.0.2" -nanoid@^3.3.8: +nanoid@^3.3.11: version "3.3.11" resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.3.11.tgz#4f4f112cefbe303202f2199838128936266d185b" integrity sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w== @@ -6182,14 +6397,14 @@ node-emoji@^2.1.0: skin-tone "^2.0.0" node-forge@^1: - version "1.3.1" - resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-1.3.1.tgz#be8da2af243b2417d5f646a770663a92b7e9ded3" - integrity sha512-dPEtOeMvF9VMcYV/1Wb8CPoVAXtp6MKMlcbAt4ddqmGqUJ6fQZFXkNZNkNlfevtNkGtaSoXf/vNNNSvgrdXwtA== + version "1.3.3" + resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-1.3.3.tgz#0ad80f6333b3a0045e827ac20b7f735f93716751" + integrity sha512-rLvcdSyRCyouf6jcOIPe/BgwG/d7hKjzMKOas33/pHEr6gbq18IK9zV7DiPvzsz0oBJPme6qr6H6kGZuI9/DZg== -node-releases@^2.0.19: - version "2.0.19" - resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.19.tgz#9e445a52950951ec4d177d843af370b411caf314" - integrity sha512-xxOWJsBKtzAq7DY0J+DTzuz58K8e7sJbdgwkbMWQe8UYB6ekmsQ45q0M/tJDsGaZmbC+l7n57UV8Hl5tHxO9uw== +node-releases@^2.0.21: + version "2.0.25" + resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.25.tgz#95479437bd409231e03981c1f6abee67f5e962df" + integrity sha512-4auku8B/vw5psvTiiN9j1dAOsXvMoGqJuKJcR+dTdqiXEK20mMTk1UEo3HS16LeGQsVG6+qKTPM9u/qQ2LqATA== normalize-path@^3.0.0, normalize-path@~3.0.0: version "3.0.0" @@ -6202,9 +6417,9 @@ normalize-range@^0.1.2: integrity sha512-bdok/XvKII3nUpklnV6P2hxtMNrCboOjAcyBuQnWEhO665FwrSNRxU+AqpsyvO6LgGYPspN+lu5CLtw4jPRKNA== normalize-url@^8.0.0: - version "8.0.1" - resolved "https://registry.yarnpkg.com/normalize-url/-/normalize-url-8.0.1.tgz#9b7d96af9836577c58f5883e939365fa15623a4a" - integrity sha512-IO9QvjUMWxPQQhs60oOu10CRkWCiZzSUkzbXGGV9pviYl1fXYcvkzQ5jV9z8Y6un8ARoVRl4EtC6v6jNqbaJ/w== + version "8.1.0" + resolved "https://registry.yarnpkg.com/normalize-url/-/normalize-url-8.1.0.tgz#d33504f67970decf612946fd4880bc8c0983486d" + integrity sha512-X06Mfd/5aKsRHc0O0J5CUedwnPmnDtLF2+nq+KN9KSDlJHkPuh0JUviWjEWMe0SW/9TDdSLVPuk7L5gGTIA1/w== npm-run-path@^4.0.1: version "4.0.1" @@ -6265,24 +6480,17 @@ obuf@^1.0.0, obuf@^1.1.2: resolved "https://registry.yarnpkg.com/obuf/-/obuf-1.1.2.tgz#09bea3343d41859ebd446292d11c9d4db619084e" integrity sha512-PX1wu0AmAdPqOL1mWhqmlOd8kOIZQwGZw6rh7uby9fTc5lhaOWFLX3I6R1hrF9k3zUY40e6igsLGkDXK92LJNg== -on-finished@2.4.1: +on-finished@2.4.1, on-finished@^2.4.1: version "2.4.1" resolved "https://registry.yarnpkg.com/on-finished/-/on-finished-2.4.1.tgz#58c8c44116e54845ad57f14ab10b03533184ac3f" integrity sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg== dependencies: ee-first "1.1.1" -on-headers@~1.0.2: - version "1.0.2" - resolved "https://registry.yarnpkg.com/on-headers/-/on-headers-1.0.2.tgz#772b0ae6aaa525c399e489adfad90c403eb3c28f" - integrity sha512-pZAE+FJLoyITytdqK0U5s+FIpjN0JP3OzFi/u8Rx+EV5/W+JTWGXG8xFzevE7AjBfDqHv/8vL8qQsIhHnqRkrA== - -once@^1.3.0: - version "1.4.0" - resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" - integrity sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w== - dependencies: - wrappy "1" +on-headers@~1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/on-headers/-/on-headers-1.1.0.tgz#59da4f91c45f5f989c6e4bcedc5a3b0aed70ff65" + integrity sha512-737ZY3yNnXy37FHkQxPzt4UZ2UWPWiCZWLvFZ4fu5cueciegX0zGPnrlY6bwRg4FdQOe9YU8MkmJwGhoMybl8A== onetime@^5.1.2: version "5.1.2" @@ -6291,7 +6499,17 @@ onetime@^5.1.2: dependencies: mimic-fn "^2.1.0" -open@^8.0.9, open@^8.4.0: +open@^10.0.3: + version "10.2.0" + resolved "https://registry.yarnpkg.com/open/-/open-10.2.0.tgz#b9d855be007620e80b6fb05fac98141fe62db73c" + integrity sha512-YgBpdJHPyQ2UE5x+hlSXcnejzAvD0b22U2OuAP+8OnlJT+PjWPxtgmGqKKc+RgTM63U9gN0YzrYc71R2WT/hTA== + dependencies: + default-browser "^5.2.1" + define-lazy-prop "^3.0.0" + is-inside-container "^1.0.0" + wsl-utils "^0.1.0" + +open@^8.4.0: version "8.4.2" resolved "https://registry.yarnpkg.com/open/-/open-8.4.2.tgz#5b5ffe2a8f793dcd2aad73e550cb87b59cb084f9" integrity sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ== @@ -6344,12 +6562,13 @@ p-queue@^6.6.2: eventemitter3 "^4.0.4" p-timeout "^3.2.0" -p-retry@^4.5.0: - version "4.6.2" - resolved "https://registry.yarnpkg.com/p-retry/-/p-retry-4.6.2.tgz#9baae7184057edd4e17231cee04264106e092a16" - integrity sha512-312Id396EbJdvRONlngUx0NydfrIQ5lsYu0znKVUzVvArzEIt08V1qhtyESbGVd1FGX7UKtiFp5uwKZdM8wIuQ== +p-retry@^6.2.0: + version "6.2.1" + resolved "https://registry.yarnpkg.com/p-retry/-/p-retry-6.2.1.tgz#81828f8dc61c6ef5a800585491572cc9892703af" + integrity sha512-hEt02O4hUct5wtwg4H4KcWgDdm+l1bOaEy/hWzd8xtXB9BqxTWBBhb+2ImAtH4Cv4rPjV76xN3Zumqk3k3AhhQ== dependencies: - "@types/retry" "0.12.0" + "@types/retry" "0.12.2" + is-network-error "^1.0.0" retry "^0.13.1" p-timeout@^3.2.0: @@ -6445,11 +6664,6 @@ path-exists@^5.0.0: resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-5.0.0.tgz#a6aad9489200b21fab31e49cf09277e5116fb9e7" integrity sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ== -path-is-absolute@^1.0.0: - version "1.0.1" - resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" - integrity sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg== - path-is-inside@1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/path-is-inside/-/path-is-inside-1.0.2.tgz#365417dede44430d1c11af61027facf074bdfc53" @@ -6526,15 +6740,15 @@ postcss-clamp@^4.1.0: dependencies: postcss-value-parser "^4.2.0" -postcss-color-functional-notation@^7.0.9: - version "7.0.9" - resolved "https://registry.yarnpkg.com/postcss-color-functional-notation/-/postcss-color-functional-notation-7.0.9.tgz#2be1abbdd68fc7e8906a7a4ae6e6c8484aae8485" - integrity sha512-WScwD3pSsIz+QP97sPkGCeJm7xUH0J18k6zV5o8O2a4cQJyv15vLUx/WFQajuJVgZhmJL5awDu8zHnqzAzm4lw== +postcss-color-functional-notation@^7.0.12: + version "7.0.12" + resolved "https://registry.yarnpkg.com/postcss-color-functional-notation/-/postcss-color-functional-notation-7.0.12.tgz#9a3df2296889e629fde18b873bb1f50a4ecf4b83" + integrity sha512-TLCW9fN5kvO/u38/uesdpbx3e8AkTYhMvDZYa9JpmImWuTE99bDQ7GU7hdOADIZsiI9/zuxfAJxny/khknp1Zw== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" postcss-color-hex-alpha@^10.0.0: @@ -6571,35 +6785,35 @@ postcss-convert-values@^6.1.0: browserslist "^4.23.0" postcss-value-parser "^4.2.0" -postcss-custom-media@^11.0.5: - version "11.0.5" - resolved "https://registry.yarnpkg.com/postcss-custom-media/-/postcss-custom-media-11.0.5.tgz#2fcd88a9b1d4da41c67dac6f2def903063a3377d" - integrity sha512-SQHhayVNgDvSAdX9NQ/ygcDQGEY+aSF4b/96z7QUX6mqL5yl/JgG/DywcF6fW9XbnCRE+aVYk+9/nqGuzOPWeQ== +postcss-custom-media@^11.0.6: + version "11.0.6" + resolved "https://registry.yarnpkg.com/postcss-custom-media/-/postcss-custom-media-11.0.6.tgz#6b450e5bfa209efb736830066682e6567bd04967" + integrity sha512-C4lD4b7mUIw+RZhtY7qUbf4eADmb7Ey8BFA2px9jUbwg7pjTZDl4KY4bvlUV+/vXQvzQRfiGEVJyAbtOsCMInw== dependencies: - "@csstools/cascade-layer-name-parser" "^2.0.4" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/media-query-list-parser" "^4.0.2" + "@csstools/cascade-layer-name-parser" "^2.0.5" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/media-query-list-parser" "^4.0.3" -postcss-custom-properties@^14.0.4: - version "14.0.4" - resolved "https://registry.yarnpkg.com/postcss-custom-properties/-/postcss-custom-properties-14.0.4.tgz#de9c663285a98833a946d7003a34369d3ce373a9" - integrity sha512-QnW8FCCK6q+4ierwjnmXF9Y9KF8q0JkbgVfvQEMa93x1GT8FvOiUevWCN2YLaOWyByeDX8S6VFbZEeWoAoXs2A== +postcss-custom-properties@^14.0.6: + version "14.0.6" + resolved "https://registry.yarnpkg.com/postcss-custom-properties/-/postcss-custom-properties-14.0.6.tgz#1af73a650bf115ba052cf915287c9982825fc90e" + integrity sha512-fTYSp3xuk4BUeVhxCSJdIPhDLpJfNakZKoiTDx7yRGCdlZrSJR7mWKVOBS4sBF+5poPQFMj2YdXx1VHItBGihQ== dependencies: - "@csstools/cascade-layer-name-parser" "^2.0.4" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/cascade-layer-name-parser" "^2.0.5" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" "@csstools/utilities" "^2.0.0" postcss-value-parser "^4.2.0" -postcss-custom-selectors@^8.0.4: - version "8.0.4" - resolved "https://registry.yarnpkg.com/postcss-custom-selectors/-/postcss-custom-selectors-8.0.4.tgz#95ef8268fdbbbd84f34cf84a4517c9d99d419c5a" - integrity sha512-ASOXqNvDCE0dAJ/5qixxPeL1aOVGHGW2JwSy7HyjWNbnWTQCl+fDc968HY1jCmZI0+BaYT5CxsOiUhavpG/7eg== +postcss-custom-selectors@^8.0.5: + version "8.0.5" + resolved "https://registry.yarnpkg.com/postcss-custom-selectors/-/postcss-custom-selectors-8.0.5.tgz#9448ed37a12271d7ab6cb364b6f76a46a4a323e8" + integrity sha512-9PGmckHQswiB2usSO6XMSswO2yFWVoCAuih1yl9FVcwkscLjRKjwsjM3t+NIWpSU2Jx3eOiK2+t4vVTQaoCHHg== dependencies: - "@csstools/cascade-layer-name-parser" "^2.0.4" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/cascade-layer-name-parser" "^2.0.5" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" postcss-selector-parser "^7.0.0" postcss-dir-pseudo-class@^9.0.1: @@ -6636,12 +6850,12 @@ postcss-discard-unused@^6.0.5: dependencies: postcss-selector-parser "^6.0.16" -postcss-double-position-gradients@^6.0.1: - version "6.0.1" - resolved "https://registry.yarnpkg.com/postcss-double-position-gradients/-/postcss-double-position-gradients-6.0.1.tgz#5fde3de9fb78b467244d8c4fde39f60397beb0ce" - integrity sha512-ZitCwmvOR4JzXmKw6sZblTgwV1dcfLvClcyjADuqZ5hU0Uk4SVNpvSN9w8NcJ7XuxhRYxVA8m8AB3gy+HNBQOA== +postcss-double-position-gradients@^6.0.4: + version "6.0.4" + resolved "https://registry.yarnpkg.com/postcss-double-position-gradients/-/postcss-double-position-gradients-6.0.4.tgz#b482d08b5ced092b393eb297d07976ab482d4cad" + integrity sha512-m6IKmxo7FxSP5nF2l63QbCC3r+bWpFUWmZXZf096WxG0m7Vl1Q1+ruFOhpdDRmKrRS+S3Jtk+TVk/7z0+BVK6g== dependencies: - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" postcss-value-parser "^4.2.0" @@ -6677,18 +6891,18 @@ postcss-image-set-function@^7.0.0: "@csstools/utilities" "^2.0.0" postcss-value-parser "^4.2.0" -postcss-lab-function@^7.0.9: - version "7.0.9" - resolved "https://registry.yarnpkg.com/postcss-lab-function/-/postcss-lab-function-7.0.9.tgz#09052f22cc2b8c589e9b29b5c0a10be105b29b69" - integrity sha512-IGbsIXbqMDusymJAKYX+f9oakPo89wL9Pzd/qRBQOVf3EIQWT9hgvqC4Me6Dkzxp3KPuIBf6LPkjrLHe/6ZMIQ== +postcss-lab-function@^7.0.12: + version "7.0.12" + resolved "https://registry.yarnpkg.com/postcss-lab-function/-/postcss-lab-function-7.0.12.tgz#eb555ac542607730eb0a87555074e4a5c6eef6e4" + integrity sha512-tUcyRk1ZTPec3OuKFsqtRzW2Go5lehW29XA21lZ65XmzQkz43VY2tyWEC202F7W3mILOjw0voOiuxRGTsN+J9w== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" -postcss-loader@^7.3.3: +postcss-loader@^7.3.4: version "7.3.4" resolved "https://registry.yarnpkg.com/postcss-loader/-/postcss-loader-7.3.4.tgz#aed9b79ce4ed7e9e89e56199d25ad1ec8f606209" integrity sha512-iW5WTTBSC5BfsBJ9daFMPVrLT36MrNiC6fqOZTTaHjBNX6Pfd5p+hSBqe/fEeNd7pc13QiAyGt7VdGMw4eRC4A== @@ -6790,12 +7004,12 @@ postcss-modules-values@^4.0.0: dependencies: icss-utils "^5.0.0" -postcss-nesting@^13.0.1: - version "13.0.1" - resolved "https://registry.yarnpkg.com/postcss-nesting/-/postcss-nesting-13.0.1.tgz#c405796d7245a3e4c267a9956cacfe9670b5d43e" - integrity sha512-VbqqHkOBOt4Uu3G8Dm8n6lU5+9cJFxiuty9+4rcoyRPO9zZS1JIs6td49VIoix3qYqELHlJIn46Oih9SAKo+yQ== +postcss-nesting@^13.0.2: + version "13.0.2" + resolved "https://registry.yarnpkg.com/postcss-nesting/-/postcss-nesting-13.0.2.tgz#fde0d4df772b76d03b52eccc84372e8d1ca1402e" + integrity sha512-1YCI290TX+VP0U/K/aFxzHzQWHWURL+CtHMSbex1lCdpXD1SoR2sYuxDu5aNI9lPoXpKTCggFZiDJbwylU0LEQ== dependencies: - "@csstools/selector-resolve-nested" "^3.0.0" + "@csstools/selector-resolve-nested" "^3.1.0" "@csstools/selector-specificity" "^5.0.0" postcss-selector-parser "^7.0.0" @@ -6893,67 +7107,71 @@ postcss-place@^10.0.0: dependencies: postcss-value-parser "^4.2.0" -postcss-preset-env@^10.1.0: - version "10.1.6" - resolved "https://registry.yarnpkg.com/postcss-preset-env/-/postcss-preset-env-10.1.6.tgz#0f5456ea55a6bcbd0fd3c5f41e194881f42b17e5" - integrity sha512-1jRD7vttKLJ7o0mcmmYWKRLm7W14rI8K1I7Y41OeXUPEVc/CAzfTssNUeJ0zKbR+zMk4boqct/gwS/poIFF5Lg== +postcss-preset-env@^10.2.1: + version "10.4.0" + resolved "https://registry.yarnpkg.com/postcss-preset-env/-/postcss-preset-env-10.4.0.tgz#fa6167a307f337b2bcdd1d125604ff97cdeb5142" + integrity sha512-2kqpOthQ6JhxqQq1FSAAZGe9COQv75Aw8WbsOvQVNJ2nSevc9Yx/IKZGuZ7XJ+iOTtVon7LfO7ELRzg8AZ+sdw== dependencies: - "@csstools/postcss-cascade-layers" "^5.0.1" - "@csstools/postcss-color-function" "^4.0.9" - "@csstools/postcss-color-mix-function" "^3.0.9" - "@csstools/postcss-content-alt-text" "^2.0.5" - "@csstools/postcss-exponential-functions" "^2.0.8" + "@csstools/postcss-alpha-function" "^1.0.1" + "@csstools/postcss-cascade-layers" "^5.0.2" + "@csstools/postcss-color-function" "^4.0.12" + "@csstools/postcss-color-function-display-p3-linear" "^1.0.1" + "@csstools/postcss-color-mix-function" "^3.0.12" + "@csstools/postcss-color-mix-variadic-function-arguments" "^1.0.2" + "@csstools/postcss-content-alt-text" "^2.0.8" + "@csstools/postcss-contrast-color-function" "^2.0.12" + "@csstools/postcss-exponential-functions" "^2.0.9" "@csstools/postcss-font-format-keywords" "^4.0.0" - "@csstools/postcss-gamut-mapping" "^2.0.9" - "@csstools/postcss-gradients-interpolation-method" "^5.0.9" - "@csstools/postcss-hwb-function" "^4.0.9" - "@csstools/postcss-ic-unit" "^4.0.1" + "@csstools/postcss-gamut-mapping" "^2.0.11" + "@csstools/postcss-gradients-interpolation-method" "^5.0.12" + "@csstools/postcss-hwb-function" "^4.0.12" + "@csstools/postcss-ic-unit" "^4.0.4" "@csstools/postcss-initial" "^2.0.1" - "@csstools/postcss-is-pseudo-class" "^5.0.1" - "@csstools/postcss-light-dark-function" "^2.0.8" + "@csstools/postcss-is-pseudo-class" "^5.0.3" + "@csstools/postcss-light-dark-function" "^2.0.11" "@csstools/postcss-logical-float-and-clear" "^3.0.0" "@csstools/postcss-logical-overflow" "^2.0.0" "@csstools/postcss-logical-overscroll-behavior" "^2.0.0" "@csstools/postcss-logical-resize" "^3.0.0" - "@csstools/postcss-logical-viewport-units" "^3.0.3" - "@csstools/postcss-media-minmax" "^2.0.8" - "@csstools/postcss-media-queries-aspect-ratio-number-values" "^3.0.4" + "@csstools/postcss-logical-viewport-units" "^3.0.4" + "@csstools/postcss-media-minmax" "^2.0.9" + "@csstools/postcss-media-queries-aspect-ratio-number-values" "^3.0.5" "@csstools/postcss-nested-calc" "^4.0.0" "@csstools/postcss-normalize-display-values" "^4.0.0" - "@csstools/postcss-oklab-function" "^4.0.9" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" - "@csstools/postcss-random-function" "^2.0.0" - "@csstools/postcss-relative-color-syntax" "^3.0.9" + "@csstools/postcss-oklab-function" "^4.0.12" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" + "@csstools/postcss-random-function" "^2.0.1" + "@csstools/postcss-relative-color-syntax" "^3.0.12" "@csstools/postcss-scope-pseudo-class" "^4.0.1" - "@csstools/postcss-sign-functions" "^1.1.3" - "@csstools/postcss-stepped-value-functions" "^4.0.8" - "@csstools/postcss-text-decoration-shorthand" "^4.0.2" - "@csstools/postcss-trigonometric-functions" "^4.0.8" + "@csstools/postcss-sign-functions" "^1.1.4" + "@csstools/postcss-stepped-value-functions" "^4.0.9" + "@csstools/postcss-text-decoration-shorthand" "^4.0.3" + "@csstools/postcss-trigonometric-functions" "^4.0.9" "@csstools/postcss-unset-value" "^4.0.0" autoprefixer "^10.4.21" - browserslist "^4.24.4" + browserslist "^4.26.0" css-blank-pseudo "^7.0.1" - css-has-pseudo "^7.0.2" + css-has-pseudo "^7.0.3" css-prefers-color-scheme "^10.0.0" - cssdb "^8.2.5" + cssdb "^8.4.2" postcss-attribute-case-insensitive "^7.0.1" postcss-clamp "^4.1.0" - postcss-color-functional-notation "^7.0.9" + postcss-color-functional-notation "^7.0.12" postcss-color-hex-alpha "^10.0.0" postcss-color-rebeccapurple "^10.0.0" - postcss-custom-media "^11.0.5" - postcss-custom-properties "^14.0.4" - postcss-custom-selectors "^8.0.4" + postcss-custom-media "^11.0.6" + postcss-custom-properties "^14.0.6" + postcss-custom-selectors "^8.0.5" postcss-dir-pseudo-class "^9.0.1" - postcss-double-position-gradients "^6.0.1" + postcss-double-position-gradients "^6.0.4" postcss-focus-visible "^10.0.1" postcss-focus-within "^9.0.1" postcss-font-variant "^5.0.0" postcss-gap-properties "^6.0.0" postcss-image-set-function "^7.0.0" - postcss-lab-function "^7.0.9" + postcss-lab-function "^7.0.12" postcss-logical "^8.1.0" - postcss-nesting "^13.0.1" + postcss-nesting "^13.0.2" postcss-opacity-percentage "^3.0.0" postcss-overflow-shorthand "^6.0.0" postcss-page-break "^3.0.4" @@ -7051,12 +7269,12 @@ postcss-zindex@^6.0.2: resolved "https://registry.yarnpkg.com/postcss-zindex/-/postcss-zindex-6.0.2.tgz#e498304b83a8b165755f53db40e2ea65a99b56e1" integrity sha512-5BxW9l1evPB/4ZIc+2GobEBoKC+h8gPGCMi+jxsYvd2x0mjq7wazk6DrP71pStqxE9Foxh5TVnonbWpFZzXaYg== -postcss@^8.4.21, postcss@^8.4.24, postcss@^8.4.26, postcss@^8.4.33, postcss@^8.4.38: - version "8.5.3" - resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.5.3.tgz#1463b6f1c7fb16fe258736cba29a2de35237eafb" - integrity sha512-dle9A3yYxlBSrt8Fu+IpjGT8SY8hN0mlaA6GY8t0P5PjIOZemULz/E2Bnm/2dcUOena75OTNkHI76uZBNUUq3A== +postcss@^8.4.21, postcss@^8.4.24, postcss@^8.4.33, postcss@^8.5.4: + version "8.5.6" + resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.5.6.tgz#2825006615a619b4f62a9e7426cc120b349a8f3c" + integrity sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg== dependencies: - nanoid "^3.3.8" + nanoid "^3.3.11" picocolors "^1.1.1" source-map-js "^1.2.1" @@ -7137,9 +7355,9 @@ punycode@^2.1.0: integrity sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg== pupa@^3.1.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/pupa/-/pupa-3.1.0.tgz#f15610274376bbcc70c9a3aa8b505ea23f41c579" - integrity sha512-FLpr4flz5xZTSJxSeaheeMKN/EDzMdK7b8PTOC6a5PYFKTucWbdqjgqaEyH0shFiSJrVB1+Qqi4Tk19ccU6Aug== + version "3.3.0" + resolved "https://registry.yarnpkg.com/pupa/-/pupa-3.3.0.tgz#bc4036f9e8920c08ad472bc18fb600067cb83810" + integrity sha512-LjgDO2zPtoXP2wJpDjZrGdojii1uqO0cnwKoIoUzkfS98HDmbeiGmYiXo3lXeFlq2xvne1QFQhwYXSUCLKtEuA== dependencies: escape-goat "^4.0.0" @@ -7198,11 +7416,11 @@ rc@1.2.8: strip-json-comments "~2.0.1" react-dom@^19.0.0: - version "19.1.0" - resolved "https://registry.yarnpkg.com/react-dom/-/react-dom-19.1.0.tgz#133558deca37fa1d682708df8904b25186793623" - integrity sha512-Xs1hdnE+DyKgeHJeJznQmYMIBG3TKIHJJT95Q58nHLSrElKlGQqDTR2HQ9fx5CN/Gk6Vh/kupBTDLU11/nDk/g== + version "19.2.0" + resolved "https://registry.yarnpkg.com/react-dom/-/react-dom-19.2.0.tgz#00ed1e959c365e9a9d48f8918377465466ec3af8" + integrity sha512-UlbRu4cAiGaIewkPyiRGJk0imDN2T3JjieT6spoL2UeSf5od4n5LB/mQ4ejmxhCFT1tYe8IvaFulzynWovsEFQ== dependencies: - scheduler "^0.26.0" + scheduler "^0.27.0" react-fast-compare@^3.2.0: version "3.2.2" @@ -7226,9 +7444,9 @@ react-is@^16.13.1, react-is@^16.6.0, react-is@^16.7.0: integrity sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ== react-json-view-lite@^2.3.0: - version "2.4.1" - resolved "https://registry.yarnpkg.com/react-json-view-lite/-/react-json-view-lite-2.4.1.tgz#0d06696a06aaf4a74e890302b76cf8cddcc45d60" - integrity sha512-fwFYknRIBxjbFm0kBDrzgBy1xa5tDg2LyXXBepC5f1b+MY3BUClMCsvanMPn089JbV1Eg3nZcrp0VCuH43aXnA== + version "2.5.0" + resolved "https://registry.yarnpkg.com/react-json-view-lite/-/react-json-view-lite-2.5.0.tgz#c7ff011c7cc80e9900abc7aa4916c6a5c6d6c1c6" + integrity sha512-tk7o7QG9oYyELWHL8xiMQ8x4WzjCzbWNyig3uexmkLb54r8jO0yH3WCWx8UZS0c49eSA4QUmG5caiRJ8fAn58g== react-loadable-ssr-addon-v5-slorber@^1.0.1: version "1.0.1" @@ -7280,9 +7498,9 @@ react-router@5.3.4, react-router@^5.3.4: tiny-warning "^1.0.0" react@^19.0.0: - version "19.1.0" - resolved "https://registry.yarnpkg.com/react/-/react-19.1.0.tgz#926864b6c48da7627f004795d6cce50e90793b75" - integrity sha512-FS+XFBNvn3GTAWq26joslQgWNoFu08F4kl0J4CgdNKADkdSGXQyTCnKteIAJy96Br6YbpEU1LSzV5dYtjMkMDg== + version "19.2.0" + resolved "https://registry.yarnpkg.com/react/-/react-19.2.0.tgz#d33dd1721698f4376ae57a54098cb47fc75d93a5" + integrity sha512-tmbWg6W31tQLeB5cdIBOicJDJRR2KzXsV7uSK9iNfLWQ5bIZfxuPEHp7M8wiHyHnn0DD1i7w3Zmin0FtkrwoCQ== readable-stream@^2.0.1: version "2.3.8" @@ -7323,9 +7541,9 @@ recma-build-jsx@^1.0.0: vfile "^6.0.0" recma-jsx@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/recma-jsx/-/recma-jsx-1.0.0.tgz#f7bef02e571a49d6ba3efdfda8e2efab48dbe3aa" - integrity sha512-5vwkv65qWwYxg+Atz95acp8DMu1JDSqdGkA2Of1j6rCreyFUE/gp15fC8MnGEuG1W68UKjM6x6+YTWIh7hZM/Q== + version "1.0.1" + resolved "https://registry.yarnpkg.com/recma-jsx/-/recma-jsx-1.0.1.tgz#58e718f45e2102ed0bf2fa994f05b70d76801a1a" + integrity sha512-huSIy7VU2Z5OLv6oFLosQGGDqPqdO1iq6bWNAdhzMxSJP7RAso4fCZ1cKu8j9YHCZf3TPrq4dw3okhrylgcd7w== dependencies: acorn-jsx "^5.0.0" estree-util-to-js "^2.0.0" @@ -7353,10 +7571,10 @@ recma-stringify@^1.0.0: unified "^11.0.0" vfile "^6.0.0" -regenerate-unicode-properties@^10.2.0: - version "10.2.0" - resolved "https://registry.yarnpkg.com/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.0.tgz#626e39df8c372338ea9b8028d1f99dc3fd9c3db0" - integrity sha512-DqHn3DwbmmPVzeKj9woBadqmXxLvQoQIwu7nopMc72ztvxVmVk2SBhSnx67zuye5TP+lJsb/TBQsjLKhnDf3MA== +regenerate-unicode-properties@^10.2.2: + version "10.2.2" + resolved "https://registry.yarnpkg.com/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.2.tgz#aa113812ba899b630658c7623466be71e1f86f66" + integrity sha512-m03P+zhBeQd1RGnYxrGyDAPpWX/epKirLrp8e3qevZdVkKtnCrjjWczIbYc8+xd6vcTStVlqfycTx1KR4LOr0g== dependencies: regenerate "^1.4.2" @@ -7366,16 +7584,16 @@ regenerate@^1.4.2: integrity sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A== regexpu-core@^6.2.0: - version "6.2.0" - resolved "https://registry.yarnpkg.com/regexpu-core/-/regexpu-core-6.2.0.tgz#0e5190d79e542bf294955dccabae04d3c7d53826" - integrity sha512-H66BPQMrv+V16t8xtmq+UC0CBpiTBA60V8ibS1QVReIp8T1z8hwFxqcGzm9K6lgsN7sB5edVH8a+ze6Fqm4weA== + version "6.4.0" + resolved "https://registry.yarnpkg.com/regexpu-core/-/regexpu-core-6.4.0.tgz#3580ce0c4faedef599eccb146612436b62a176e5" + integrity sha512-0ghuzq67LI9bLXpOX/ISfve/Mq33a4aFRzoQYhnnok1JOFpmE/A2TBGkNVenOGEeSBCjIiWcc6MVOG5HEQv0sA== dependencies: regenerate "^1.4.2" - regenerate-unicode-properties "^10.2.0" + regenerate-unicode-properties "^10.2.2" regjsgen "^0.8.0" - regjsparser "^0.12.0" + regjsparser "^0.13.0" unicode-match-property-ecmascript "^2.0.0" - unicode-match-property-value-ecmascript "^2.1.0" + unicode-match-property-value-ecmascript "^2.2.1" registry-auth-token@^5.0.1: version "5.1.0" @@ -7396,12 +7614,12 @@ regjsgen@^0.8.0: resolved "https://registry.yarnpkg.com/regjsgen/-/regjsgen-0.8.0.tgz#df23ff26e0c5b300a6470cad160a9d090c3a37ab" integrity sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q== -regjsparser@^0.12.0: - version "0.12.0" - resolved "https://registry.yarnpkg.com/regjsparser/-/regjsparser-0.12.0.tgz#0e846df6c6530586429377de56e0475583b088dc" - integrity sha512-cnE+y8bz4NhMjISKbgeVJtqNbtf5QpjZP+Bslo+UqkIt9QPnX9q095eiRRASJG1/tz6dlNr6Z5NsBiWYokp6EQ== +regjsparser@^0.13.0: + version "0.13.0" + resolved "https://registry.yarnpkg.com/regjsparser/-/regjsparser-0.13.0.tgz#01f8351335cf7898d43686bc74d2dd71c847ecc0" + integrity sha512-NZQZdC5wOE/H3UT28fVGL+ikOZcEzfMGk/c3iN9UGxzWHMa1op7274oyiUVrAG4B2EuFhus8SvkaYnhvW92p9Q== dependencies: - jsesc "~3.0.2" + jsesc "~3.1.0" rehype-raw@^7.0.0: version "7.0.0" @@ -7470,9 +7688,9 @@ remark-gfm@^4.0.0: unified "^11.0.0" remark-mdx@^3.0.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/remark-mdx/-/remark-mdx-3.1.0.tgz#f979be729ecb35318fa48e2135c1169607a78343" - integrity sha512-Ngl/H3YXyBV9RcRNdlYsZujAmhsxwzxpDzpDEhFBVAGthS4GDgnctpDjgFl/ULx5UEDzqtW1cyBSNKqYYrqLBA== + version "3.1.1" + resolved "https://registry.yarnpkg.com/remark-mdx/-/remark-mdx-3.1.1.tgz#047f97038bc7ec387aebb4b0a4fe23779999d845" + integrity sha512-Pjj2IYlUY3+D8x00UJsIOg5BEvfMyeI+2uLPn9VO9Wg4MEtN/VTIq2NEJQfde9PnX15KgtHyl9S0BcTnWrIuWg== dependencies: mdast-util-mdx "^3.0.0" micromark-extension-mdxjs "^3.0.0" @@ -7553,7 +7771,7 @@ resolve-pathname@^3.0.0: resolved "https://registry.yarnpkg.com/resolve-pathname/-/resolve-pathname-3.0.0.tgz#99d02224d3cf263689becbb393bc560313025dcd" integrity sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng== -resolve@^1.14.2: +resolve@^1.22.10: version "1.22.10" resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.22.10.tgz#b663e83ffb09bbf2386944736baae803029b8b39" integrity sha512-NPRy+/ncIMeDlTAsuqwKIiferiawhefFJtkNSW0qZJEqMEb+qBt/77B/jGeeek+F0uOeN05CDa6HXbbIgtVX4w== @@ -7579,13 +7797,6 @@ reusify@^1.0.4: resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.1.0.tgz#0fe13b9522e1473f51b558ee796e08f11f9b489f" integrity sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw== -rimraf@^3.0.2: - version "3.0.2" - resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a" - integrity sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA== - dependencies: - glob "^7.1.3" - rtlcss@^4.1.0: version "4.3.0" resolved "https://registry.yarnpkg.com/rtlcss/-/rtlcss-4.3.0.tgz#f8efd4d5b64f640ec4af8fa25b65bacd9e07cc97" @@ -7596,6 +7807,11 @@ rtlcss@^4.1.0: postcss "^8.4.21" strip-json-comments "^3.1.1" +run-applescript@^7.0.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/run-applescript/-/run-applescript-7.1.0.tgz#2e9e54c4664ec3106c5b5630e249d3d6595c4911" + integrity sha512-DPe5pVFaAsinSaV6QjQ6gdiedWDcRCbUuiQfQa2wmWV7+xC9bGulGI8+TdRmoFkAPaBXk8CrAbnlY2ISniJ47Q== + run-parallel@^1.1.9: version "1.2.0" resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" @@ -7623,10 +7839,10 @@ sax@^1.2.4: resolved "https://registry.yarnpkg.com/sax/-/sax-1.4.1.tgz#44cc8988377f126304d3b3fc1010c733b929ef0f" integrity sha512-+aWOz7yVScEGoKNd4PA10LZ8sk0A/z5+nXQG5giUO5rprX9jgYsTdov9qCchZiPIZezbZH+jRut8nPodFAX4Jg== -scheduler@^0.26.0: - version "0.26.0" - resolved "https://registry.yarnpkg.com/scheduler/-/scheduler-0.26.0.tgz#4ce8a8c2a2095f13ea11bf9a445be50c555d6337" - integrity sha512-NlHwttCI/l5gCPR3D1nNXtWABUmBwvZpEQiD4IXSbIDq8BzLIK/7Ir5gTFSGZDUu37K5cMNp0hFtzO38sC7gWA== +scheduler@^0.27.0: + version "0.27.0" + resolved "https://registry.yarnpkg.com/scheduler/-/scheduler-0.27.0.tgz#0c4ef82d67d1e5c1e359e8fc76d3a87f045fe5bd" + integrity sha512-eNv+WrVbKu1f3vbYJT/xtiF5syA5HPIMtf9IgY/nKg0sWqzAUEvqY/xm7OcZc/qafLx/iO9FgOmeSAp4v5ti/Q== schema-dts@^1.1.2: version "1.1.5" @@ -7642,10 +7858,10 @@ schema-utils@^3.0.0: ajv "^6.12.5" ajv-keywords "^3.5.2" -schema-utils@^4.0.0, schema-utils@^4.0.1, schema-utils@^4.3.0, schema-utils@^4.3.2: - version "4.3.2" - resolved "https://registry.yarnpkg.com/schema-utils/-/schema-utils-4.3.2.tgz#0c10878bf4a73fd2b1dfd14b9462b26788c806ae" - integrity sha512-Gn/JaSk/Mt9gYubxTtSn/QCV4em9mpAPiR1rqy/Ocu19u/G9J5WWdNoUT4SiV6mFC3y6cxyFcFwdzPM3FgxGAQ== +schema-utils@^4.0.0, schema-utils@^4.0.1, schema-utils@^4.2.0, schema-utils@^4.3.0, schema-utils@^4.3.3: + version "4.3.3" + resolved "https://registry.yarnpkg.com/schema-utils/-/schema-utils-4.3.3.tgz#5b1850912fa31df90716963d45d9121fdfc09f46" + integrity sha512-eflK8wEtyOE6+hsaRVPxvUKYCpRgzLqDTb8krvAsRIwOGlHoSgYLgBXoubGgLd2fT41/OUYdb48v4k4WWHQurA== dependencies: "@types/json-schema" "^7.0.9" ajv "^8.9.0" @@ -7665,7 +7881,7 @@ select-hose@^2.0.0: resolved "https://registry.yarnpkg.com/select-hose/-/select-hose-2.0.0.tgz#625d8658f865af43ec962bfc376a37359a4994ca" integrity sha512-mEugaLK+YfkijB4fx0e6kImuJdCIt2LxCRcbEYPqRGCs4F2ogyfZU5IAZRdjCP8JPq2AtdNoC/Dux63d9Kiryg== -selfsigned@^2.1.1: +selfsigned@^2.4.1: version "2.4.1" resolved "https://registry.yarnpkg.com/selfsigned/-/selfsigned-2.4.1.tgz#560d90565442a3ed35b674034cec4e95dceb4ae0" integrity sha512-th5B4L2U+eGLq1TVh7zNRGBapioSORUeymIydxgFpwww9d2qyKvtuPU2jJuHvYAwwqi2Y596QBL3eEqcPEYL8Q== @@ -7686,9 +7902,9 @@ semver@^6.3.1: integrity sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA== semver@^7.3.5, semver@^7.3.7, semver@^7.5.4: - version "7.7.2" - resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.2.tgz#67d99fdcd35cec21e6f8b87a7fd515a33f982b58" - integrity sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA== + version "7.7.3" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.3.tgz#4b5f4143d007633a8dc671cd0a6ef9147b8bb946" + integrity sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q== send@0.19.0: version "0.19.0" @@ -7798,10 +8014,10 @@ shebang-regex@^3.0.0: resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172" integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== -shell-quote@^1.8.1: - version "1.8.2" - resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.8.2.tgz#d2d83e057959d53ec261311e9e9b8f51dcb2934a" - integrity sha512-AzqKpGKjrj7EM6rKVQEPpB288oCfnrEIuyoT9cyF4nmGa7V8Zk6f7RRqYisX8X9m+Q7bd632aZW4ky7EhbQztA== +shell-quote@^1.8.3: + version "1.8.3" + resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.8.3.tgz#55e40ef33cf5c689902353a3d8cd1a6725f08b4b" + integrity sha512-ObmnIF4hXNg1BqhnHmgbDETF8dLPCggZWBjkQfhZpbszZnYur5DUljTcCHii5LC3J5E0yeO/1LIMyH+UvHQgyw== side-channel-list@^1.0.0: version "1.0.0" @@ -7930,9 +8146,9 @@ source-map@^0.6.0, source-map@~0.6.0: integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g== source-map@^0.7.0: - version "0.7.4" - resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.7.4.tgz#a9bbe705c9d8846f4e08ff6765acf0f1b0898656" - integrity sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA== + version "0.7.6" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.7.6.tgz#a3658ab87e5b6429c8a1f3ba0083d4c61ca3ef02" + integrity sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ== space-separated-tokens@^2.0.0: version "2.0.2" @@ -7983,9 +8199,9 @@ statuses@2.0.1: integrity sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA== std-env@^3.7.0: - version "3.9.0" - resolved "https://registry.yarnpkg.com/std-env/-/std-env-3.9.0.tgz#1a6f7243b339dca4c9fd55e1c7504c77ef23e8f1" - integrity sha512-UGvjygr6F6tpH7o2qyqR6QYpwraIjKSdtzyBdyytFOHmPZY917kwdwLG0RbOjWOnKmnm3PeHjaoLLMie7kPLQw== + version "3.10.0" + resolved "https://registry.yarnpkg.com/std-env/-/std-env-3.10.0.tgz#d810b27e3a073047b2b5e40034881f5ea6f9c83b" + integrity sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg== string-width@^4.1.0, string-width@^4.2.0: version "4.2.3" @@ -8044,9 +8260,9 @@ strip-ansi@^6.0.0, strip-ansi@^6.0.1: ansi-regex "^5.0.1" strip-ansi@^7.0.1: - version "7.1.0" - resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-7.1.0.tgz#d5b6568ca689d8561370b0707685d22434faff45" - integrity sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ== + version "7.1.2" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-7.1.2.tgz#132875abde678c7ea8d691533f2e7e22bb744dba" + integrity sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA== dependencies: ansi-regex "^6.0.1" @@ -8071,16 +8287,16 @@ strip-json-comments@~2.0.1: integrity sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ== style-to-js@^1.0.0: - version "1.1.16" - resolved "https://registry.yarnpkg.com/style-to-js/-/style-to-js-1.1.16.tgz#e6bd6cd29e250bcf8fa5e6591d07ced7575dbe7a" - integrity sha512-/Q6ld50hKYPH3d/r6nr117TZkHR0w0kGGIVfpG9N6D8NymRPM9RqCUv4pRpJ62E5DqOYx2AFpbZMyCPnjQCnOw== + version "1.1.18" + resolved "https://registry.yarnpkg.com/style-to-js/-/style-to-js-1.1.18.tgz#3e6c13bd4c4db079bd2c2c94571cce5c758bc2ff" + integrity sha512-JFPn62D4kJaPTnhFUI244MThx+FEGbi+9dw1b9yBBQ+1CZpV7QAT8kUtJ7b7EUNdHajjF/0x8fT+16oLJoojLg== dependencies: - style-to-object "1.0.8" + style-to-object "1.0.11" -style-to-object@1.0.8: - version "1.0.8" - resolved "https://registry.yarnpkg.com/style-to-object/-/style-to-object-1.0.8.tgz#67a29bca47eaa587db18118d68f9d95955e81292" - integrity sha512-xT47I/Eo0rwJmaXC4oilDGDWLohVhR6o/xAQcPQN8q6QBuZVL8qMYL85kLmST5cPjAorwvqIA4qXTRQoYHaL6g== +style-to-object@1.0.11: + version "1.0.11" + resolved "https://registry.yarnpkg.com/style-to-object/-/style-to-object-1.0.11.tgz#cf252c4051758b7acb18a5efb296f91fb79bb9c4" + integrity sha512-5A560JmXr7wDyGLK12Nq/EYS38VkGlglVzkis1JEdbGWSnbQIEhZzTJhzURXN5/8WwwFCs/f/VVcmkTppbXLow== dependencies: inline-style-parser "0.2.4" @@ -8129,10 +8345,18 @@ svgo@^3.0.2, svgo@^3.2.0: csso "^5.0.5" picocolors "^1.0.0" -tapable@^2.0.0, tapable@^2.1.1, tapable@^2.2.0, tapable@^2.2.1: - version "2.2.2" - resolved "https://registry.yarnpkg.com/tapable/-/tapable-2.2.2.tgz#ab4984340d30cb9989a490032f086dbb8b56d872" - integrity sha512-Re10+NauLTMCudc7T5WLFLAwDhQ0JWdrMK+9B2M8zR5hRExKmsRDCBA7/aV/pNJFltmBFO5BAMlQFi/vq3nKOg== +swr@^2.2.5: + version "2.3.6" + resolved "https://registry.yarnpkg.com/swr/-/swr-2.3.6.tgz#5fee0ee8a0762a16871ee371075cb09422b64f50" + integrity sha512-wfHRmHWk/isGNMwlLGlZX5Gzz/uTgo0o2IRuTMcf4CPuPFJZlq0rDaKUx+ozB5nBOReNV1kiOyzMfj+MBMikLw== + dependencies: + dequal "^2.0.3" + use-sync-external-store "^1.4.0" + +tapable@^2.0.0, tapable@^2.2.0, tapable@^2.2.1, tapable@^2.3.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/tapable/-/tapable-2.3.0.tgz#7e3ea6d5ca31ba8e078b560f0d83ce9a14aa8be6" + integrity sha512-g9ljZiwki/LfxmQADO3dEY1CbpmXT5Hm2fJ+QaGKwSXUylMybePR7/67YW7jOrrvjEgL1Fmz5kzyAjWVWLlucg== terser-webpack-plugin@^5.3.11, terser-webpack-plugin@^5.3.9: version "5.3.14" @@ -8146,15 +8370,25 @@ terser-webpack-plugin@^5.3.11, terser-webpack-plugin@^5.3.9: terser "^5.31.1" terser@^5.10.0, terser@^5.15.1, terser@^5.31.1: - version "5.39.2" - resolved "https://registry.yarnpkg.com/terser/-/terser-5.39.2.tgz#5a1626030724a672e2e5b5c9cd9070308c20e8f9" - integrity sha512-yEPUmWve+VA78bI71BW70Dh0TuV4HHd+I5SHOAfS1+QBOmvmCiiffgjR8ryyEd3KIfvPGFqoADt8LdQ6XpXIvg== + version "5.44.0" + resolved "https://registry.yarnpkg.com/terser/-/terser-5.44.0.tgz#ebefb8e5b8579d93111bfdfc39d2cf63879f4a82" + integrity sha512-nIVck8DK+GM/0Frwd+nIhZ84pR/BX7rmXMfYwyg+Sri5oGVE99/E3KvXqpC2xHFxyqXyGHTKBSioxxplrO4I4w== dependencies: "@jridgewell/source-map" "^0.3.3" - acorn "^8.14.0" + acorn "^8.15.0" commander "^2.20.0" source-map-support "~0.5.20" +thingies@^2.5.0: + version "2.5.0" + resolved "https://registry.yarnpkg.com/thingies/-/thingies-2.5.0.tgz#5f7b882c933b85989f8466b528a6247a6881e04f" + integrity sha512-s+2Bwztg6PhWUD7XMfeYm5qliDdSiZm7M7n8KjTkIsm3l/2lgVRc2/Gx/v+ZX8lT4FMA+i8aQvhcWylldc+ZNw== + +throttleit@2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/throttleit/-/throttleit-2.1.0.tgz#a7e4aa0bf4845a5bd10daa39ea0c783f631a07b4" + integrity sha512-nt6AMGKW1p/70DF/hGBdJB57B8Tspmbp5gfJ8ilhLnt7kkr2ye7hzD6NVG8GGErk2HWF34igrL2CXmNIkzKqKw== + thunky@^1.0.2: version "1.1.0" resolved "https://registry.yarnpkg.com/thunky/-/thunky-1.1.0.tgz#5abaf714a9405db0504732bbccd2cedd9ef9537d" @@ -8171,9 +8405,9 @@ tiny-warning@^1.0.0: integrity sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA== tinypool@^1.0.2: - version "1.0.2" - resolved "https://registry.yarnpkg.com/tinypool/-/tinypool-1.0.2.tgz#706193cc532f4c100f66aa00b01c42173d9051b2" - integrity sha512-al6n+QEANGFOMf/dmUMsuS5/r9B06uwlyNjZZql/zv8J7ybHCgoihBNORZCY2mzUuAnomQa2JdhyHKzZxPCrFA== + version "1.1.1" + resolved "https://registry.yarnpkg.com/tinypool/-/tinypool-1.1.1.tgz#059f2d042bd37567fbc017d3d426bdd2a2612591" + integrity sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg== to-regex-range@^5.0.1: version "5.0.1" @@ -8192,6 +8426,11 @@ totalist@^3.0.0: resolved "https://registry.yarnpkg.com/totalist/-/totalist-3.0.1.tgz#ba3a3d600c915b1a97872348f79c127475f6acf8" integrity sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ== +tree-dump@^1.0.3, tree-dump@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/tree-dump/-/tree-dump-1.1.0.tgz#ab29129169dc46004414f5a9d4a3c6e89f13e8a4" + integrity sha512-rMuvhU4MCDbcbnleZTFezWsaZXRFemSqAM+7jPnzUl1fo9w3YEKOxAeui0fz3OI4EU4hf23iyA7uQRVko+UaBA== + trim-lines@^3.0.0: version "3.0.1" resolved "https://registry.yarnpkg.com/trim-lines/-/trim-lines-3.0.1.tgz#d802e332a07df861c48802c04321017b1bd87338" @@ -8202,7 +8441,7 @@ trough@^2.0.0: resolved "https://registry.yarnpkg.com/trough/-/trough-2.2.0.tgz#94a60bd6bd375c152c1df911a4b11d5b0256f50f" integrity sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw== -tslib@^2.0.3, tslib@^2.6.0: +tslib@^2.0.0, tslib@^2.0.3, tslib@^2.6.0: version "2.8.1" resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f" integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w== @@ -8242,10 +8481,10 @@ typescript@~5.6.2: resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.6.3.tgz#5f3449e31c9d94febb17de03cc081dd56d81db5b" integrity sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw== -undici-types@~6.21.0: - version "6.21.0" - resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-6.21.0.tgz#691d00af3909be93a7faa13be61b3a5b50ef12cb" - integrity sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ== +undici-types@~7.14.0: + version "7.14.0" + resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-7.14.0.tgz#4c037b32ca4d7d62fae042174604341588bc0840" + integrity sha512-QQiYxHuyZ9gQUIrmPo3IA+hUl4KYk8uSA7cHrcKd/l3p1OTpZcM0Tbp9x7FAtXdAYhlasd60ncPpgu6ihG6TOA== unicode-canonical-property-names-ecmascript@^2.0.0: version "2.0.1" @@ -8265,15 +8504,15 @@ unicode-match-property-ecmascript@^2.0.0: unicode-canonical-property-names-ecmascript "^2.0.0" unicode-property-aliases-ecmascript "^2.0.0" -unicode-match-property-value-ecmascript@^2.1.0: - version "2.2.0" - resolved "https://registry.yarnpkg.com/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.2.0.tgz#a0401aee72714598f739b68b104e4fe3a0cb3c71" - integrity sha512-4IehN3V/+kkr5YeSSDDQG8QLqO26XpL2XP3GQtqwlT/QYSECAwFztxVHjlbh0+gjJ3XmNLS0zDsbgs9jWKExLg== +unicode-match-property-value-ecmascript@^2.2.1: + version "2.2.1" + resolved "https://registry.yarnpkg.com/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.2.1.tgz#65a7adfad8574c219890e219285ce4c64ed67eaa" + integrity sha512-JQ84qTuMg4nVkx8ga4A16a1epI9H6uTXAknqxkGF/aFfRLw1xC/Bp24HNLaZhHSkWd3+84t8iXnp1J0kYcZHhg== unicode-property-aliases-ecmascript@^2.0.0: - version "2.1.0" - resolved "https://registry.yarnpkg.com/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.1.0.tgz#43d41e3be698bd493ef911077c9b131f827e8ccd" - integrity sha512-6t3foTQI9qne+OZoVQB/8x8rk2k1eVy1gRXhV3oFQ5T6R1dqQ1xtin3XqSlx3+ATBkliTaR/hHyJBm+LVPNM8w== + version "2.2.0" + resolved "https://registry.yarnpkg.com/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.2.0.tgz#301d4f8a43d2b75c97adfad87c9dd5350c9475d1" + integrity sha512-hpbDzxUY9BFwX+UeBnxv3Sh1q7HFxj48DTmXchNgRa46lO8uj3/1iEn3MiNUYTg1g9ctIqXCCERn8gYZhHC5lQ== unified@^11.0.0, unified@^11.0.3, unified@^11.0.4: version "11.0.5" @@ -8296,9 +8535,9 @@ unique-string@^3.0.0: crypto-random-string "^4.0.0" unist-util-is@^6.0.0: - version "6.0.0" - resolved "https://registry.yarnpkg.com/unist-util-is/-/unist-util-is-6.0.0.tgz#b775956486aff107a9ded971d996c173374be424" - integrity sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw== + version "6.0.1" + resolved "https://registry.yarnpkg.com/unist-util-is/-/unist-util-is-6.0.1.tgz#d0a3f86f2dd0db7acd7d8c2478080b5c67f9c6a9" + integrity sha512-LsiILbtBETkDz8I9p1dQ0uyRUWuaQzd/cuEeS1hoRSyW5E5XGmTzlwY1OrNzzakGowI9Dr/I8HVaw4hTtnxy8g== dependencies: "@types/unist" "^3.0.0" @@ -8324,9 +8563,9 @@ unist-util-stringify-position@^4.0.0: "@types/unist" "^3.0.0" unist-util-visit-parents@^6.0.0: - version "6.0.1" - resolved "https://registry.yarnpkg.com/unist-util-visit-parents/-/unist-util-visit-parents-6.0.1.tgz#4d5f85755c3b8f0dc69e21eca5d6d82d22162815" - integrity sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw== + version "6.0.2" + resolved "https://registry.yarnpkg.com/unist-util-visit-parents/-/unist-util-visit-parents-6.0.2.tgz#777df7fb98652ce16b4b7cd999d0a1a40efa3a02" + integrity sha512-goh1s1TBrqSqukSc8wrjwWhL0hiJxgA8m4kFxGlQ+8FYQ3C/m11FcTs4YYem7V664AhHVvgoQLk890Ssdsr2IQ== dependencies: "@types/unist" "^3.0.0" unist-util-is "^6.0.0" @@ -8394,6 +8633,11 @@ url-loader@^4.1.1: mime-types "^2.1.27" schema-utils "^3.0.0" +use-sync-external-store@^1.4.0: + version "1.6.0" + resolved "https://registry.yarnpkg.com/use-sync-external-store/-/use-sync-external-store-1.6.0.tgz#b174bfa65cb2b526732d9f2ac0a408027876f32d" + integrity sha512-Pp6GSwGP/NrPIrxVFAIkOQeyw8lFenOHijQWkUTrDvrF4ALqylP2C/KCkeS9dpUM3KvYRQhna5vt7IL95+ZQ9w== + util-deprecate@^1.0.1, util-deprecate@^1.0.2, util-deprecate@~1.0.1: version "1.0.2" resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf" @@ -8438,9 +8682,9 @@ vfile-location@^5.0.0: vfile "^6.0.0" vfile-message@^4.0.0: - version "4.0.2" - resolved "https://registry.yarnpkg.com/vfile-message/-/vfile-message-4.0.2.tgz#c883c9f677c72c166362fd635f21fc165a7d1181" - integrity sha512-jRDZ1IMLttGj41KcZvlrYAaI3CfqpLpfpf+Mfig13viT6NKvRzWZ+lXz0Y5D60w6uJIBAOGq9mSHf0gktF0duw== + version "4.0.3" + resolved "https://registry.yarnpkg.com/vfile-message/-/vfile-message-4.0.3.tgz#87b44dddd7b70f0641c2e3ed0864ba73e2ea8df4" + integrity sha512-QTHzsGd1EhbZs4AsQ20JX1rC3cOlt/IWJruk893DfLRr57lcnOeMaWG4K0JrRta4mIJZKth2Au3mM3u03/JWKw== dependencies: "@types/unist" "^3.0.0" unist-util-stringify-position "^4.0.0" @@ -8453,7 +8697,7 @@ vfile@^6.0.0, vfile@^6.0.1: "@types/unist" "^3.0.0" vfile-message "^4.0.0" -watchpack@^2.4.1: +watchpack@^2.4.4: version "2.4.4" resolved "https://registry.yarnpkg.com/watchpack/-/watchpack-2.4.4.tgz#473bda72f0850453da6425081ea46fc0d7602947" integrity sha512-c5EGNOiyxxV5qmTtAB7rbiXxi1ooX1pQKMLX/MIabJjRA0SJBQOjKF+KSVfHkr9U1cADPon0mRiVe/riyaiDUA== @@ -8491,52 +8735,51 @@ webpack-bundle-analyzer@^4.10.2: sirv "^2.0.3" ws "^7.3.1" -webpack-dev-middleware@^5.3.4: - version "5.3.4" - resolved "https://registry.yarnpkg.com/webpack-dev-middleware/-/webpack-dev-middleware-5.3.4.tgz#eb7b39281cbce10e104eb2b8bf2b63fce49a3517" - integrity sha512-BVdTqhhs+0IfoeAf7EoH5WE+exCmqGerHfDM0IL096Px60Tq2Mn9MAbnaGUe6HiMa41KMCYF19gyzZmBcq/o4Q== +webpack-dev-middleware@^7.4.2: + version "7.4.5" + resolved "https://registry.yarnpkg.com/webpack-dev-middleware/-/webpack-dev-middleware-7.4.5.tgz#d4e8720aa29cb03bc158084a94edb4594e3b7ac0" + integrity sha512-uxQ6YqGdE4hgDKNf7hUiPXOdtkXvBJXrfEGYSx7P7LC8hnUYGK70X6xQXUvXeNyBDDcsiQXpG2m3G9vxowaEuA== dependencies: colorette "^2.0.10" - memfs "^3.4.3" - mime-types "^2.1.31" + memfs "^4.43.1" + mime-types "^3.0.1" + on-finished "^2.4.1" range-parser "^1.2.1" schema-utils "^4.0.0" -webpack-dev-server@^4.15.2: - version "4.15.2" - resolved "https://registry.yarnpkg.com/webpack-dev-server/-/webpack-dev-server-4.15.2.tgz#9e0c70a42a012560860adb186986da1248333173" - integrity sha512-0XavAZbNJ5sDrCbkpWL8mia0o5WPOd2YGtxrEiZkBK9FjLppIUK2TgxK6qGD2P3hUXTJNNPVibrerKcx5WkR1g== +webpack-dev-server@^5.2.2: + version "5.2.2" + resolved "https://registry.yarnpkg.com/webpack-dev-server/-/webpack-dev-server-5.2.2.tgz#96a143d50c58fef0c79107e61df911728d7ceb39" + integrity sha512-QcQ72gh8a+7JO63TAx/6XZf/CWhgMzu5m0QirvPfGvptOusAxG12w2+aua1Jkjr7hzaWDnJ2n6JFeexMHI+Zjg== dependencies: - "@types/bonjour" "^3.5.9" - "@types/connect-history-api-fallback" "^1.3.5" - "@types/express" "^4.17.13" - "@types/serve-index" "^1.9.1" - "@types/serve-static" "^1.13.10" - "@types/sockjs" "^0.3.33" - "@types/ws" "^8.5.5" + "@types/bonjour" "^3.5.13" + "@types/connect-history-api-fallback" "^1.5.4" + "@types/express" "^4.17.21" + "@types/express-serve-static-core" "^4.17.21" + "@types/serve-index" "^1.9.4" + "@types/serve-static" "^1.15.5" + "@types/sockjs" "^0.3.36" + "@types/ws" "^8.5.10" ansi-html-community "^0.0.8" - bonjour-service "^1.0.11" - chokidar "^3.5.3" + bonjour-service "^1.2.1" + chokidar "^3.6.0" colorette "^2.0.10" compression "^1.7.4" connect-history-api-fallback "^2.0.0" - default-gateway "^6.0.3" - express "^4.17.3" + express "^4.21.2" graceful-fs "^4.2.6" - html-entities "^2.3.2" - http-proxy-middleware "^2.0.3" - ipaddr.js "^2.0.1" - launch-editor "^2.6.0" - open "^8.0.9" - p-retry "^4.5.0" - rimraf "^3.0.2" - schema-utils "^4.0.0" - selfsigned "^2.1.1" + http-proxy-middleware "^2.0.9" + ipaddr.js "^2.1.0" + launch-editor "^2.6.1" + open "^10.0.3" + p-retry "^6.2.0" + schema-utils "^4.2.0" + selfsigned "^2.4.1" serve-index "^1.9.1" sockjs "^0.3.24" spdy "^4.0.2" - webpack-dev-middleware "^5.3.4" - ws "^8.13.0" + webpack-dev-middleware "^7.4.2" + ws "^8.18.0" webpack-merge@^5.9.0: version "5.10.0" @@ -8556,26 +8799,27 @@ webpack-merge@^6.0.1: flat "^5.0.2" wildcard "^2.0.1" -webpack-sources@^3.2.3: - version "3.3.0" - resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-3.3.0.tgz#8d3449f1ed3f254e722a529a0a344a37d2d17048" - integrity sha512-77R0RDmJfj9dyv5p3bM5pOHa+X8/ZkO9c7kpDstigkC4nIDobadsfSGCwB4bKhMVxqAok8tajaoR8rirM7+VFQ== +webpack-sources@^3.3.3: + version "3.3.3" + resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-3.3.3.tgz#d4bf7f9909675d7a070ff14d0ef2a4f3c982c723" + integrity sha512-yd1RBzSGanHkitROoPFd6qsrxt+oFhg/129YzheDGqeustzX0vTZJZsSsQjVQC4yzBQ56K55XU8gaNCtIzOnTg== webpack@^5.88.1, webpack@^5.95.0: - version "5.99.9" - resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.99.9.tgz#d7de799ec17d0cce3c83b70744b4aedb537d8247" - integrity sha512-brOPwM3JnmOa+7kd3NsmOUOwbDAj8FT9xDsG3IW0MgbN9yZV7Oi/s/+MNQ/EcSMqw7qfoRyXPoeEWT8zLVdVGg== + version "5.102.1" + resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.102.1.tgz#1003a3024741a96ba99c37431938bf61aad3d988" + integrity sha512-7h/weGm9d/ywQ6qzJ+Xy+r9n/3qgp/thalBbpOi5i223dPXKi04IBtqPN9nTd+jBc7QKfvDbaBnFipYp4sJAUQ== dependencies: "@types/eslint-scope" "^3.7.7" - "@types/estree" "^1.0.6" + "@types/estree" "^1.0.8" "@types/json-schema" "^7.0.15" "@webassemblyjs/ast" "^1.14.1" "@webassemblyjs/wasm-edit" "^1.14.1" "@webassemblyjs/wasm-parser" "^1.14.1" - acorn "^8.14.0" - browserslist "^4.24.0" + acorn "^8.15.0" + acorn-import-phases "^1.0.3" + browserslist "^4.26.3" chrome-trace-event "^1.0.2" - enhanced-resolve "^5.17.1" + enhanced-resolve "^5.17.3" es-module-lexer "^1.2.1" eslint-scope "5.1.1" events "^3.2.0" @@ -8585,11 +8829,11 @@ webpack@^5.88.1, webpack@^5.95.0: loader-runner "^4.2.0" mime-types "^2.1.27" neo-async "^2.6.2" - schema-utils "^4.3.2" - tapable "^2.1.1" + schema-utils "^4.3.3" + tapable "^2.3.0" terser-webpack-plugin "^5.3.11" - watchpack "^2.4.1" - webpack-sources "^3.2.3" + watchpack "^2.4.4" + webpack-sources "^3.3.3" webpackbar@^6.0.1: version "6.0.1" @@ -8656,11 +8900,6 @@ wrap-ansi@^8.0.1, wrap-ansi@^8.1.0: string-width "^5.0.1" strip-ansi "^7.0.1" -wrappy@1: - version "1.0.2" - resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" - integrity sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ== - write-file-atomic@^3.0.3: version "3.0.3" resolved "https://registry.yarnpkg.com/write-file-atomic/-/write-file-atomic-3.0.3.tgz#56bd5c5a5c70481cd19c571bd39ab965a5de56e8" @@ -8676,10 +8915,17 @@ ws@^7.3.1: resolved "https://registry.yarnpkg.com/ws/-/ws-7.5.10.tgz#58b5c20dc281633f6c19113f39b349bd8bd558d9" integrity sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ== -ws@^8.13.0: - version "8.18.2" - resolved "https://registry.yarnpkg.com/ws/-/ws-8.18.2.tgz#42738b2be57ced85f46154320aabb51ab003705a" - integrity sha512-DMricUmwGZUVr++AEAe2uiVM7UoO9MAVZMDu05UQOaUII0lp+zOzLLU4Xqh/JvTqklB1T4uELaaPBKyjE1r4fQ== +ws@^8.18.0: + version "8.18.3" + resolved "https://registry.yarnpkg.com/ws/-/ws-8.18.3.tgz#b56b88abffde62791c639170400c93dcb0c95472" + integrity sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg== + +wsl-utils@^0.1.0: + version "0.1.0" + resolved "https://registry.yarnpkg.com/wsl-utils/-/wsl-utils-0.1.0.tgz#8783d4df671d4d50365be2ee4c71917a0557baab" + integrity sha512-h3Fbisa2nKGPxCpm89Hk33lBLsnaGBvctQopaBSOW/uIs6FTe1ATyAnKFJrzVs9vpGdsTe73WF3V4lIsk4Gacw== + dependencies: + is-wsl "^3.1.0" xdg-basedir@^5.0.1, xdg-basedir@^5.1.0: version "5.1.0" @@ -8703,6 +8949,11 @@ yocto-queue@^1.0.0: resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-1.2.1.tgz#36d7c4739f775b3cbc28e6136e21aa057adec418" integrity sha512-AyeEbWOu/TAXdxlV9wmGcR0+yh2j3vYPGOECcIj2S7MkrLyC7ne+oye2BKTItt0ii2PHk4cDy+95+LshzbXnGg== +zod@^4.1.8: + version "4.1.12" + resolved "https://registry.yarnpkg.com/zod/-/zod-4.1.12.tgz#64f1ea53d00eab91853195653b5af9eee68970f0" + integrity sha512-JInaHOamG8pt5+Ey8kGmdcAcg3OL9reK8ltczgHTAwNhMys/6ThXHityHxVV2p3fkw/c+MAvBHFVYHFZDmjMCQ== + zwitch@^2.0.0: version "2.0.4" resolved "https://registry.yarnpkg.com/zwitch/-/zwitch-2.0.4.tgz#c827d4b0acb76fc3e685a4c6ec2902d51070e9d7" diff --git a/examples/classic/docs/intro.md b/examples/classic/docs/intro.md index 45e8604c8b..88f9571445 100644 --- a/examples/classic/docs/intro.md +++ b/examples/classic/docs/intro.md @@ -14,7 +14,7 @@ Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new ### What you'll need -- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: +- [Node.js](https://nodejs.org/en/download/) version 20.0 or above: - When installing Node.js, you are recommended to check all checkboxes related to dependencies. ## Generate a new site diff --git a/examples/classic/docusaurus.config.js b/examples/classic/docusaurus.config.js index c1d553465e..be91f221b4 100644 --- a/examples/classic/docusaurus.config.js +++ b/examples/classic/docusaurus.config.js @@ -31,7 +31,6 @@ const config = { projectName: 'docusaurus', // Usually your repo name. onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'warn', // Even if you don't use internationalization, you can use this field to set // useful metadata like html lang. For example, if your site is Chinese, you @@ -80,6 +79,9 @@ const config = { ({ // Replace with your project's social card image: 'img/docusaurus-social-card.jpg', + colorMode: { + respectPrefersColorScheme: true, + }, navbar: { title: 'My Site', logo: { diff --git a/examples/classic/package.json b/examples/classic/package.json index a5b3295335..3371a1dbcd 100644 --- a/examples/classic/package.json +++ b/examples/classic/package.json @@ -15,8 +15,8 @@ "dev": "docusaurus start" }, "dependencies": { - "@docusaurus/core": "3.8.0", - "@docusaurus/preset-classic": "3.8.0", + "@docusaurus/core": "3.9.2", + "@docusaurus/preset-classic": "3.9.2", "@mdx-js/react": "^3.0.0", "clsx": "^2.0.0", "prism-react-renderer": "^2.3.0", @@ -24,8 +24,8 @@ "react-dom": "^19.0.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.8.0", - "@docusaurus/types": "3.8.0" + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/types": "3.9.2" }, "browserslist": { "production": [ @@ -40,7 +40,7 @@ ] }, "engines": { - "node": ">=18.0" + "node": ">=20.0" }, "description": "Docusaurus example project" } diff --git a/examples/classic/yarn.lock b/examples/classic/yarn.lock index 55e721c62f..c09a713fe5 100644 --- a/examples/classic/yarn.lock +++ b/examples/classic/yarn.lock @@ -2,161 +2,191 @@ # yarn lockfile v1 -"@algolia/autocomplete-core@1.17.9": - version "1.17.9" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.17.9.tgz#83374c47dc72482aa45d6b953e89377047f0dcdc" - integrity sha512-O7BxrpLDPJWWHv/DLA9DRFWs+iY1uOJZkqUwjS5HSZAGcl0hIVCQ97LTLewiZmZ402JYUrun+8NqFP+hCknlbQ== +"@ai-sdk/gateway@2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@ai-sdk/gateway/-/gateway-2.0.0.tgz#d291c40fa869174af5b7230bd838d1028488a6fd" + integrity sha512-Gj0PuawK7NkZuyYgO/h5kDK/l6hFOjhLdTq3/Lli1FTl47iGmwhH1IZQpAL3Z09BeFYWakcwUmn02ovIm2wy9g== dependencies: - "@algolia/autocomplete-plugin-algolia-insights" "1.17.9" - "@algolia/autocomplete-shared" "1.17.9" + "@ai-sdk/provider" "2.0.0" + "@ai-sdk/provider-utils" "3.0.12" + "@vercel/oidc" "3.0.3" -"@algolia/autocomplete-plugin-algolia-insights@1.17.9": - version "1.17.9" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.17.9.tgz#74c86024d09d09e8bfa3dd90b844b77d9f9947b6" - integrity sha512-u1fEHkCbWF92DBeB/KHeMacsjsoI0wFhjZtlCq2ddZbAehshbZST6Hs0Avkc0s+4UyBGbMDnSuXHLuvRWK5iDQ== +"@ai-sdk/provider-utils@3.0.12": + version "3.0.12" + resolved "https://registry.yarnpkg.com/@ai-sdk/provider-utils/-/provider-utils-3.0.12.tgz#9812a0b7ce36f2cae81dff3afe70f0c4bde76213" + integrity sha512-ZtbdvYxdMoria+2SlNarEk6Hlgyf+zzcznlD55EAl+7VZvJaSg2sqPvwArY7L6TfDEDJsnCq0fdhBSkYo0Xqdg== dependencies: - "@algolia/autocomplete-shared" "1.17.9" + "@ai-sdk/provider" "2.0.0" + "@standard-schema/spec" "^1.0.0" + eventsource-parser "^3.0.5" -"@algolia/autocomplete-preset-algolia@1.17.9": - version "1.17.9" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.17.9.tgz#911f3250544eb8ea4096fcfb268f156b085321b5" - integrity sha512-Na1OuceSJeg8j7ZWn5ssMu/Ax3amtOwk76u4h5J4eK2Nx2KB5qt0Z4cOapCsxot9VcEN11ADV5aUSlQF4RhGjQ== +"@ai-sdk/provider@2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@ai-sdk/provider/-/provider-2.0.0.tgz#b853c739d523b33675bc74b6c506b2c690bc602b" + integrity sha512-6o7Y2SeO9vFKB8lArHXehNuusnpddKPk7xqL7T2/b+OvXMRIXUO1rR4wcv1hAFUAT9avGZshty3Wlua/XA7TvA== dependencies: - "@algolia/autocomplete-shared" "1.17.9" + json-schema "^0.4.0" -"@algolia/autocomplete-shared@1.17.9": - version "1.17.9" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.17.9.tgz#5f38868f7cb1d54b014b17a10fc4f7e79d427fa8" - integrity sha512-iDf05JDQ7I0b7JEA/9IektxN/80a2MZ1ToohfmNS3rfeuQnIKI3IJlIafD0xu4StbtQTghx9T3Maa97ytkXenQ== - -"@algolia/client-abtesting@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/client-abtesting/-/client-abtesting-5.25.0.tgz#012204f1614e1a71366fb1e117c8f195186ff081" - integrity sha512-1pfQulNUYNf1Tk/svbfjfkLBS36zsuph6m+B6gDkPEivFmso/XnRgwDvjAx80WNtiHnmeNjIXdF7Gos8+OLHqQ== +"@ai-sdk/react@^2.0.30": + version "2.0.76" + resolved "https://registry.yarnpkg.com/@ai-sdk/react/-/react-2.0.76.tgz#eba2457f208d1762f16f807e1c4324cdf63bd969" + integrity sha512-ggAPzyaKJTqUWigpxMzI5DuC0Y3iEpDUPCgz6/6CpnKZY/iok+x5xiZhDemeaP0ILw5IQekV0kdgBR8JPgI8zQ== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@ai-sdk/provider-utils" "3.0.12" + ai "5.0.76" + swr "^2.2.5" + throttleit "2.1.0" -"@algolia/client-analytics@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/client-analytics/-/client-analytics-5.25.0.tgz#eba015bfafb3dbb82712c9160a00717a5974ff71" - integrity sha512-AFbG6VDJX/o2vDd9hqncj1B6B4Tulk61mY0pzTtzKClyTDlNP0xaUiEKhl6E7KO9I/x0FJF5tDCm0Hn6v5x18A== +"@algolia/abtesting@1.6.1": + version "1.6.1" + resolved "https://registry.yarnpkg.com/@algolia/abtesting/-/abtesting-1.6.1.tgz#1074f6df6a59b371f56fdb5ddc2caec1853bcc58" + integrity sha512-wV/gNRkzb7sI9vs1OneG129hwe3Q5zPj7zigz3Ps7M5Lpo2hSorrOnXNodHEOV+yXE/ks4Pd+G3CDFIjFTWhMQ== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" -"@algolia/client-common@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-5.25.0.tgz#2def8947efe849266057d92f67d1b8d83de0c005" - integrity sha512-il1zS/+Rc6la6RaCdSZ2YbJnkQC6W1wiBO8+SH+DE6CPMWBU6iDVzH0sCKSAtMWl9WBxoN6MhNjGBnCv9Yy2bA== - -"@algolia/client-insights@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/client-insights/-/client-insights-5.25.0.tgz#b87df8614b96c4cc9c9aa7765cce07fa70864fa8" - integrity sha512-blbjrUH1siZNfyCGeq0iLQu00w3a4fBXm0WRIM0V8alcAPo7rWjLbMJMrfBtzL9X5ic6wgxVpDADXduGtdrnkw== +"@algolia/autocomplete-core@1.19.2": + version "1.19.2" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.19.2.tgz#702df67a08cb3cfe8c33ee1111ef136ec1a9e232" + integrity sha512-mKv7RyuAzXvwmq+0XRK8HqZXt9iZ5Kkm2huLjgn5JoCPtDy+oh9yxUMfDDaVCw0oyzZ1isdJBc7l9nuCyyR7Nw== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/autocomplete-plugin-algolia-insights" "1.19.2" + "@algolia/autocomplete-shared" "1.19.2" -"@algolia/client-personalization@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-5.25.0.tgz#74b041f0e7d91e1009c131c8d716c34e4d45c30f" - integrity sha512-aywoEuu1NxChBcHZ1pWaat0Plw7A8jDMwjgRJ00Mcl7wGlwuPt5dJ/LTNcg3McsEUbs2MBNmw0ignXBw9Tbgow== +"@algolia/autocomplete-plugin-algolia-insights@1.19.2": + version "1.19.2" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.19.2.tgz#3584b625b9317e333d1ae43664d02358e175c52d" + integrity sha512-TjxbcC/r4vwmnZaPwrHtkXNeqvlpdyR+oR9Wi2XyfORkiGkLTVhX2j+O9SaCCINbKoDfc+c2PB8NjfOnz7+oKg== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/autocomplete-shared" "1.19.2" -"@algolia/client-query-suggestions@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/client-query-suggestions/-/client-query-suggestions-5.25.0.tgz#e92d935d9e2994f790d43c64d3518d81070a3888" - integrity sha512-a/W2z6XWKjKjIW1QQQV8PTTj1TXtaKx79uR3NGBdBdGvVdt24KzGAaN7sCr5oP8DW4D3cJt44wp2OY/fZcPAVA== - dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" +"@algolia/autocomplete-shared@1.19.2": + version "1.19.2" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.19.2.tgz#c0b7b8dc30a5c65b70501640e62b009535e4578f" + integrity sha512-jEazxZTVD2nLrC+wYlVHQgpBoBB5KPStrJxLzsIFl6Kqd1AlG9sIAGl39V5tECLpIQzB3Qa2T6ZPJ1ChkwMK/w== -"@algolia/client-search@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-5.25.0.tgz#dc38ca1015f2f4c9f5053a4517f96fb28a2117f8" - integrity sha512-9rUYcMIBOrCtYiLX49djyzxqdK9Dya/6Z/8sebPn94BekT+KLOpaZCuc6s0Fpfq7nx5J6YY5LIVFQrtioK9u0g== +"@algolia/client-abtesting@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/client-abtesting/-/client-abtesting-5.40.1.tgz#6674c20731e887a081edf7ea009fe00ce20537d4" + integrity sha512-cxKNATPY5t+Mv8XAVTI57altkaPH+DZi4uMrnexPxPHODMljhGYY+GDZyHwv9a+8CbZHcY372OkxXrDMZA4Lnw== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" + +"@algolia/client-analytics@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/client-analytics/-/client-analytics-5.40.1.tgz#6550da491a59e9bc5112d9aeb1964e04b34543c5" + integrity sha512-XP008aMffJCRGAY8/70t+hyEyvqqV7YKm502VPu0+Ji30oefrTn2al7LXkITz7CK6I4eYXWRhN6NaIUi65F1OA== + dependencies: + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" + +"@algolia/client-common@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-5.40.1.tgz#df272c1eb491e7e4b15eaa44e4ad781630b4a438" + integrity sha512-gWfQuQUBtzUboJv/apVGZMoxSaB0M4Imwl1c9Ap+HpCW7V0KhjBddqF2QQt5tJZCOFsfNIgBbZDGsEPaeKUosw== + +"@algolia/client-insights@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/client-insights/-/client-insights-5.40.1.tgz#db53a74d78b004b176213dfe84cb250323e64906" + integrity sha512-RTLjST/t+lsLMouQ4zeLJq2Ss+UNkLGyNVu+yWHanx6kQ3LT5jv8UvPwyht9s7R6jCPnlSI77WnL80J32ZuyJg== + dependencies: + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" + +"@algolia/client-personalization@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-5.40.1.tgz#9e9885a1855b893ddb3cefa484d5d08158b622f5" + integrity sha512-2FEK6bUomBzEYkTKzD0iRs7Ljtjb45rKK/VSkyHqeJnG+77qx557IeSO0qVFE3SfzapNcoytTofnZum0BQ6r3Q== + dependencies: + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" + +"@algolia/client-query-suggestions@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/client-query-suggestions/-/client-query-suggestions-5.40.1.tgz#45dd6d7ad53f87043d44ffe983ab2d2385c8270a" + integrity sha512-Nju4NtxAvXjrV2hHZNLKVJLXjOlW6jAXHef/CwNzk1b2qIrCWDO589ELi5ZHH1uiWYoYyBXDQTtHmhaOVVoyXg== + dependencies: + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" + +"@algolia/client-search@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-5.40.1.tgz#9e179ac583dd9ddf638139e24971bb9229897931" + integrity sha512-Mw6pAUF121MfngQtcUb5quZVqMC68pSYYjCRZkSITC085S3zdk+h/g7i6FxnVdbSU6OztxikSDMh1r7Z+4iPlA== + dependencies: + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" "@algolia/events@^4.0.1": version "4.0.1" resolved "https://registry.yarnpkg.com/@algolia/events/-/events-4.0.1.tgz#fd39e7477e7bc703d7f893b556f676c032af3950" integrity sha512-FQzvOCgoFXAbf5Y6mYozw2aj5KCJoA3m4heImceldzPSMbdyS4atVjJzXKMsfX3wnZTFYwkkt8/z8UesLHlSBQ== -"@algolia/ingestion@1.25.0": - version "1.25.0" - resolved "https://registry.yarnpkg.com/@algolia/ingestion/-/ingestion-1.25.0.tgz#4d13c56dda0a05c7bacb0e3ef5866292dfd86ed5" - integrity sha512-jJeH/Hk+k17Vkokf02lkfYE4A+EJX+UgnMhTLR/Mb+d1ya5WhE+po8p5a/Nxb6lo9OLCRl6w3Hmk1TX1e9gVbQ== +"@algolia/ingestion@1.40.1": + version "1.40.1" + resolved "https://registry.yarnpkg.com/@algolia/ingestion/-/ingestion-1.40.1.tgz#eea0793d6e89b424d742d726de7419f5bcaefa16" + integrity sha512-z+BPlhs45VURKJIxsR99NNBWpUEEqIgwt10v/fATlNxc4UlXvALdOsWzaFfe89/lbP5Bu4+mbO59nqBC87ZM/g== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" -"@algolia/monitoring@1.25.0": - version "1.25.0" - resolved "https://registry.yarnpkg.com/@algolia/monitoring/-/monitoring-1.25.0.tgz#d59360cfe556338519d05a9d8107147e9dbcb020" - integrity sha512-Ls3i1AehJ0C6xaHe7kK9vPmzImOn5zBg7Kzj8tRYIcmCWVyuuFwCIsbuIIz/qzUf1FPSWmw0TZrGeTumk2fqXg== +"@algolia/monitoring@1.40.1": + version "1.40.1" + resolved "https://registry.yarnpkg.com/@algolia/monitoring/-/monitoring-1.40.1.tgz#50bf7286f3ba0fae220d7f5e0bf73c1b671f8958" + integrity sha512-VJMUMbO0wD8Rd2VVV/nlFtLJsOAQvjnVNGkMkspFiFhpBA7s/xJOb+fJvvqwKFUjbKTUA7DjiSi1ljSMYBasXg== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" -"@algolia/recommend@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/recommend/-/recommend-5.25.0.tgz#b96f12c85aa74a0326982c7801fcd4a610b420f4" - integrity sha512-79sMdHpiRLXVxSjgw7Pt4R1aNUHxFLHiaTDnN2MQjHwJ1+o3wSseb55T9VXU4kqy3m7TUme3pyRhLk5ip/S4Mw== +"@algolia/recommend@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/recommend/-/recommend-5.40.1.tgz#db8395ce0d17ccba03a877b42dce1f205bbdf5b9" + integrity sha512-ehvJLadKVwTp9Scg9NfzVSlBKH34KoWOQNTaN8i1Ac64AnO6iH2apJVSP6GOxssaghZ/s8mFQsDH3QIZoluFHA== dependencies: - "@algolia/client-common" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/client-common" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" -"@algolia/requester-browser-xhr@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.25.0.tgz#c194fa5f49206b9343e6646c41bfbca2a3f2ac54" - integrity sha512-JLaF23p1SOPBmfEqozUAgKHQrGl3z/Z5RHbggBu6s07QqXXcazEsub5VLonCxGVqTv6a61AAPr8J1G5HgGGjEw== +"@algolia/requester-browser-xhr@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.40.1.tgz#cddc52f7dc8e4b4a1051f90e55336d9573df62af" + integrity sha512-PbidVsPurUSQIr6X9/7s34mgOMdJnn0i6p+N6Ab+lsNhY5eiu+S33kZEpZwkITYBCIbhzDLOvb7xZD3gDi+USA== dependencies: - "@algolia/client-common" "5.25.0" + "@algolia/client-common" "5.40.1" -"@algolia/requester-fetch@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/requester-fetch/-/requester-fetch-5.25.0.tgz#231a2d0da2397d141f80b8f28e2cb6e3d219d38d" - integrity sha512-rtzXwqzFi1edkOF6sXxq+HhmRKDy7tz84u0o5t1fXwz0cwx+cjpmxu/6OQKTdOJFS92JUYHsG51Iunie7xbqfQ== +"@algolia/requester-fetch@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/requester-fetch/-/requester-fetch-5.40.1.tgz#3ec36412f7d10f4270a59e456d8e71a2eda58ea8" + integrity sha512-ThZ5j6uOZCF11fMw9IBkhigjOYdXGXQpj6h4k+T9UkZrF2RlKcPynFzDeRgaLdpYk8Yn3/MnFbwUmib7yxj5Lw== dependencies: - "@algolia/client-common" "5.25.0" + "@algolia/client-common" "5.40.1" -"@algolia/requester-node-http@5.25.0": - version "5.25.0" - resolved "https://registry.yarnpkg.com/@algolia/requester-node-http/-/requester-node-http-5.25.0.tgz#0ce13c550890de21c558b04381535d2d245a3725" - integrity sha512-ZO0UKvDyEFvyeJQX0gmZDQEvhLZ2X10K+ps6hViMo1HgE2V8em00SwNsQ+7E/52a+YiBkVWX61pJJJE44juDMQ== +"@algolia/requester-node-http@5.40.1": + version "5.40.1" + resolved "https://registry.yarnpkg.com/@algolia/requester-node-http/-/requester-node-http-5.40.1.tgz#ed3a9b1846f7d6be88839522ca0d337159d5ff66" + integrity sha512-H1gYPojO6krWHnUXu/T44DrEun/Wl95PJzMXRcM/szstNQczSbwq6wIFJPI9nyE95tarZfUNU3rgorT+wZ6iCQ== dependencies: - "@algolia/client-common" "5.25.0" - -"@ampproject/remapping@^2.2.0": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@ampproject/remapping/-/remapping-2.3.0.tgz#ed441b6fa600072520ce18b43d2c8cc8caecc7f4" - integrity sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw== - dependencies: - "@jridgewell/gen-mapping" "^0.3.5" - "@jridgewell/trace-mapping" "^0.3.24" + "@algolia/client-common" "5.40.1" "@babel/code-frame@^7.0.0", "@babel/code-frame@^7.27.1": version "7.27.1" @@ -167,51 +197,51 @@ js-tokens "^4.0.0" picocolors "^1.1.1" -"@babel/compat-data@^7.22.6", "@babel/compat-data@^7.27.2": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.27.3.tgz#cc49c2ac222d69b889bf34c795f537c0c6311111" - integrity sha512-V42wFfx1ymFte+ecf6iXghnnP8kWTO+ZLXIyZq+1LAXHHvTZdVxicn4yiVYdYMGaCO3tmqub11AorKkv+iodqw== +"@babel/compat-data@^7.27.2", "@babel/compat-data@^7.27.7", "@babel/compat-data@^7.28.0": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.28.4.tgz#96fdf1af1b8859c8474ab39c295312bfb7c24b04" + integrity sha512-YsmSKC29MJwf0gF8Rjjrg5LQCmyh+j/nD8/eP7f+BeoQTKYqs9RoWbjGOdy0+1Ekr68RJZMUOPVQaQisnIo4Rw== "@babel/core@^7.21.3", "@babel/core@^7.25.9": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.27.3.tgz#d7d05502bccede3cab36373ed142e6a1df554c2f" - integrity sha512-hyrN8ivxfvJ4i0fIJuV4EOlV0WDMz5Ui4StRTgVaAvWeiRCilXgwVvxJKtFQ3TKtHgJscB2YiXKGNJuVwhQMtA== + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.28.4.tgz#12a550b8794452df4c8b084f95003bce1742d496" + integrity sha512-2BCOP7TN8M+gVDj7/ht3hsaO/B/n5oDbiAyyvnRlNOs+u1o+JWNYTQrmpuNp1/Wq2gcFrI01JAW+paEKDMx/CA== dependencies: - "@ampproject/remapping" "^2.2.0" "@babel/code-frame" "^7.27.1" - "@babel/generator" "^7.27.3" + "@babel/generator" "^7.28.3" "@babel/helper-compilation-targets" "^7.27.2" - "@babel/helper-module-transforms" "^7.27.3" - "@babel/helpers" "^7.27.3" - "@babel/parser" "^7.27.3" + "@babel/helper-module-transforms" "^7.28.3" + "@babel/helpers" "^7.28.4" + "@babel/parser" "^7.28.4" "@babel/template" "^7.27.2" - "@babel/traverse" "^7.27.3" - "@babel/types" "^7.27.3" + "@babel/traverse" "^7.28.4" + "@babel/types" "^7.28.4" + "@jridgewell/remapping" "^2.3.5" convert-source-map "^2.0.0" debug "^4.1.0" gensync "^1.0.0-beta.2" json5 "^2.2.3" semver "^6.3.1" -"@babel/generator@^7.25.9", "@babel/generator@^7.27.3": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.27.3.tgz#ef1c0f7cfe3b5fc8cbb9f6cc69f93441a68edefc" - integrity sha512-xnlJYj5zepml8NXtjkG0WquFUv8RskFqyFcVgTBp5k+NaA/8uw/K+OSVf8AMGw5e9HKP2ETd5xpK5MLZQD6b4Q== +"@babel/generator@^7.25.9", "@babel/generator@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.28.3.tgz#9626c1741c650cbac39121694a0f2d7451b8ef3e" + integrity sha512-3lSpxGgvnmZznmBkCRnVREPUFJv2wrv9iAoFDvADJc0ypmdOxdUtcLeBgBJ6zE0PMeTKnxeQzyk0xTBq4Ep7zw== dependencies: - "@babel/parser" "^7.27.3" - "@babel/types" "^7.27.3" - "@jridgewell/gen-mapping" "^0.3.5" - "@jridgewell/trace-mapping" "^0.3.25" + "@babel/parser" "^7.28.3" + "@babel/types" "^7.28.2" + "@jridgewell/gen-mapping" "^0.3.12" + "@jridgewell/trace-mapping" "^0.3.28" jsesc "^3.0.2" -"@babel/helper-annotate-as-pure@^7.27.1": +"@babel/helper-annotate-as-pure@^7.27.1", "@babel/helper-annotate-as-pure@^7.27.3": version "7.27.3" resolved "https://registry.yarnpkg.com/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.27.3.tgz#f31fd86b915fc4daf1f3ac6976c59be7084ed9c5" integrity sha512-fXSwMQqitTGeHLBC08Eq5yXz2m37E4pJX1qAU1+2cNedz/ifv/bVXft90VeSav5nFO61EcNgwr0aJxbyPaWBPg== dependencies: "@babel/types" "^7.27.3" -"@babel/helper-compilation-targets@^7.22.6", "@babel/helper-compilation-targets@^7.27.1", "@babel/helper-compilation-targets@^7.27.2": +"@babel/helper-compilation-targets@^7.27.1", "@babel/helper-compilation-targets@^7.27.2": version "7.27.2" resolved "https://registry.yarnpkg.com/@babel/helper-compilation-targets/-/helper-compilation-targets-7.27.2.tgz#46a0f6efab808d51d29ce96858dd10ce8732733d" integrity sha512-2+1thGUUWWjLTYTHZWK1n8Yga0ijBz1XAhUXcKy81rd5g6yh7hGqMp45v7cadSbEHc9G3OTv45SyneRN3ps4DQ== @@ -222,17 +252,17 @@ lru-cache "^5.1.1" semver "^6.3.1" -"@babel/helper-create-class-features-plugin@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.27.1.tgz#5bee4262a6ea5ddc852d0806199eb17ca3de9281" - integrity sha512-QwGAmuvM17btKU5VqXfb+Giw4JcN0hjuufz3DYnpeVDvZLAObloM77bhMXiqry3Iio+Ai4phVRDwl6WU10+r5A== +"@babel/helper-create-class-features-plugin@^7.27.1", "@babel/helper-create-class-features-plugin@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.28.3.tgz#3e747434ea007910c320c4d39a6b46f20f371d46" + integrity sha512-V9f6ZFIYSLNEbuGA/92uOvYsGCJNsuA8ESZ4ldc09bWk/j8H8TKiPw8Mk1eG6olpnO0ALHJmYfZvF4MEE4gajg== dependencies: - "@babel/helper-annotate-as-pure" "^7.27.1" + "@babel/helper-annotate-as-pure" "^7.27.3" "@babel/helper-member-expression-to-functions" "^7.27.1" "@babel/helper-optimise-call-expression" "^7.27.1" "@babel/helper-replace-supers" "^7.27.1" "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" - "@babel/traverse" "^7.27.1" + "@babel/traverse" "^7.28.3" semver "^6.3.1" "@babel/helper-create-regexp-features-plugin@^7.18.6", "@babel/helper-create-regexp-features-plugin@^7.27.1": @@ -244,16 +274,21 @@ regexpu-core "^6.2.0" semver "^6.3.1" -"@babel/helper-define-polyfill-provider@^0.6.3", "@babel/helper-define-polyfill-provider@^0.6.4": - version "0.6.4" - resolved "https://registry.yarnpkg.com/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.4.tgz#15e8746368bfa671785f5926ff74b3064c291fab" - integrity sha512-jljfR1rGnXXNWnmQg2K3+bvhkxB51Rl32QRaOTuwwjviGrHzIbSc8+x9CpraDtbT7mfyjXObULP4w/adunNwAw== +"@babel/helper-define-polyfill-provider@^0.6.5": + version "0.6.5" + resolved "https://registry.yarnpkg.com/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.5.tgz#742ccf1cb003c07b48859fc9fa2c1bbe40e5f753" + integrity sha512-uJnGFcPsWQK8fvjgGP5LZUZZsYGIoPeRjSF5PGwrelYgq7Q15/Ft9NGFp1zglwgIv//W0uG4BevRuSJRyylZPg== dependencies: - "@babel/helper-compilation-targets" "^7.22.6" - "@babel/helper-plugin-utils" "^7.22.5" - debug "^4.1.1" + "@babel/helper-compilation-targets" "^7.27.2" + "@babel/helper-plugin-utils" "^7.27.1" + debug "^4.4.1" lodash.debounce "^4.0.8" - resolve "^1.14.2" + resolve "^1.22.10" + +"@babel/helper-globals@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/helper-globals/-/helper-globals-7.28.0.tgz#b9430df2aa4e17bc28665eadeae8aa1d985e6674" + integrity sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw== "@babel/helper-member-expression-to-functions@^7.27.1": version "7.27.1" @@ -271,14 +306,14 @@ "@babel/traverse" "^7.27.1" "@babel/types" "^7.27.1" -"@babel/helper-module-transforms@^7.27.1", "@babel/helper-module-transforms@^7.27.3": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.27.3.tgz#db0bbcfba5802f9ef7870705a7ef8788508ede02" - integrity sha512-dSOvYwvyLsWBeIRyOeHXp5vPj5l1I011r52FM1+r1jCERv+aFXYk4whgQccYEGYxK2H3ZAIA8nuPkQ0HaUo3qg== +"@babel/helper-module-transforms@^7.27.1", "@babel/helper-module-transforms@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.28.3.tgz#a2b37d3da3b2344fe085dab234426f2b9a2fa5f6" + integrity sha512-gytXUbs8k2sXS9PnQptz5o0QnpLL51SwASIORY6XaBKF88nsOT0Zw9szLqlSGQDP/4TljBAD5y98p2U1fqkdsw== dependencies: "@babel/helper-module-imports" "^7.27.1" "@babel/helper-validator-identifier" "^7.27.1" - "@babel/traverse" "^7.27.3" + "@babel/traverse" "^7.28.3" "@babel/helper-optimise-call-expression@^7.27.1": version "7.27.1" @@ -287,7 +322,7 @@ dependencies: "@babel/types" "^7.27.1" -"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.18.6", "@babel/helper-plugin-utils@^7.22.5", "@babel/helper-plugin-utils@^7.27.1", "@babel/helper-plugin-utils@^7.8.0": +"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.18.6", "@babel/helper-plugin-utils@^7.27.1", "@babel/helper-plugin-utils@^7.8.0": version "7.27.1" resolved "https://registry.yarnpkg.com/@babel/helper-plugin-utils/-/helper-plugin-utils-7.27.1.tgz#ddb2f876534ff8013e6c2b299bf4d39b3c51d44c" integrity sha512-1gn1Up5YXka3YYAHGKpbideQ5Yjf1tDa9qYcgysz+cNCXukyLl6DjPXhD3VRwSb8c0J9tA4b2+rHEZtc6R0tlw== @@ -334,28 +369,28 @@ integrity sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg== "@babel/helper-wrap-function@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/helper-wrap-function/-/helper-wrap-function-7.27.1.tgz#b88285009c31427af318d4fe37651cd62a142409" - integrity sha512-NFJK2sHUvrjo8wAU/nQTWU890/zB2jj0qBcCbZbbf+005cAsv6tMjXz31fBign6M5ov1o0Bllu+9nbqkfsjjJQ== - dependencies: - "@babel/template" "^7.27.1" - "@babel/traverse" "^7.27.1" - "@babel/types" "^7.27.1" - -"@babel/helpers@^7.27.3": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.27.3.tgz#387d65d279290e22fe7a47a8ffcd2d0c0184edd0" - integrity sha512-h/eKy9agOya1IGuLaZ9tEUgz+uIRXcbtOhRtUyyMf8JFmn1iT13vnl/IGVWSkdOCG/pC57U4S1jnAabAavTMwg== + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helper-wrap-function/-/helper-wrap-function-7.28.3.tgz#fe4872092bc1438ffd0ce579e6f699609f9d0a7a" + integrity sha512-zdf983tNfLZFletc0RRXYrHrucBEg95NIFMkn6K9dbeMYnsgHaSBGcQqdsCSStG2PYwRre0Qc2NNSCXbG+xc6g== dependencies: "@babel/template" "^7.27.2" - "@babel/types" "^7.27.3" + "@babel/traverse" "^7.28.3" + "@babel/types" "^7.28.2" -"@babel/parser@^7.27.2", "@babel/parser@^7.27.3": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.27.3.tgz#1b7533f0d908ad2ac545c4d05cbe2fb6dc8cfaaf" - integrity sha512-xyYxRj6+tLNDTWi0KCBcZ9V7yg3/lwL9DWh9Uwh/RIVlIfFidggcgxKX3GCXwCiswwcGRawBKbEg2LG/Y8eJhw== +"@babel/helpers@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.28.4.tgz#fe07274742e95bdf7cf1443593eeb8926ab63827" + integrity sha512-HFN59MmQXGHVyYadKLVumYsA9dBFun/ldYxipEjzA4196jpLZd8UjEEBLkbEkvfYreDqJhZxYAWFPtrfhNpj4w== dependencies: - "@babel/types" "^7.27.3" + "@babel/template" "^7.27.2" + "@babel/types" "^7.28.4" + +"@babel/parser@^7.27.2", "@babel/parser@^7.28.3", "@babel/parser@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.28.4.tgz#da25d4643532890932cc03f7705fe19637e03fa8" + integrity sha512-yZbBqeM6TkpP9du/I2pUZnJsRMGGvOuIrhjzC1AwHwW+6he4mni6Bp/m8ijn0iOuZuPI2BfkCoSRunpyjnrQKg== + dependencies: + "@babel/types" "^7.28.4" "@babel/plugin-bugfix-firefox-class-in-computed-class-key@^7.27.1": version "7.27.1" @@ -388,13 +423,13 @@ "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" "@babel/plugin-transform-optional-chaining" "^7.27.1" -"@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.27.1.tgz#bb1c25af34d75115ce229a1de7fa44bf8f955670" - integrity sha512-6BpaYGDavZqkI6yT+KSPdpZFfpnd68UKXbcjI9pJ13pvHhPrCKWOOLp+ysvMeA+DxnhuPpgIaRpxRxo5A9t5jw== +"@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.28.3.tgz#373f6e2de0016f73caf8f27004f61d167743742a" + integrity sha512-b6YTX108evsvE4YgWyQ921ZAFFQm3Bn+CA3+ZXlNVnPhx+UfsVURoPjfGAPCjBgrqo30yX/C2nZGX96DxvR9Iw== dependencies: "@babel/helper-plugin-utils" "^7.27.1" - "@babel/traverse" "^7.27.1" + "@babel/traverse" "^7.28.3" "@babel/plugin-proposal-private-property-in-object@7.21.0-placeholder-for-preset-env.2": version "7.21.0-placeholder-for-preset-env.2" @@ -451,14 +486,14 @@ dependencies: "@babel/helper-plugin-utils" "^7.27.1" -"@babel/plugin-transform-async-generator-functions@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.27.1.tgz#ca433df983d68e1375398e7ca71bf2a4f6fd89d7" - integrity sha512-eST9RrwlpaoJBDHShc+DS2SG4ATTi2MYNb4OxYkf3n+7eb49LWpnS+HSpVfW4x927qQwgk8A2hGNVaajAEw0EA== +"@babel/plugin-transform-async-generator-functions@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.28.0.tgz#1276e6c7285ab2cd1eccb0bc7356b7a69ff842c2" + integrity sha512-BEOdvX4+M765icNPZeidyADIvQ1m1gmunXufXxvRESy/jNNyfovIqUyE7MVgGBjWktCoJlzvFA1To2O4ymIO3Q== dependencies: "@babel/helper-plugin-utils" "^7.27.1" "@babel/helper-remap-async-to-generator" "^7.27.1" - "@babel/traverse" "^7.27.1" + "@babel/traverse" "^7.28.0" "@babel/plugin-transform-async-to-generator@^7.27.1": version "7.27.1" @@ -476,10 +511,10 @@ dependencies: "@babel/helper-plugin-utils" "^7.27.1" -"@babel/plugin-transform-block-scoping@^7.27.1": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.27.3.tgz#a21f37e222dc0a7b91c3784fa3bd4edf8d7a6dc1" - integrity sha512-+F8CnfhuLhwUACIJMLWnjz6zvzYM2r0yeIHKlbgfw7ml8rOMJsXNXV/hyRcb3nb493gRs4WvYpQAndWj/qQmkQ== +"@babel/plugin-transform-block-scoping@^7.28.0": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.28.4.tgz#e19ac4ddb8b7858bac1fd5c1be98a994d9726410" + integrity sha512-1yxmvN0MJHOhPVmAsmoW5liWwoILobu/d/ShymZmj867bAdxGbehIrew1DuLpw2Ukv+qDSSPQdYW1dLNE7t11A== dependencies: "@babel/helper-plugin-utils" "^7.27.1" @@ -491,25 +526,25 @@ "@babel/helper-create-class-features-plugin" "^7.27.1" "@babel/helper-plugin-utils" "^7.27.1" -"@babel/plugin-transform-class-static-block@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.27.1.tgz#7e920d5625b25bbccd3061aefbcc05805ed56ce4" - integrity sha512-s734HmYU78MVzZ++joYM+NkJusItbdRcbm+AGRgJCt3iA+yux0QpD9cBVdz3tKyrjVYWRl7j0mHSmv4lhV0aoA== +"@babel/plugin-transform-class-static-block@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.28.3.tgz#d1b8e69b54c9993bc558203e1f49bfc979bfd852" + integrity sha512-LtPXlBbRoc4Njl/oh1CeD/3jC+atytbnf/UqLoqTDcEYGUPj022+rvfkbDYieUrSj3CaV4yHDByPE+T2HwfsJg== dependencies: - "@babel/helper-create-class-features-plugin" "^7.27.1" + "@babel/helper-create-class-features-plugin" "^7.28.3" "@babel/helper-plugin-utils" "^7.27.1" -"@babel/plugin-transform-classes@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-classes/-/plugin-transform-classes-7.27.1.tgz#03bb04bea2c7b2f711f0db7304a8da46a85cced4" - integrity sha512-7iLhfFAubmpeJe/Wo2TVuDrykh/zlWXLzPNdL0Jqn/Xu8R3QQ8h9ff8FQoISZOsw74/HFqFI7NX63HN7QFIHKA== +"@babel/plugin-transform-classes@^7.28.3": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-classes/-/plugin-transform-classes-7.28.4.tgz#75d66175486788c56728a73424d67cbc7473495c" + integrity sha512-cFOlhIYPBv/iBoc+KS3M6et2XPtbT2HiCRfBXWtfpc9OAyostldxIf9YAYB6ypURBBbx+Qv6nyrLzASfJe+hBA== dependencies: - "@babel/helper-annotate-as-pure" "^7.27.1" - "@babel/helper-compilation-targets" "^7.27.1" + "@babel/helper-annotate-as-pure" "^7.27.3" + "@babel/helper-compilation-targets" "^7.27.2" + "@babel/helper-globals" "^7.28.0" "@babel/helper-plugin-utils" "^7.27.1" "@babel/helper-replace-supers" "^7.27.1" - "@babel/traverse" "^7.27.1" - globals "^11.1.0" + "@babel/traverse" "^7.28.4" "@babel/plugin-transform-computed-properties@^7.27.1": version "7.27.1" @@ -519,12 +554,13 @@ "@babel/helper-plugin-utils" "^7.27.1" "@babel/template" "^7.27.1" -"@babel/plugin-transform-destructuring@^7.27.1", "@babel/plugin-transform-destructuring@^7.27.3": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.27.3.tgz#3cc8299ed798d9a909f8d66ddeb40849ec32e3b0" - integrity sha512-s4Jrok82JpiaIprtY2nHsYmrThKvvwgHwjgd7UMiYhZaN0asdXNLr0y+NjTfkA7SyQE5i2Fb7eawUOZmLvyqOA== +"@babel/plugin-transform-destructuring@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.28.0.tgz#0f156588f69c596089b7d5b06f5af83d9aa7f97a" + integrity sha512-v1nrSMBiKcodhsyJ4Gf+Z0U/yawmJDBOTpEB3mcQY52r9RIyPneGyAS/yM6seP/8I+mWI3elOMtT5dB8GJVs+A== dependencies: "@babel/helper-plugin-utils" "^7.27.1" + "@babel/traverse" "^7.28.0" "@babel/plugin-transform-dotall-regex@^7.27.1": version "7.27.1" @@ -556,6 +592,14 @@ dependencies: "@babel/helper-plugin-utils" "^7.27.1" +"@babel/plugin-transform-explicit-resource-management@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-explicit-resource-management/-/plugin-transform-explicit-resource-management-7.28.0.tgz#45be6211b778dbf4b9d54c4e8a2b42fa72e09a1a" + integrity sha512-K8nhUcn3f6iB+P3gwCv/no7OdzOZQcKchW6N389V6PD8NUWKZHzndOd9sPDVbMoBsbmjMqlB4L9fm+fEFNVlwQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/plugin-transform-destructuring" "^7.28.0" + "@babel/plugin-transform-exponentiation-operator@^7.27.1": version "7.27.1" resolved "https://registry.yarnpkg.com/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.27.1.tgz#fc497b12d8277e559747f5a3ed868dd8064f83e1" @@ -678,15 +722,16 @@ dependencies: "@babel/helper-plugin-utils" "^7.27.1" -"@babel/plugin-transform-object-rest-spread@^7.27.2": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.27.3.tgz#ce130aa73fef828bc3e3e835f9bc6144be3eb1c0" - integrity sha512-7ZZtznF9g4l2JCImCo5LNKFHB5eXnN39lLtLY5Tg+VkR0jwOt7TBciMckuiQIOIW7L5tkQOCh3bVGYeXgMx52Q== +"@babel/plugin-transform-object-rest-spread@^7.28.0": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.28.4.tgz#9ee1ceca80b3e6c4bac9247b2149e36958f7f98d" + integrity sha512-373KA2HQzKhQCYiRVIRr+3MjpCObqzDlyrM6u4I201wL8Mp2wHf7uB8GhDwis03k2ti8Zr65Zyyqs1xOxUF/Ew== dependencies: "@babel/helper-compilation-targets" "^7.27.2" "@babel/helper-plugin-utils" "^7.27.1" - "@babel/plugin-transform-destructuring" "^7.27.3" - "@babel/plugin-transform-parameters" "^7.27.1" + "@babel/plugin-transform-destructuring" "^7.28.0" + "@babel/plugin-transform-parameters" "^7.27.7" + "@babel/traverse" "^7.28.4" "@babel/plugin-transform-object-super@^7.27.1": version "7.27.1" @@ -711,10 +756,10 @@ "@babel/helper-plugin-utils" "^7.27.1" "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" -"@babel/plugin-transform-parameters@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.27.1.tgz#80334b54b9b1ac5244155a0c8304a187a618d5a7" - integrity sha512-018KRk76HWKeZ5l4oTj2zPpSh+NbGdt0st5S6x0pga6HgrjBOJb24mMDHorFopOOd6YHkLgOZ+zaCjZGPO4aKg== +"@babel/plugin-transform-parameters@^7.27.7": + version "7.27.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.27.7.tgz#1fd2febb7c74e7d21cf3b05f7aebc907940af53a" + integrity sha512-qBkYTYCb76RRxUM6CcZA5KRu8K4SM8ajzVeUgVdMVO9NN9uI/GaVmBg/WKJJGnNokV9SY8FxNOVWGXzqzUidBg== dependencies: "@babel/helper-plugin-utils" "^7.27.1" @@ -750,9 +795,9 @@ "@babel/helper-plugin-utils" "^7.27.1" "@babel/plugin-transform-react-display-name@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-display-name/-/plugin-transform-react-display-name-7.27.1.tgz#43af31362d71f7848cfac0cbc212882b1a16e80f" - integrity sha512-p9+Vl3yuHPmkirRrg021XiP+EETmPMQTLr6Ayjj85RLNEbb3Eya/4VI0vAdzQG9SEAl2Lnt7fy5lZyMzjYoZQQ== + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-display-name/-/plugin-transform-react-display-name-7.28.0.tgz#6f20a7295fea7df42eb42fed8f896813f5b934de" + integrity sha512-D6Eujc2zMxKjfa4Zxl4GHMsmhKKZ9VpcqIchJLvwTxad9zWIYulwYItBovpDOoNLISpcZSXoDJ5gaGbQUDqViA== dependencies: "@babel/helper-plugin-utils" "^7.27.1" @@ -782,10 +827,10 @@ "@babel/helper-annotate-as-pure" "^7.27.1" "@babel/helper-plugin-utils" "^7.27.1" -"@babel/plugin-transform-regenerator@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.27.1.tgz#0a471df9213416e44cd66bf67176b66f65768401" - integrity sha512-B19lbbL7PMrKr52BNPjCqg1IyNUIjTcxKj8uX9zHO+PmWN93s19NDr/f69mIkEp2x9nmDJ08a7lgHaTTzvW7mw== +"@babel/plugin-transform-regenerator@^7.28.3": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.28.4.tgz#9d3fa3bebb48ddd0091ce5729139cd99c67cea51" + integrity sha512-+ZEdQlBoRg9m2NnzvEeLgtvBMO4tkFBw5SQIUgLICgTrumLoU7lr+Oghi6km2PFj+dbUt2u1oby2w3BDO9YQnA== dependencies: "@babel/helper-plugin-utils" "^7.27.1" @@ -805,15 +850,15 @@ "@babel/helper-plugin-utils" "^7.27.1" "@babel/plugin-transform-runtime@^7.25.9": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.27.3.tgz#ad35f1eff5ba18a5e23f7270e939fb5a59d3ec0b" - integrity sha512-bA9ZL5PW90YwNgGfjg6U+7Qh/k3zCEQJ06BFgAGRp/yMjw9hP9UGbGPtx3KSOkHGljEPCCxaE+PH4fUR2h1sDw== + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.28.3.tgz#f5990a1b2d2bde950ed493915e0719841c8d0eaa" + integrity sha512-Y6ab1kGqZ0u42Zv/4a7l0l72n9DKP/MKoKWaUSBylrhNZO2prYuqFOLbn5aW5SIFXwSH93yfjbgllL8lxuGKLg== dependencies: "@babel/helper-module-imports" "^7.27.1" "@babel/helper-plugin-utils" "^7.27.1" - babel-plugin-polyfill-corejs2 "^0.4.10" - babel-plugin-polyfill-corejs3 "^0.11.0" - babel-plugin-polyfill-regenerator "^0.6.1" + babel-plugin-polyfill-corejs2 "^0.4.14" + babel-plugin-polyfill-corejs3 "^0.13.0" + babel-plugin-polyfill-regenerator "^0.6.5" semver "^6.3.1" "@babel/plugin-transform-shorthand-properties@^7.27.1": @@ -853,11 +898,11 @@ "@babel/helper-plugin-utils" "^7.27.1" "@babel/plugin-transform-typescript@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.27.1.tgz#d3bb65598bece03f773111e88cc4e8e5070f1140" - integrity sha512-Q5sT5+O4QUebHdbwKedFBEwRLb02zJ7r4A5Gg2hUoLuU3FjdMcyqcywqUrLCaDsFCxzokf7u9kuy7qz51YUuAg== + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.28.0.tgz#796cbd249ab56c18168b49e3e1d341b72af04a6b" + integrity sha512-4AEiDEBPIZvLQaWlc9liCavE0xRM0dNca41WtBeM3jgFptfUOSG9z0uteLhq6+3rq+WB6jIvUwKDTpXEHPJ2Vg== dependencies: - "@babel/helper-annotate-as-pure" "^7.27.1" + "@babel/helper-annotate-as-pure" "^7.27.3" "@babel/helper-create-class-features-plugin" "^7.27.1" "@babel/helper-plugin-utils" "^7.27.1" "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" @@ -895,11 +940,11 @@ "@babel/helper-plugin-utils" "^7.27.1" "@babel/preset-env@^7.20.2", "@babel/preset-env@^7.25.9": - version "7.27.2" - resolved "https://registry.yarnpkg.com/@babel/preset-env/-/preset-env-7.27.2.tgz#106e6bfad92b591b1f6f76fd4cf13b7725a7bf9a" - integrity sha512-Ma4zSuYSlGNRlCLO+EAzLnCmJK2vdstgv+n7aUP+/IKZrOfWHOJVdSJtuub8RzHTj3ahD37k5OKJWvzf16TQyQ== + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/preset-env/-/preset-env-7.28.3.tgz#2b18d9aff9e69643789057ae4b942b1654f88187" + integrity sha512-ROiDcM+GbYVPYBOeCR6uBXKkQpBExLl8k9HO1ygXEyds39j+vCCsjmj7S8GOniZQlEs81QlkdJZe76IpLSiqpg== dependencies: - "@babel/compat-data" "^7.27.2" + "@babel/compat-data" "^7.28.0" "@babel/helper-compilation-targets" "^7.27.2" "@babel/helper-plugin-utils" "^7.27.1" "@babel/helper-validator-option" "^7.27.1" @@ -907,25 +952,26 @@ "@babel/plugin-bugfix-safari-class-field-initializer-scope" "^7.27.1" "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression" "^7.27.1" "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining" "^7.27.1" - "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly" "^7.27.1" + "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly" "^7.28.3" "@babel/plugin-proposal-private-property-in-object" "7.21.0-placeholder-for-preset-env.2" "@babel/plugin-syntax-import-assertions" "^7.27.1" "@babel/plugin-syntax-import-attributes" "^7.27.1" "@babel/plugin-syntax-unicode-sets-regex" "^7.18.6" "@babel/plugin-transform-arrow-functions" "^7.27.1" - "@babel/plugin-transform-async-generator-functions" "^7.27.1" + "@babel/plugin-transform-async-generator-functions" "^7.28.0" "@babel/plugin-transform-async-to-generator" "^7.27.1" "@babel/plugin-transform-block-scoped-functions" "^7.27.1" - "@babel/plugin-transform-block-scoping" "^7.27.1" + "@babel/plugin-transform-block-scoping" "^7.28.0" "@babel/plugin-transform-class-properties" "^7.27.1" - "@babel/plugin-transform-class-static-block" "^7.27.1" - "@babel/plugin-transform-classes" "^7.27.1" + "@babel/plugin-transform-class-static-block" "^7.28.3" + "@babel/plugin-transform-classes" "^7.28.3" "@babel/plugin-transform-computed-properties" "^7.27.1" - "@babel/plugin-transform-destructuring" "^7.27.1" + "@babel/plugin-transform-destructuring" "^7.28.0" "@babel/plugin-transform-dotall-regex" "^7.27.1" "@babel/plugin-transform-duplicate-keys" "^7.27.1" "@babel/plugin-transform-duplicate-named-capturing-groups-regex" "^7.27.1" "@babel/plugin-transform-dynamic-import" "^7.27.1" + "@babel/plugin-transform-explicit-resource-management" "^7.28.0" "@babel/plugin-transform-exponentiation-operator" "^7.27.1" "@babel/plugin-transform-export-namespace-from" "^7.27.1" "@babel/plugin-transform-for-of" "^7.27.1" @@ -942,15 +988,15 @@ "@babel/plugin-transform-new-target" "^7.27.1" "@babel/plugin-transform-nullish-coalescing-operator" "^7.27.1" "@babel/plugin-transform-numeric-separator" "^7.27.1" - "@babel/plugin-transform-object-rest-spread" "^7.27.2" + "@babel/plugin-transform-object-rest-spread" "^7.28.0" "@babel/plugin-transform-object-super" "^7.27.1" "@babel/plugin-transform-optional-catch-binding" "^7.27.1" "@babel/plugin-transform-optional-chaining" "^7.27.1" - "@babel/plugin-transform-parameters" "^7.27.1" + "@babel/plugin-transform-parameters" "^7.27.7" "@babel/plugin-transform-private-methods" "^7.27.1" "@babel/plugin-transform-private-property-in-object" "^7.27.1" "@babel/plugin-transform-property-literals" "^7.27.1" - "@babel/plugin-transform-regenerator" "^7.27.1" + "@babel/plugin-transform-regenerator" "^7.28.3" "@babel/plugin-transform-regexp-modifiers" "^7.27.1" "@babel/plugin-transform-reserved-words" "^7.27.1" "@babel/plugin-transform-shorthand-properties" "^7.27.1" @@ -963,10 +1009,10 @@ "@babel/plugin-transform-unicode-regex" "^7.27.1" "@babel/plugin-transform-unicode-sets-regex" "^7.27.1" "@babel/preset-modules" "0.1.6-no-external-plugins" - babel-plugin-polyfill-corejs2 "^0.4.10" - babel-plugin-polyfill-corejs3 "^0.11.0" - babel-plugin-polyfill-regenerator "^0.6.1" - core-js-compat "^3.40.0" + babel-plugin-polyfill-corejs2 "^0.4.14" + babel-plugin-polyfill-corejs3 "^0.13.0" + babel-plugin-polyfill-regenerator "^0.6.5" + core-js-compat "^3.43.0" semver "^6.3.1" "@babel/preset-modules@0.1.6-no-external-plugins": @@ -1002,16 +1048,16 @@ "@babel/plugin-transform-typescript" "^7.27.1" "@babel/runtime-corejs3@^7.25.9": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/runtime-corejs3/-/runtime-corejs3-7.27.3.tgz#b971a4a0a376171e266629152e74ef50e9931f79" - integrity sha512-ZYcgrwb+dkWNcDlsTe4fH1CMdqMDSJ5lWFd1by8Si2pI54XcQjte/+ViIPqAk7EAWisaUxvQ89grv+bNX2x8zg== + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/runtime-corejs3/-/runtime-corejs3-7.28.4.tgz#c25be39c7997ce2f130d70b9baecb8ed94df93fa" + integrity sha512-h7iEYiW4HebClDEhtvFObtPmIvrd1SSfpI9EhOeKk4CtIK/ngBWFpuhCzhdmRKtg71ylcue+9I6dv54XYO1epQ== dependencies: - core-js-pure "^3.30.2" + core-js-pure "^3.43.0" "@babel/runtime@^7.1.2", "@babel/runtime@^7.10.3", "@babel/runtime@^7.12.13", "@babel/runtime@^7.12.5", "@babel/runtime@^7.25.9": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.27.3.tgz#10491113799fb8d77e1d9273384d5d68deeea8f6" - integrity sha512-7EYtGezsdiDMyY80+65EzwiGmcJqpmcZCojSXaRgdrBaGtWTgDZKq69cPIVped6MkIM78cTQ2GOiEYjwOlG4xw== + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.28.4.tgz#a70226016fabe25c5783b2f22d3e1c9bc5ca3326" + integrity sha512-Q/N6JNWvIvPnLDvjlE1OUBLPQHH6l3CltCEsHIujp45zQUSSh8K+gHnaEX45yAT1nyngnINhvWtzN+Nb9D8RAQ== "@babel/template@^7.27.1", "@babel/template@^7.27.2": version "7.27.2" @@ -1022,23 +1068,23 @@ "@babel/parser" "^7.27.2" "@babel/types" "^7.27.1" -"@babel/traverse@^7.25.9", "@babel/traverse@^7.27.1", "@babel/traverse@^7.27.3": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.27.3.tgz#8b62a6c2d10f9d921ba7339c90074708509cffae" - integrity sha512-lId/IfN/Ye1CIu8xG7oKBHXd2iNb2aW1ilPszzGcJug6M8RCKfVNcYhpI5+bMvFYjK7lXIM0R+a+6r8xhHp2FQ== +"@babel/traverse@^7.25.9", "@babel/traverse@^7.27.1", "@babel/traverse@^7.28.0", "@babel/traverse@^7.28.3", "@babel/traverse@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.28.4.tgz#8d456101b96ab175d487249f60680221692b958b" + integrity sha512-YEzuboP2qvQavAcjgQNVgsvHIDv6ZpwXvcvjmyySP2DIMuByS/6ioU5G9pYrWHM6T2YDfc7xga9iNzYOs12CFQ== dependencies: "@babel/code-frame" "^7.27.1" - "@babel/generator" "^7.27.3" - "@babel/parser" "^7.27.3" + "@babel/generator" "^7.28.3" + "@babel/helper-globals" "^7.28.0" + "@babel/parser" "^7.28.4" "@babel/template" "^7.27.2" - "@babel/types" "^7.27.3" + "@babel/types" "^7.28.4" debug "^4.3.1" - globals "^11.1.0" -"@babel/types@^7.21.3", "@babel/types@^7.27.1", "@babel/types@^7.27.3", "@babel/types@^7.4.4": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.27.3.tgz#c0257bedf33aad6aad1f406d35c44758321eb3ec" - integrity sha512-Y1GkI4ktrtvmawoSq+4FCVHNryea6uR+qUQy0AGxLSsjCX0nVmkYQMBLHDkXZuo5hGx7eYdnIaslsdBFm7zbUw== +"@babel/types@^7.21.3", "@babel/types@^7.27.1", "@babel/types@^7.27.3", "@babel/types@^7.28.2", "@babel/types@^7.28.4", "@babel/types@^7.4.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.28.4.tgz#0a4e618f4c60a7cd6c11cb2d48060e4dbe38ac3a" + integrity sha512-bkFqkLhh3pMBUQQkpVgWDWq/lqzc2678eUyDlTBhRqhCHFguYYGM0Efga7tYk4TogG/3x0EEl66/OQ+WGbWB/Q== dependencies: "@babel/helper-string-parser" "^7.27.1" "@babel/helper-validator-identifier" "^7.27.1" @@ -1048,92 +1094,136 @@ resolved "https://registry.yarnpkg.com/@colors/colors/-/colors-1.5.0.tgz#bb504579c1cae923e6576a4f5da43d25f97bdbd9" integrity sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ== -"@csstools/cascade-layer-name-parser@^2.0.4": - version "2.0.4" - resolved "https://registry.yarnpkg.com/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.4.tgz#64d128529397aa1e1c986f685713363b262b81b1" - integrity sha512-7DFHlPuIxviKYZrOiwVU/PiHLm3lLUR23OMuEEtfEOQTOp9hzQ2JjdY6X5H18RVuUPJqSCI+qNnD5iOLMVE0bA== +"@csstools/cascade-layer-name-parser@^2.0.5": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.5.tgz#43f962bebead0052a9fed1a2deeb11f85efcbc72" + integrity sha512-p1ko5eHgV+MgXFVa4STPKpvPxr6ReS8oS2jzTukjR74i5zJNyWO1ZM1m8YKBXnzDKWfBN1ztLYlHxbVemDD88A== -"@csstools/color-helpers@^5.0.2": - version "5.0.2" - resolved "https://registry.yarnpkg.com/@csstools/color-helpers/-/color-helpers-5.0.2.tgz#82592c9a7c2b83c293d9161894e2a6471feb97b8" - integrity sha512-JqWH1vsgdGcw2RR6VliXXdA0/59LttzlU8UlRT/iUUsEeWfYq8I+K0yhihEUTTHLRm1EXvpsCx3083EU15ecsA== +"@csstools/color-helpers@^5.1.0": + version "5.1.0" + resolved "https://registry.yarnpkg.com/@csstools/color-helpers/-/color-helpers-5.1.0.tgz#106c54c808cabfd1ab4c602d8505ee584c2996ef" + integrity sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA== -"@csstools/css-calc@^2.1.3": - version "2.1.3" - resolved "https://registry.yarnpkg.com/@csstools/css-calc/-/css-calc-2.1.3.tgz#6f68affcb569a86b91965e8622d644be35a08423" - integrity sha512-XBG3talrhid44BY1x3MHzUx/aTG8+x/Zi57M4aTKK9RFB4aLlF3TTSzfzn8nWVHWL3FgAXAxmupmDd6VWww+pw== +"@csstools/css-calc@^2.1.4": + version "2.1.4" + resolved "https://registry.yarnpkg.com/@csstools/css-calc/-/css-calc-2.1.4.tgz#8473f63e2fcd6e459838dd412401d5948f224c65" + integrity sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ== -"@csstools/css-color-parser@^3.0.9": - version "3.0.9" - resolved "https://registry.yarnpkg.com/@csstools/css-color-parser/-/css-color-parser-3.0.9.tgz#8d81b77d6f211495b5100ec4cad4c8828de49f6b" - integrity sha512-wILs5Zk7BU86UArYBJTPy/FMPPKVKHMj1ycCEyf3VUptol0JNRLFU/BZsJ4aiIHJEbSLiizzRrw8Pc1uAEDrXw== +"@csstools/css-color-parser@^3.1.0": + version "3.1.0" + resolved "https://registry.yarnpkg.com/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz#4e386af3a99dd36c46fef013cfe4c1c341eed6f0" + integrity sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA== dependencies: - "@csstools/color-helpers" "^5.0.2" - "@csstools/css-calc" "^2.1.3" + "@csstools/color-helpers" "^5.1.0" + "@csstools/css-calc" "^2.1.4" -"@csstools/css-parser-algorithms@^3.0.4": +"@csstools/css-parser-algorithms@^3.0.5": + version "3.0.5" + resolved "https://registry.yarnpkg.com/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz#5755370a9a29abaec5515b43c8b3f2cf9c2e3076" + integrity sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ== + +"@csstools/css-tokenizer@^3.0.4": version "3.0.4" - resolved "https://registry.yarnpkg.com/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.4.tgz#74426e93bd1c4dcab3e441f5cc7ba4fb35d94356" - integrity sha512-Up7rBoV77rv29d3uKHUIVubz1BTcgyUK72IvCQAbfbMv584xHcGKCKbWh7i8hPrRJ7qU4Y8IO3IY9m+iTB7P3A== + resolved "https://registry.yarnpkg.com/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz#333fedabc3fd1a8e5d0100013731cf19e6a8c5d3" + integrity sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw== -"@csstools/css-tokenizer@^3.0.3": - version "3.0.3" - resolved "https://registry.yarnpkg.com/@csstools/css-tokenizer/-/css-tokenizer-3.0.3.tgz#a5502c8539265fecbd873c1e395a890339f119c2" - integrity sha512-UJnjoFsmxfKUdNYdWgOB0mWUypuLvAfQPH1+pyvRJs6euowbFkFC6P13w1l8mJyi3vxYMxc9kld5jZEGRQs6bw== +"@csstools/media-query-list-parser@^4.0.3": + version "4.0.3" + resolved "https://registry.yarnpkg.com/@csstools/media-query-list-parser/-/media-query-list-parser-4.0.3.tgz#7aec77bcb89c2da80ef207e73f474ef9e1b3cdf1" + integrity sha512-HAYH7d3TLRHDOUQK4mZKf9k9Ph/m8Akstg66ywKR4SFAigjs3yBiUeZtFxywiTm5moZMAp/5W/ZuFnNXXYLuuQ== -"@csstools/media-query-list-parser@^4.0.2": - version "4.0.2" - resolved "https://registry.yarnpkg.com/@csstools/media-query-list-parser/-/media-query-list-parser-4.0.2.tgz#e80e17eba1693fceafb8d6f2cfc68c0e7a9ab78a" - integrity sha512-EUos465uvVvMJehckATTlNqGj4UJWkTmdWuDMjqvSUkjGpmOyFZBVwb4knxCm/k2GMTXY+c/5RkdndzFYWeX5A== +"@csstools/postcss-alpha-function@^1.0.1": + version "1.0.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-alpha-function/-/postcss-alpha-function-1.0.1.tgz#7989605711de7831bc7cd75b94c9b5bac9c3728e" + integrity sha512-isfLLwksH3yHkFXfCI2Gcaqg7wGGHZZwunoJzEZk0yKYIokgre6hYVFibKL3SYAoR1kBXova8LB+JoO5vZzi9w== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" + "@csstools/utilities" "^2.0.0" -"@csstools/postcss-cascade-layers@^5.0.1": - version "5.0.1" - resolved "https://registry.yarnpkg.com/@csstools/postcss-cascade-layers/-/postcss-cascade-layers-5.0.1.tgz#9640313e64b5e39133de7e38a5aa7f40dc259597" - integrity sha512-XOfhI7GShVcKiKwmPAnWSqd2tBR0uxt+runAxttbSp/LY2U16yAVPmAf7e9q4JJ0d+xMNmpwNDLBXnmRCl3HMQ== +"@csstools/postcss-cascade-layers@^5.0.2": + version "5.0.2" + resolved "https://registry.yarnpkg.com/@csstools/postcss-cascade-layers/-/postcss-cascade-layers-5.0.2.tgz#dd2c70db3867b88975f2922da3bfbae7d7a2cae7" + integrity sha512-nWBE08nhO8uWl6kSAeCx4im7QfVko3zLrtgWZY4/bP87zrSPpSyN/3W3TDqz1jJuH+kbKOHXg5rJnK+ZVYcFFg== dependencies: "@csstools/selector-specificity" "^5.0.0" postcss-selector-parser "^7.0.0" -"@csstools/postcss-color-function@^4.0.9": - version "4.0.9" - resolved "https://registry.yarnpkg.com/@csstools/postcss-color-function/-/postcss-color-function-4.0.9.tgz#67080c6b4635926d68cc9c8f52261b87ece70bf8" - integrity sha512-2UeQCGMO5+EeQsPQK2DqXp0dad+P6nIz6G2dI06APpBuYBKxZEq7CTH+UiztFQ8cB1f89dnO9+D/Kfr+JfI2hw== +"@csstools/postcss-color-function-display-p3-linear@^1.0.1": + version "1.0.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-function-display-p3-linear/-/postcss-color-function-display-p3-linear-1.0.1.tgz#3017ff5e1f65307d6083e58e93d76724fb1ebf9f" + integrity sha512-E5qusdzhlmO1TztYzDIi8XPdPoYOjoTY6HBYBCYSj+Gn4gQRBlvjgPQXzfzuPQqt8EhkC/SzPKObg4Mbn8/xMg== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" -"@csstools/postcss-color-mix-function@^3.0.9": - version "3.0.9" - resolved "https://registry.yarnpkg.com/@csstools/postcss-color-mix-function/-/postcss-color-mix-function-3.0.9.tgz#103858388ba4d2c589daeecb02f9f05baecc27d0" - integrity sha512-Enj7ZIIkLD7zkGCN31SZFx4H1gKiCs2Y4taBo/v/cqaHN7p1qGrf5UTMNSjQFZ7MgClGufHx4pddwFTGL+ipug== +"@csstools/postcss-color-function@^4.0.12": + version "4.0.12" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-function/-/postcss-color-function-4.0.12.tgz#a7c85a98c77b522a194a1bbb00dd207f40c7a771" + integrity sha512-yx3cljQKRaSBc2hfh8rMZFZzChaFgwmO2JfFgFr1vMcF3C/uyy5I4RFIBOIWGq1D+XbKCG789CGkG6zzkLpagA== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" -"@csstools/postcss-content-alt-text@^2.0.5": - version "2.0.5" - resolved "https://registry.yarnpkg.com/@csstools/postcss-content-alt-text/-/postcss-content-alt-text-2.0.5.tgz#86b195bef6ce32179a68011b87212a3e4e73b84a" - integrity sha512-9BOS535v6YmyOYk32jAHXeddRV+iyd4vRcbrEekpwxmueAXX5J8WgbceFnE4E4Pmw/ysnB9v+n/vSWoFmcLMcA== +"@csstools/postcss-color-mix-function@^3.0.12": + version "3.0.12" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-mix-function/-/postcss-color-mix-function-3.0.12.tgz#2f1ee9f8208077af069545c9bd79bb9733382c2a" + integrity sha512-4STERZfCP5Jcs13P1U5pTvI9SkgLgfMUMhdXW8IlJWkzOOOqhZIjcNhWtNJZes2nkBDsIKJ0CJtFtuaZ00moag== dependencies: - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" -"@csstools/postcss-exponential-functions@^2.0.8": +"@csstools/postcss-color-mix-variadic-function-arguments@^1.0.2": + version "1.0.2" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-mix-variadic-function-arguments/-/postcss-color-mix-variadic-function-arguments-1.0.2.tgz#b4012b62a4eaa24d694172bb7137f9d2319cb8f2" + integrity sha512-rM67Gp9lRAkTo+X31DUqMEq+iK+EFqsidfecmhrteErxJZb6tUoJBVQca1Vn1GpDql1s1rD1pKcuYzMsg7Z1KQ== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-content-alt-text@^2.0.8": version "2.0.8" - resolved "https://registry.yarnpkg.com/@csstools/postcss-exponential-functions/-/postcss-exponential-functions-2.0.8.tgz#da6b3673fcb48a78294d39d6afc1e4da45dedada" - integrity sha512-vHgDXtGIBPpFQnFNDftMQg4MOuXcWnK91L/7REjBNYzQ/p2Fa/6RcnehTqCRrNtQ46PNIolbRsiDdDuxiHolwQ== + resolved "https://registry.yarnpkg.com/@csstools/postcss-content-alt-text/-/postcss-content-alt-text-2.0.8.tgz#1d52da1762893c32999ff76839e48d6ec7c7a4cb" + integrity sha512-9SfEW9QCxEpTlNMnpSqFaHyzsiRpZ5J5+KqCu1u5/eEJAWsMhzT40qf0FIbeeglEvrGRMdDzAxMIz3wqoGSb+Q== dependencies: - "@csstools/css-calc" "^2.1.3" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-contrast-color-function@^2.0.12": + version "2.0.12" + resolved "https://registry.yarnpkg.com/@csstools/postcss-contrast-color-function/-/postcss-contrast-color-function-2.0.12.tgz#ca46986d095c60f208d9e3f24704d199c9172637" + integrity sha512-YbwWckjK3qwKjeYz/CijgcS7WDUCtKTd8ShLztm3/i5dhh4NaqzsbYnhm4bjrpFpnLZ31jVcbK8YL77z3GBPzA== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-exponential-functions@^2.0.9": + version "2.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-exponential-functions/-/postcss-exponential-functions-2.0.9.tgz#fc03d1272888cb77e64cc1a7d8a33016e4f05c69" + integrity sha512-abg2W/PI3HXwS/CZshSa79kNWNZHdJPMBXeZNyPQFbbj8sKO3jXxOt/wF7juJVjyDTc6JrvaUZYFcSBZBhaxjw== + dependencies: + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" "@csstools/postcss-font-format-keywords@^4.0.0": version "4.0.0" @@ -1143,43 +1233,43 @@ "@csstools/utilities" "^2.0.0" postcss-value-parser "^4.2.0" -"@csstools/postcss-gamut-mapping@^2.0.9": - version "2.0.9" - resolved "https://registry.yarnpkg.com/@csstools/postcss-gamut-mapping/-/postcss-gamut-mapping-2.0.9.tgz#83b08d302865ce6fc3127589ff6658fe32635636" - integrity sha512-quksIsFm3DGsf8Qbr9KiSGBF2w3RwxSfOfma5wbORDB1AFF15r4EVW7sUuWw3s5IAEGMqzel/dE2rQsI7Yb8mA== +"@csstools/postcss-gamut-mapping@^2.0.11": + version "2.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-gamut-mapping/-/postcss-gamut-mapping-2.0.11.tgz#be0e34c9f0142852cccfc02b917511f0d677db8b" + integrity sha512-fCpCUgZNE2piVJKC76zFsgVW1apF6dpYsqGyH8SIeCcM4pTEsRTWTLCaJIMKFEundsCKwY1rwfhtrio04RJ4Dw== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" -"@csstools/postcss-gradients-interpolation-method@^5.0.9": - version "5.0.9" - resolved "https://registry.yarnpkg.com/@csstools/postcss-gradients-interpolation-method/-/postcss-gradients-interpolation-method-5.0.9.tgz#e2e1c59b08e7524c269bb4cac91618f95b9c849e" - integrity sha512-duqTeUHF4ambUybAmhX9KonkicLM/WNp2JjMUbegRD4O8A/tb6fdZ7jUNdp/UUiO1FIdDkMwmNw6856bT0XF8Q== +"@csstools/postcss-gradients-interpolation-method@^5.0.12": + version "5.0.12" + resolved "https://registry.yarnpkg.com/@csstools/postcss-gradients-interpolation-method/-/postcss-gradients-interpolation-method-5.0.12.tgz#0955cce4d97203b861bf66742bbec611b2f3661c" + integrity sha512-jugzjwkUY0wtNrZlFeyXzimUL3hN4xMvoPnIXxoZqxDvjZRiSh+itgHcVUWzJ2VwD/VAMEgCLvtaJHX+4Vj3Ow== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" -"@csstools/postcss-hwb-function@^4.0.9": - version "4.0.9" - resolved "https://registry.yarnpkg.com/@csstools/postcss-hwb-function/-/postcss-hwb-function-4.0.9.tgz#4abca35a88a382e211fc0abe125a8ce7bb07030b" - integrity sha512-sDpdPsoGAhYl/PMSYfu5Ez82wXb2bVkg1Cb8vsRLhpXhAk4OSlsJN+GodAql6tqc1B2G/WToxsFU6G74vkhPvA== +"@csstools/postcss-hwb-function@^4.0.12": + version "4.0.12" + resolved "https://registry.yarnpkg.com/@csstools/postcss-hwb-function/-/postcss-hwb-function-4.0.12.tgz#07f7ecb08c50e094673bd20eaf7757db0162beee" + integrity sha512-mL/+88Z53KrE4JdePYFJAQWFrcADEqsLprExCM04GDNgHIztwFzj0Mbhd/yxMBngq0NIlz58VVxjt5abNs1VhA== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" -"@csstools/postcss-ic-unit@^4.0.1": - version "4.0.1" - resolved "https://registry.yarnpkg.com/@csstools/postcss-ic-unit/-/postcss-ic-unit-4.0.1.tgz#7b67b49d85713d8bad70ee5735f409b19fd906f9" - integrity sha512-lECc38i1w3qU9nhrUhP6F8y4BfcQJkR1cb8N6tZNf2llM6zPkxnqt04jRCwsUgNcB3UGKDy+zLenhOYGHqCV+Q== +"@csstools/postcss-ic-unit@^4.0.4": + version "4.0.4" + resolved "https://registry.yarnpkg.com/@csstools/postcss-ic-unit/-/postcss-ic-unit-4.0.4.tgz#2ee2da0690db7edfbc469279711b9e69495659d2" + integrity sha512-yQ4VmossuOAql65sCPppVO1yfb7hDscf4GseF0VCA/DTDaBc0Wtf8MTqVPfjGYlT5+2buokG0Gp7y0atYZpwjg== dependencies: - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" postcss-value-parser "^4.2.0" @@ -1188,22 +1278,22 @@ resolved "https://registry.yarnpkg.com/@csstools/postcss-initial/-/postcss-initial-2.0.1.tgz#c385bd9d8ad31ad159edd7992069e97ceea4d09a" integrity sha512-L1wLVMSAZ4wovznquK0xmC7QSctzO4D0Is590bxpGqhqjboLXYA16dWZpfwImkdOgACdQ9PqXsuRroW6qPlEsg== -"@csstools/postcss-is-pseudo-class@^5.0.1": - version "5.0.1" - resolved "https://registry.yarnpkg.com/@csstools/postcss-is-pseudo-class/-/postcss-is-pseudo-class-5.0.1.tgz#12041448fedf01090dd4626022c28b7f7623f58e" - integrity sha512-JLp3POui4S1auhDR0n8wHd/zTOWmMsmK3nQd3hhL6FhWPaox5W7j1se6zXOG/aP07wV2ww0lxbKYGwbBszOtfQ== +"@csstools/postcss-is-pseudo-class@^5.0.3": + version "5.0.3" + resolved "https://registry.yarnpkg.com/@csstools/postcss-is-pseudo-class/-/postcss-is-pseudo-class-5.0.3.tgz#d34e850bcad4013c2ed7abe948bfa0448aa8eb74" + integrity sha512-jS/TY4SpG4gszAtIg7Qnf3AS2pjcUM5SzxpApOrlndMeGhIbaTzWBzzP/IApXoNWEW7OhcjkRT48jnAUIFXhAQ== dependencies: "@csstools/selector-specificity" "^5.0.0" postcss-selector-parser "^7.0.0" -"@csstools/postcss-light-dark-function@^2.0.8": - version "2.0.8" - resolved "https://registry.yarnpkg.com/@csstools/postcss-light-dark-function/-/postcss-light-dark-function-2.0.8.tgz#bac218338f458f9a3f05edcc94ab009def14a532" - integrity sha512-v8VU5WtrZIyEtk88WB4fkG22TGd8HyAfSFfZZQ1uNN0+arMJdZc++H3KYTfbYDpJRGy8GwADYH8ySXiILn+OyA== +"@csstools/postcss-light-dark-function@^2.0.11": + version "2.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-light-dark-function/-/postcss-light-dark-function-2.0.11.tgz#0df448aab9a33cb9a085264ff1f396fb80c4437d" + integrity sha512-fNJcKXJdPM3Lyrbmgw2OBbaioU7yuKZtiXClf4sGdQttitijYlZMD5K7HrC/eF83VRWRrYq6OZ0Lx92leV2LFA== dependencies: - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" "@csstools/postcss-logical-float-and-clear@^3.0.0": @@ -1228,32 +1318,32 @@ dependencies: postcss-value-parser "^4.2.0" -"@csstools/postcss-logical-viewport-units@^3.0.3": - version "3.0.3" - resolved "https://registry.yarnpkg.com/@csstools/postcss-logical-viewport-units/-/postcss-logical-viewport-units-3.0.3.tgz#f6cc63520ca2a6eb76b9cd946070c38dda66d733" - integrity sha512-OC1IlG/yoGJdi0Y+7duz/kU/beCwO+Gua01sD6GtOtLi7ByQUpcIqs7UE/xuRPay4cHgOMatWdnDdsIDjnWpPw== +"@csstools/postcss-logical-viewport-units@^3.0.4": + version "3.0.4" + resolved "https://registry.yarnpkg.com/@csstools/postcss-logical-viewport-units/-/postcss-logical-viewport-units-3.0.4.tgz#016d98a8b7b5f969e58eb8413447eb801add16fc" + integrity sha512-q+eHV1haXA4w9xBwZLKjVKAWn3W2CMqmpNpZUk5kRprvSiBEGMgrNH3/sJZ8UA3JgyHaOt3jwT9uFa4wLX4EqQ== dependencies: - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/css-tokenizer" "^3.0.4" "@csstools/utilities" "^2.0.0" -"@csstools/postcss-media-minmax@^2.0.8": - version "2.0.8" - resolved "https://registry.yarnpkg.com/@csstools/postcss-media-minmax/-/postcss-media-minmax-2.0.8.tgz#b5397f18531c54ac0c12cbf20b6bf93208bd5d16" - integrity sha512-Skum5wIXw2+NyCQWUyfstN3c1mfSh39DRAo+Uh2zzXOglBG8xB9hnArhYFScuMZkzeM+THVa//mrByKAfumc7w== +"@csstools/postcss-media-minmax@^2.0.9": + version "2.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-media-minmax/-/postcss-media-minmax-2.0.9.tgz#184252d5b93155ae526689328af6bdf3fc113987" + integrity sha512-af9Qw3uS3JhYLnCbqtZ9crTvvkR+0Se+bBqSr7ykAnl9yKhk6895z9rf+2F4dClIDJWxgn0iZZ1PSdkhrbs2ig== dependencies: - "@csstools/css-calc" "^2.1.3" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/media-query-list-parser" "^4.0.2" + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/media-query-list-parser" "^4.0.3" -"@csstools/postcss-media-queries-aspect-ratio-number-values@^3.0.4": - version "3.0.4" - resolved "https://registry.yarnpkg.com/@csstools/postcss-media-queries-aspect-ratio-number-values/-/postcss-media-queries-aspect-ratio-number-values-3.0.4.tgz#d71102172c74baf3f892fac88cf1ea46a961600d" - integrity sha512-AnGjVslHMm5xw9keusQYvjVWvuS7KWK+OJagaG0+m9QnIjZsrysD2kJP/tr/UJIyYtMCtu8OkUd+Rajb4DqtIQ== +"@csstools/postcss-media-queries-aspect-ratio-number-values@^3.0.5": + version "3.0.5" + resolved "https://registry.yarnpkg.com/@csstools/postcss-media-queries-aspect-ratio-number-values/-/postcss-media-queries-aspect-ratio-number-values-3.0.5.tgz#f485c31ec13d6b0fb5c528a3474334a40eff5f11" + integrity sha512-zhAe31xaaXOY2Px8IYfoVTB3wglbJUVigGphFLj6exb7cjZRH9A6adyE22XfFK3P2PzwRk0VDeTJmaxpluyrDg== dependencies: - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/media-query-list-parser" "^4.0.2" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/media-query-list-parser" "^4.0.3" "@csstools/postcss-nested-calc@^4.0.0": version "4.0.0" @@ -1270,42 +1360,42 @@ dependencies: postcss-value-parser "^4.2.0" -"@csstools/postcss-oklab-function@^4.0.9": - version "4.0.9" - resolved "https://registry.yarnpkg.com/@csstools/postcss-oklab-function/-/postcss-oklab-function-4.0.9.tgz#21d8846b3fe632d663b8cfe5d1fa2ccdd3f0709a" - integrity sha512-UHrnujimwtdDw8BYDcWJtBXuJ13uc/BjAddPdfMc/RsWxhg8gG8UbvTF0tnMtHrZ4i7lwy85fPEzK1AiykMyRA== +"@csstools/postcss-oklab-function@^4.0.12": + version "4.0.12" + resolved "https://registry.yarnpkg.com/@csstools/postcss-oklab-function/-/postcss-oklab-function-4.0.12.tgz#416640ef10227eea1375b47b72d141495950971d" + integrity sha512-HhlSmnE1NKBhXsTnNGjxvhryKtO7tJd1w42DKOGFD6jSHtYOrsJTQDKPMwvOfrzUAk8t7GcpIfRyM7ssqHpFjg== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" -"@csstools/postcss-progressive-custom-properties@^4.0.1": - version "4.0.1" - resolved "https://registry.yarnpkg.com/@csstools/postcss-progressive-custom-properties/-/postcss-progressive-custom-properties-4.0.1.tgz#487e619d2577358cb08ed7319dd203d4d5db5bb6" - integrity sha512-Ofz81HaY8mmbP8/Qr3PZlUzjsyV5WuxWmvtYn+jhYGvvjFazTmN9R2io5W5znY1tyk2CA9uM0IPWyY4ygDytCw== +"@csstools/postcss-progressive-custom-properties@^4.2.1": + version "4.2.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-progressive-custom-properties/-/postcss-progressive-custom-properties-4.2.1.tgz#c39780b9ff0d554efb842b6bd75276aa6f1705db" + integrity sha512-uPiiXf7IEKtUQXsxu6uWtOlRMXd2QWWy5fhxHDnPdXKCQckPP3E34ZgDoZ62r2iT+UOgWsSbM4NvHE5m3mAEdw== dependencies: postcss-value-parser "^4.2.0" -"@csstools/postcss-random-function@^2.0.0": - version "2.0.0" - resolved "https://registry.yarnpkg.com/@csstools/postcss-random-function/-/postcss-random-function-2.0.0.tgz#38da06d102bbe65504023278f670895c4a1ceef9" - integrity sha512-MYZKxSr4AKfjECL8vg49BbfNNzK+t3p2OWX+Xf7rXgMaTP44oy/e8VGWu4MLnJ3NUd9tFVkisLO/sg+5wMTNsg== +"@csstools/postcss-random-function@^2.0.1": + version "2.0.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-random-function/-/postcss-random-function-2.0.1.tgz#3191f32fe72936e361dadf7dbfb55a0209e2691e" + integrity sha512-q+FQaNiRBhnoSNo+GzqGOIBKoHQ43lYz0ICrV+UudfWnEF6ksS6DsBIJSISKQT2Bvu3g4k6r7t0zYrk5pDlo8w== dependencies: - "@csstools/css-calc" "^2.1.3" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" -"@csstools/postcss-relative-color-syntax@^3.0.9": - version "3.0.9" - resolved "https://registry.yarnpkg.com/@csstools/postcss-relative-color-syntax/-/postcss-relative-color-syntax-3.0.9.tgz#1075eda90bb2a59f30bed94605def0a99cad3040" - integrity sha512-+AGOcLF5PmMnTRPnOdCvY7AwvD5veIOhTWbJV6vC3hB1tt0ii/k6QOwhWfsGGg1ZPQ0JY15u+wqLR4ZTtB0luA== +"@csstools/postcss-relative-color-syntax@^3.0.12": + version "3.0.12" + resolved "https://registry.yarnpkg.com/@csstools/postcss-relative-color-syntax/-/postcss-relative-color-syntax-3.0.12.tgz#ced792450102441f7c160e1d106f33e4b44181f8" + integrity sha512-0RLIeONxu/mtxRtf3o41Lq2ghLimw0w9ByLWnnEVuy89exmEEq8bynveBxNW3nyHqLAFEeNtVEmC1QK9MZ8Huw== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" "@csstools/postcss-scope-pseudo-class@^4.0.1": @@ -1315,50 +1405,50 @@ dependencies: postcss-selector-parser "^7.0.0" -"@csstools/postcss-sign-functions@^1.1.3": - version "1.1.3" - resolved "https://registry.yarnpkg.com/@csstools/postcss-sign-functions/-/postcss-sign-functions-1.1.3.tgz#ba64c7a6e25f50221a2f37fac5d7592917245781" - integrity sha512-4F4GRhj8xNkBtLZ+3ycIhReaDfKJByXI+cQGIps3AzCO8/CJOeoDPxpMnL5vqZrWKOceSATHEQJUO/Q/r2y7OQ== +"@csstools/postcss-sign-functions@^1.1.4": + version "1.1.4" + resolved "https://registry.yarnpkg.com/@csstools/postcss-sign-functions/-/postcss-sign-functions-1.1.4.tgz#a9ac56954014ae4c513475b3f1b3e3424a1e0c12" + integrity sha512-P97h1XqRPcfcJndFdG95Gv/6ZzxUBBISem0IDqPZ7WMvc/wlO+yU0c5D/OCpZ5TJoTt63Ok3knGk64N+o6L2Pg== dependencies: - "@csstools/css-calc" "^2.1.3" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" -"@csstools/postcss-stepped-value-functions@^4.0.8": - version "4.0.8" - resolved "https://registry.yarnpkg.com/@csstools/postcss-stepped-value-functions/-/postcss-stepped-value-functions-4.0.8.tgz#345f5620cbeb0e9742f242e1dc6c88a051ce6700" - integrity sha512-6Y4yhL4fNhgzbZ/wUMQ4EjFUfoNNMpEXZnDw1JrlcEBHUT15gplchtFsZGk7FNi8PhLHJfCUwVKrEHzhfhKK+g== +"@csstools/postcss-stepped-value-functions@^4.0.9": + version "4.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-stepped-value-functions/-/postcss-stepped-value-functions-4.0.9.tgz#36036f1a0e5e5ee2308e72f3c9cb433567c387b9" + integrity sha512-h9btycWrsex4dNLeQfyU3y3w40LMQooJWFMm/SK9lrKguHDcFl4VMkncKKoXi2z5rM9YGWbUQABI8BT2UydIcA== dependencies: - "@csstools/css-calc" "^2.1.3" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" -"@csstools/postcss-text-decoration-shorthand@^4.0.2": - version "4.0.2" - resolved "https://registry.yarnpkg.com/@csstools/postcss-text-decoration-shorthand/-/postcss-text-decoration-shorthand-4.0.2.tgz#a3bcf80492e6dda36477538ab8e8943908c9f80a" - integrity sha512-8XvCRrFNseBSAGxeaVTaNijAu+FzUvjwFXtcrynmazGb/9WUdsPCpBX+mHEHShVRq47Gy4peYAoxYs8ltUnmzA== +"@csstools/postcss-text-decoration-shorthand@^4.0.3": + version "4.0.3" + resolved "https://registry.yarnpkg.com/@csstools/postcss-text-decoration-shorthand/-/postcss-text-decoration-shorthand-4.0.3.tgz#fae1b70f07d1b7beb4c841c86d69e41ecc6f743c" + integrity sha512-KSkGgZfx0kQjRIYnpsD7X2Om9BUXX/Kii77VBifQW9Ih929hK0KNjVngHDH0bFB9GmfWcR9vJYJJRvw/NQjkrA== dependencies: - "@csstools/color-helpers" "^5.0.2" + "@csstools/color-helpers" "^5.1.0" postcss-value-parser "^4.2.0" -"@csstools/postcss-trigonometric-functions@^4.0.8": - version "4.0.8" - resolved "https://registry.yarnpkg.com/@csstools/postcss-trigonometric-functions/-/postcss-trigonometric-functions-4.0.8.tgz#ad7940798fafadc77846e9ca47e2b594515d4f60" - integrity sha512-YcDvYTRu7f78/91B6bX+mE1WoAO91Su7/8KSRpuWbIGUB8hmaNSRu9wziaWSLJ1lOB1aQe+bvo9BIaLKqPOo/g== +"@csstools/postcss-trigonometric-functions@^4.0.9": + version "4.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-trigonometric-functions/-/postcss-trigonometric-functions-4.0.9.tgz#3f94ed2e319b57f2c59720b64e4d0a8a6fb8c3b2" + integrity sha512-Hnh5zJUdpNrJqK9v1/E3BbrQhaDTj5YiX7P61TOvUhoDHnUmsNNxcDAgkQ32RrcWx9GVUvfUNPcUkn8R3vIX6A== dependencies: - "@csstools/css-calc" "^2.1.3" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" "@csstools/postcss-unset-value@^4.0.0": version "4.0.0" resolved "https://registry.yarnpkg.com/@csstools/postcss-unset-value/-/postcss-unset-value-4.0.0.tgz#7caa981a34196d06a737754864baf77d64de4bba" integrity sha512-cBz3tOCI5Fw6NIFEwU3RiwK6mn3nKegjpJuzCndoGq3BZPkUjnsq7uQmIeMNeMbMk7YD2MfKcgCpZwX5jyXqCA== -"@csstools/selector-resolve-nested@^3.0.0": - version "3.0.0" - resolved "https://registry.yarnpkg.com/@csstools/selector-resolve-nested/-/selector-resolve-nested-3.0.0.tgz#704a9b637975680e025e069a4c58b3beb3e2752a" - integrity sha512-ZoK24Yku6VJU1gS79a5PFmC8yn3wIapiKmPgun0hZgEI5AOqgH2kiPRsPz1qkGv4HL+wuDLH83yQyk6inMYrJQ== +"@csstools/selector-resolve-nested@^3.1.0": + version "3.1.0" + resolved "https://registry.yarnpkg.com/@csstools/selector-resolve-nested/-/selector-resolve-nested-3.1.0.tgz#848c6f44cb65e3733e478319b9342b7aa436fac7" + integrity sha512-mf1LEW0tJLKfWyvn5KdDrhpxHyuxpbNwTIwOYLIvsTffeyOf85j5oIzfG0yosxDgx/sswlqBnESYUcQH0vgZ0g== "@csstools/selector-specificity@^5.0.0": version "5.0.0" @@ -1375,25 +1465,28 @@ resolved "https://registry.yarnpkg.com/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz#1d572bfbbe14b7704e0ba0f39b74815b84870d70" integrity sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw== -"@docsearch/css@3.9.0": - version "3.9.0" - resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-3.9.0.tgz#3bc29c96bf024350d73b0cfb7c2a7b71bf251cd5" - integrity sha512-cQbnVbq0rrBwNAKegIac/t6a8nWoUAn8frnkLFW6YARaRmAQr5/Eoe6Ln2fqkUCZ40KpdrKbpSAmgrkviOxuWA== +"@docsearch/css@4.2.0": + version "4.2.0" + resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-4.2.0.tgz#473bb4c51f4b2b037a71f423e569907ab19e6d72" + integrity sha512-65KU9Fw5fGsPPPlgIghonMcndyx1bszzrDQYLfierN+Ha29yotMHzVS94bPkZS6On9LS8dE4qmW4P/fGjtCf/g== -"@docsearch/react@^3.9.0": - version "3.9.0" - resolved "https://registry.yarnpkg.com/@docsearch/react/-/react-3.9.0.tgz#d0842b700c3ee26696786f3c8ae9f10c1a3f0db3" - integrity sha512-mb5FOZYZIkRQ6s/NWnM98k879vu5pscWqTLubLFBO87igYYT4VzVazh4h5o/zCvTIZgEt3PvsCOMOswOUo9yHQ== +"@docsearch/react@^3.9.0 || ^4.1.0": + version "4.2.0" + resolved "https://registry.yarnpkg.com/@docsearch/react/-/react-4.2.0.tgz#9dac48dfb4c1e5f18cf7323d8221d99c0d5f3e4e" + integrity sha512-zSN/KblmtBcerf7Z87yuKIHZQmxuXvYc6/m0+qnjyNu+Ir67AVOagTa1zBqcxkVUVkmBqUExdcyrdo9hbGbqTw== dependencies: - "@algolia/autocomplete-core" "1.17.9" - "@algolia/autocomplete-preset-algolia" "1.17.9" - "@docsearch/css" "3.9.0" - algoliasearch "^5.14.2" + "@ai-sdk/react" "^2.0.30" + "@algolia/autocomplete-core" "1.19.2" + "@docsearch/css" "4.2.0" + ai "^5.0.30" + algoliasearch "^5.28.0" + marked "^16.3.0" + zod "^4.1.8" -"@docusaurus/babel@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/babel/-/babel-3.8.0.tgz#2f390cc4e588a96ec496d87921e44890899738a6" - integrity sha512-9EJwSgS6TgB8IzGk1L8XddJLhZod8fXT4ULYMx6SKqyCBqCFpVCEjR/hNXXhnmtVM2irDuzYoVLGWv7srG/VOA== +"@docusaurus/babel@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/babel/-/babel-3.9.2.tgz#f956c638baeccf2040e482c71a742bc7e35fdb22" + integrity sha512-GEANdi/SgER+L7Japs25YiGil/AUDnFFHaCGPBbundxoWtCkA2lmy7/tFmgED4y1htAy6Oi4wkJEQdGssnw9MA== dependencies: "@babel/core" "^7.25.9" "@babel/generator" "^7.25.9" @@ -1405,54 +1498,54 @@ "@babel/runtime" "^7.25.9" "@babel/runtime-corejs3" "^7.25.9" "@babel/traverse" "^7.25.9" - "@docusaurus/logger" "3.8.0" - "@docusaurus/utils" "3.8.0" + "@docusaurus/logger" "3.9.2" + "@docusaurus/utils" "3.9.2" babel-plugin-dynamic-import-node "^2.3.3" fs-extra "^11.1.1" tslib "^2.6.0" -"@docusaurus/bundler@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/bundler/-/bundler-3.8.0.tgz#386f54dca594d81bac6b617c71822e0808d6e2f6" - integrity sha512-Rq4Z/MSeAHjVzBLirLeMcjLIAQy92pF1OI+2rmt18fSlMARfTGLWRE8Vb+ljQPTOSfJxwDYSzsK6i7XloD2rNA== +"@docusaurus/bundler@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/bundler/-/bundler-3.9.2.tgz#0ca82cda4acf13a493e3f66061aea351e9d356cf" + integrity sha512-ZOVi6GYgTcsZcUzjblpzk3wH1Fya2VNpd5jtHoCCFcJlMQ1EYXZetfAnRHLcyiFeBABaI1ltTYbOBtH/gahGVA== dependencies: "@babel/core" "^7.25.9" - "@docusaurus/babel" "3.8.0" - "@docusaurus/cssnano-preset" "3.8.0" - "@docusaurus/logger" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" + "@docusaurus/babel" "3.9.2" + "@docusaurus/cssnano-preset" "3.9.2" + "@docusaurus/logger" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" babel-loader "^9.2.1" - clean-css "^5.3.2" + clean-css "^5.3.3" copy-webpack-plugin "^11.0.0" - css-loader "^6.8.1" + css-loader "^6.11.0" css-minimizer-webpack-plugin "^5.0.1" cssnano "^6.1.2" file-loader "^6.2.0" html-minifier-terser "^7.2.0" - mini-css-extract-plugin "^2.9.1" + mini-css-extract-plugin "^2.9.2" null-loader "^4.0.1" - postcss "^8.4.26" - postcss-loader "^7.3.3" - postcss-preset-env "^10.1.0" + postcss "^8.5.4" + postcss-loader "^7.3.4" + postcss-preset-env "^10.2.1" terser-webpack-plugin "^5.3.9" tslib "^2.6.0" url-loader "^4.1.1" webpack "^5.95.0" webpackbar "^6.0.1" -"@docusaurus/core@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/core/-/core-3.8.0.tgz#79d5e1084415c8834a8a5cb87162ca13f52fe147" - integrity sha512-c7u6zFELmSGPEP9WSubhVDjgnpiHgDqMh1qVdCB7rTflh4Jx0msTYmMiO91Ez0KtHj4sIsDsASnjwfJ2IZp3Vw== +"@docusaurus/core@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/core/-/core-3.9.2.tgz#cc970f29b85a8926d63c84f8cffdcda43ed266ff" + integrity sha512-HbjwKeC+pHUFBfLMNzuSjqFE/58+rLVKmOU3lxQrpsxLBOGosYco/Q0GduBb0/jEMRiyEqjNT/01rRdOMWq5pw== dependencies: - "@docusaurus/babel" "3.8.0" - "@docusaurus/bundler" "3.8.0" - "@docusaurus/logger" "3.8.0" - "@docusaurus/mdx-loader" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-common" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/babel" "3.9.2" + "@docusaurus/bundler" "3.9.2" + "@docusaurus/logger" "3.9.2" + "@docusaurus/mdx-loader" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-common" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" boxen "^6.2.1" chalk "^4.1.2" chokidar "^3.5.3" @@ -1486,35 +1579,35 @@ update-notifier "^6.0.2" webpack "^5.95.0" webpack-bundle-analyzer "^4.10.2" - webpack-dev-server "^4.15.2" + webpack-dev-server "^5.2.2" webpack-merge "^6.0.1" -"@docusaurus/cssnano-preset@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/cssnano-preset/-/cssnano-preset-3.8.0.tgz#a70f19e2995be2299f5ef9c3da3e5d4d5c14bff2" - integrity sha512-UJ4hAS2T0R4WNy+phwVff2Q0L5+RXW9cwlH6AEphHR5qw3m/yacfWcSK7ort2pMMbDn8uGrD38BTm4oLkuuNoQ== +"@docusaurus/cssnano-preset@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/cssnano-preset/-/cssnano-preset-3.9.2.tgz#523aab65349db3c51a77f2489048d28527759428" + integrity sha512-8gBKup94aGttRduABsj7bpPFTX7kbwu+xh3K9NMCF5K4bWBqTFYW+REKHF6iBVDHRJ4grZdIPbvkiHd/XNKRMQ== dependencies: cssnano-preset-advanced "^6.1.2" - postcss "^8.4.38" + postcss "^8.5.4" postcss-sort-media-queries "^5.2.0" tslib "^2.6.0" -"@docusaurus/logger@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/logger/-/logger-3.8.0.tgz#c1abbb084a8058dc0047d57070fb9cd0241a679d" - integrity sha512-7eEMaFIam5Q+v8XwGqF/n0ZoCld4hV4eCCgQkfcN9Mq5inoZa6PHHW9Wu6lmgzoK5Kx3keEeABcO2SxwraoPDQ== +"@docusaurus/logger@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/logger/-/logger-3.9.2.tgz#6ec6364b90f5a618a438cc9fd01ac7376869f92a" + integrity sha512-/SVCc57ByARzGSU60c50rMyQlBuMIJCjcsJlkphxY6B0GV4UH3tcA1994N8fFfbJ9kX3jIBe/xg3XP5qBtGDbA== dependencies: chalk "^4.1.2" tslib "^2.6.0" -"@docusaurus/mdx-loader@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/mdx-loader/-/mdx-loader-3.8.0.tgz#2b225cd2b1159cc49b10b1cac63a927a8368274b" - integrity sha512-mDPSzssRnpjSdCGuv7z2EIAnPS1MHuZGTaRLwPn4oQwszu4afjWZ/60sfKjTnjBjI8Vl4OgJl2vMmfmiNDX4Ng== +"@docusaurus/mdx-loader@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/mdx-loader/-/mdx-loader-3.9.2.tgz#78d238de6c6203fa811cc2a7e90b9b79e111408c" + integrity sha512-wiYoGwF9gdd6rev62xDU8AAM8JuLI/hlwOtCzMmYcspEkzecKrP8J8X+KpYnTlACBUUtXNJpSoCwFWJhLRevzQ== dependencies: - "@docusaurus/logger" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/logger" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" "@mdx-js/mdx" "^3.0.0" "@slorber/remark-comment" "^1.0.0" escape-html "^1.0.3" @@ -1537,12 +1630,12 @@ vfile "^6.0.1" webpack "^5.88.1" -"@docusaurus/module-type-aliases@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/module-type-aliases/-/module-type-aliases-3.8.0.tgz#e487052c372538c5dcf2200999e13f328fa5ffaa" - integrity sha512-/uMb4Ipt5J/QnD13MpnoC/A4EYAe6DKNWqTWLlGrqsPJwJv73vSwkA25xnYunwfqWk0FlUQfGv/Swdh5eCCg7g== +"@docusaurus/module-type-aliases@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/module-type-aliases/-/module-type-aliases-3.9.2.tgz#993c7cb0114363dea5ef6855e989b3ad4b843a34" + integrity sha512-8qVe2QA9hVLzvnxP46ysuofJUIc/yYQ82tvA/rBTrnpXtCjNSFLxEZfd5U8cYZuJIVlkPxamsIgwd5tGZXfvew== dependencies: - "@docusaurus/types" "3.8.0" + "@docusaurus/types" "3.9.2" "@types/history" "^4.7.11" "@types/react" "*" "@types/react-router-config" "*" @@ -1550,19 +1643,19 @@ react-helmet-async "npm:@slorber/react-helmet-async@1.3.0" react-loadable "npm:@docusaurus/react-loadable@6.0.0" -"@docusaurus/plugin-content-blog@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.8.0.tgz#0c200b1fb821e09e9e975c45255e5ddfab06c392" - integrity sha512-0SlOTd9R55WEr1GgIXu+hhTT0hzARYx3zIScA5IzpdekZQesI/hKEa5LPHBd415fLkWMjdD59TaW/3qQKpJ0Lg== +"@docusaurus/plugin-content-blog@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.9.2.tgz#d5ce51eb7757bdab0515e2dd26a793ed4e119df9" + integrity sha512-3I2HXy3L1QcjLJLGAoTvoBnpOwa6DPUa3Q0dMK19UTY9mhPkKQg/DYhAGTiBUKcTR0f08iw7kLPqOhIgdV3eVQ== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/logger" "3.8.0" - "@docusaurus/mdx-loader" "3.8.0" - "@docusaurus/theme-common" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-common" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/logger" "3.9.2" + "@docusaurus/mdx-loader" "3.9.2" + "@docusaurus/theme-common" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-common" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" cheerio "1.0.0-rc.12" feed "^4.2.2" fs-extra "^11.1.1" @@ -1574,20 +1667,20 @@ utility-types "^3.10.0" webpack "^5.88.1" -"@docusaurus/plugin-content-docs@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.8.0.tgz#6aedb1261da1f0c8c2fa11cfaa6df4577a9b7826" - integrity sha512-fRDMFLbUN6eVRXcjP8s3Y7HpAt9pzPYh1F/7KKXOCxvJhjjCtbon4VJW0WndEPInVz4t8QUXn5QZkU2tGVCE2g== +"@docusaurus/plugin-content-docs@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.9.2.tgz#cd8f2d1c06e53c3fa3d24bdfcb48d237bf2d6b2e" + integrity sha512-C5wZsGuKTY8jEYsqdxhhFOe1ZDjH0uIYJ9T/jebHwkyxqnr4wW0jTkB72OMqNjsoQRcb0JN3PcSeTwFlVgzCZg== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/logger" "3.8.0" - "@docusaurus/mdx-loader" "3.8.0" - "@docusaurus/module-type-aliases" "3.8.0" - "@docusaurus/theme-common" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-common" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/logger" "3.9.2" + "@docusaurus/mdx-loader" "3.9.2" + "@docusaurus/module-type-aliases" "3.9.2" + "@docusaurus/theme-common" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-common" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" "@types/react-router-config" "^5.0.7" combine-promises "^1.1.0" fs-extra "^11.1.1" @@ -1598,148 +1691,148 @@ utility-types "^3.10.0" webpack "^5.88.1" -"@docusaurus/plugin-content-pages@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.8.0.tgz#2db5f990872684c621665d0d0d8d9b5831fd2999" - integrity sha512-39EDx2y1GA0Pxfion5tQZLNJxL4gq6susd1xzetVBjVIQtwpCdyloOfQBAgX0FylqQxfJrYqL0DIUuq7rd7uBw== +"@docusaurus/plugin-content-pages@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.9.2.tgz#22db6c88ade91cec0a9e87a00b8089898051b08d" + integrity sha512-s4849w/p4noXUrGpPUF0BPqIAfdAe76BLaRGAGKZ1gTDNiGxGcpsLcwJ9OTi1/V8A+AzvsmI9pkjie2zjIQZKA== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/mdx-loader" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/mdx-loader" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" fs-extra "^11.1.1" tslib "^2.6.0" webpack "^5.88.1" -"@docusaurus/plugin-css-cascade-layers@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-css-cascade-layers/-/plugin-css-cascade-layers-3.8.0.tgz#a0741ae32917a88ce7ce76b6f472495fa4bf576d" - integrity sha512-/VBTNymPIxQB8oA3ZQ4GFFRYdH4ZxDRRBECxyjRyv486mfUPXfcdk+im4S5mKWa6EK2JzBz95IH/Wu0qQgJ5yQ== +"@docusaurus/plugin-css-cascade-layers@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-css-cascade-layers/-/plugin-css-cascade-layers-3.9.2.tgz#358c85f63f1c6a11f611f1b8889d9435c11b22f8" + integrity sha512-w1s3+Ss+eOQbscGM4cfIFBlVg/QKxyYgj26k5AnakuHkKxH6004ZtuLe5awMBotIYF2bbGDoDhpgQ4r/kcj4rQ== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" tslib "^2.6.0" -"@docusaurus/plugin-debug@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-debug/-/plugin-debug-3.8.0.tgz#297c159ae99924e60042426d2ad6ee0d5e9126b3" - integrity sha512-teonJvJsDB9o2OnG6ifbhblg/PXzZvpUKHFgD8dOL1UJ58u0lk8o0ZOkvaYEBa9nDgqzoWrRk9w+e3qaG2mOhQ== +"@docusaurus/plugin-debug@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-debug/-/plugin-debug-3.9.2.tgz#b5df4db115583f5404a252dbf66f379ff933e53c" + integrity sha512-j7a5hWuAFxyQAkilZwhsQ/b3T7FfHZ+0dub6j/GxKNFJp2h9qk/P1Bp7vrGASnvA9KNQBBL1ZXTe7jlh4VdPdA== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" fs-extra "^11.1.1" react-json-view-lite "^2.3.0" tslib "^2.6.0" -"@docusaurus/plugin-google-analytics@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.8.0.tgz#fb97097af331beb13553a384081dc83607539b31" - integrity sha512-aKKa7Q8+3xRSRESipNvlFgNp3FNPELKhuo48Cg/svQbGNwidSHbZT03JqbW4cBaQnyyVchO1ttk+kJ5VC9Gx0w== +"@docusaurus/plugin-google-analytics@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.9.2.tgz#857fe075fdeccdf6959e62954d9efe39769fa247" + integrity sha512-mAwwQJ1Us9jL/lVjXtErXto4p4/iaLlweC54yDUK1a97WfkC6Z2k5/769JsFgwOwOP+n5mUQGACXOEQ0XDuVUw== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" tslib "^2.6.0" -"@docusaurus/plugin-google-gtag@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.8.0.tgz#b5a60006c28ac582859a469fb92e53d383b0a055" - integrity sha512-ugQYMGF4BjbAW/JIBtVcp+9eZEgT9HRdvdcDudl5rywNPBA0lct+lXMG3r17s02rrhInMpjMahN3Yc9Cb3H5/g== +"@docusaurus/plugin-google-gtag@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.9.2.tgz#df75b1a90ae9266b0471909ba0265f46d5dcae62" + integrity sha512-YJ4lDCphabBtw19ooSlc1MnxtYGpjFV9rEdzjLsUnBCeis2djUyCozZaFhCg6NGEwOn7HDDyMh0yzcdRpnuIvA== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" "@types/gtag.js" "^0.0.12" tslib "^2.6.0" -"@docusaurus/plugin-google-tag-manager@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.8.0.tgz#612aa63e161fb273bf7db2591034c0142951727d" - integrity sha512-9juRWxbwZD3SV02Jd9QB6yeN7eu+7T4zB0bvJLcVQwi+am51wAxn2CwbdL0YCCX+9OfiXbADE8D8Q65Hbopu/w== +"@docusaurus/plugin-google-tag-manager@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.9.2.tgz#d1a3cf935acb7d31b84685e92d70a1d342946677" + integrity sha512-LJtIrkZN/tuHD8NqDAW1Tnw0ekOwRTfobWPsdO15YxcicBo2ykKF0/D6n0vVBfd3srwr9Z6rzrIWYrMzBGrvNw== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" tslib "^2.6.0" -"@docusaurus/plugin-sitemap@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.8.0.tgz#a39e3b5aa2f059aba0052ed11a6b4fbf78ac0dad" - integrity sha512-fGpOIyJvNiuAb90nSJ2Gfy/hUOaDu6826e5w5UxPmbpCIc7KlBHNAZ5g4L4ZuHhc4hdfq4mzVBsQSnne+8Ze1g== +"@docusaurus/plugin-sitemap@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.9.2.tgz#e1d9f7012942562cc0c6543d3cb2cdc4ae713dc4" + integrity sha512-WLh7ymgDXjG8oPoM/T4/zUP7KcSuFYRZAUTl8vR6VzYkfc18GBM4xLhcT+AKOwun6kBivYKUJf+vlqYJkm+RHw== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/logger" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-common" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/logger" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-common" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" fs-extra "^11.1.1" sitemap "^7.1.1" tslib "^2.6.0" -"@docusaurus/plugin-svgr@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-svgr/-/plugin-svgr-3.8.0.tgz#6d2d43f14b32b4bb2dd8dc87a70c6e78754c1e85" - integrity sha512-kEDyry+4OMz6BWLG/lEqrNsL/w818bywK70N1gytViw4m9iAmoxCUT7Ri9Dgs7xUdzCHJ3OujolEmD88Wy44OA== +"@docusaurus/plugin-svgr@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-svgr/-/plugin-svgr-3.9.2.tgz#62857ed79d97c0150d25f7e7380fdee65671163a" + integrity sha512-n+1DE+5b3Lnf27TgVU5jM1d4x5tUh2oW5LTsBxJX4PsAPV0JGcmI6p3yLYtEY0LRVEIJh+8RsdQmRE66wSV8mw== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" "@svgr/core" "8.1.0" "@svgr/webpack" "^8.1.0" tslib "^2.6.0" webpack "^5.88.1" -"@docusaurus/preset-classic@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/preset-classic/-/preset-classic-3.8.0.tgz#ac8bc17e3b7b443d8a24f2f1da0c0be396950fef" - integrity sha512-qOu6tQDOWv+rpTlKu+eJATCJVGnABpRCPuqf7LbEaQ1mNY//N/P8cHQwkpAU+aweQfarcZ0XfwCqRHJfjeSV/g== +"@docusaurus/preset-classic@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/preset-classic/-/preset-classic-3.9.2.tgz#85cc4f91baf177f8146c9ce896dfa1f0fd377050" + integrity sha512-IgyYO2Gvaigi21LuDIe+nvmN/dfGXAiMcV/murFqcpjnZc7jxFAxW+9LEjdPt61uZLxG4ByW/oUmX/DDK9t/8w== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/plugin-content-blog" "3.8.0" - "@docusaurus/plugin-content-docs" "3.8.0" - "@docusaurus/plugin-content-pages" "3.8.0" - "@docusaurus/plugin-css-cascade-layers" "3.8.0" - "@docusaurus/plugin-debug" "3.8.0" - "@docusaurus/plugin-google-analytics" "3.8.0" - "@docusaurus/plugin-google-gtag" "3.8.0" - "@docusaurus/plugin-google-tag-manager" "3.8.0" - "@docusaurus/plugin-sitemap" "3.8.0" - "@docusaurus/plugin-svgr" "3.8.0" - "@docusaurus/theme-classic" "3.8.0" - "@docusaurus/theme-common" "3.8.0" - "@docusaurus/theme-search-algolia" "3.8.0" - "@docusaurus/types" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/plugin-content-blog" "3.9.2" + "@docusaurus/plugin-content-docs" "3.9.2" + "@docusaurus/plugin-content-pages" "3.9.2" + "@docusaurus/plugin-css-cascade-layers" "3.9.2" + "@docusaurus/plugin-debug" "3.9.2" + "@docusaurus/plugin-google-analytics" "3.9.2" + "@docusaurus/plugin-google-gtag" "3.9.2" + "@docusaurus/plugin-google-tag-manager" "3.9.2" + "@docusaurus/plugin-sitemap" "3.9.2" + "@docusaurus/plugin-svgr" "3.9.2" + "@docusaurus/theme-classic" "3.9.2" + "@docusaurus/theme-common" "3.9.2" + "@docusaurus/theme-search-algolia" "3.9.2" + "@docusaurus/types" "3.9.2" -"@docusaurus/theme-classic@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-classic/-/theme-classic-3.8.0.tgz#6d44fb801b86a7c7af01cda0325af1a3300b3ac2" - integrity sha512-nQWFiD5ZjoT76OaELt2n33P3WVuuCz8Dt5KFRP2fCBo2r9JCLsp2GJjZpnaG24LZ5/arRjv4VqWKgpK0/YLt7g== +"@docusaurus/theme-classic@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-classic/-/theme-classic-3.9.2.tgz#6e514f99a0ff42b80afcf42d5e5d042618311ce0" + integrity sha512-IGUsArG5hhekXd7RDb11v94ycpJpFdJPkLnt10fFQWOVxAtq5/D7hT6lzc2fhyQKaaCE62qVajOMKL7OiAFAIA== dependencies: - "@docusaurus/core" "3.8.0" - "@docusaurus/logger" "3.8.0" - "@docusaurus/mdx-loader" "3.8.0" - "@docusaurus/module-type-aliases" "3.8.0" - "@docusaurus/plugin-content-blog" "3.8.0" - "@docusaurus/plugin-content-docs" "3.8.0" - "@docusaurus/plugin-content-pages" "3.8.0" - "@docusaurus/theme-common" "3.8.0" - "@docusaurus/theme-translations" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-common" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/logger" "3.9.2" + "@docusaurus/mdx-loader" "3.9.2" + "@docusaurus/module-type-aliases" "3.9.2" + "@docusaurus/plugin-content-blog" "3.9.2" + "@docusaurus/plugin-content-docs" "3.9.2" + "@docusaurus/plugin-content-pages" "3.9.2" + "@docusaurus/theme-common" "3.9.2" + "@docusaurus/theme-translations" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-common" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" "@mdx-js/react" "^3.0.0" clsx "^2.0.0" - copy-text-to-clipboard "^3.2.0" infima "0.2.0-alpha.45" lodash "^4.17.21" nprogress "^0.2.0" - postcss "^8.4.26" + postcss "^8.5.4" prism-react-renderer "^2.3.0" prismjs "^1.29.0" react-router-dom "^5.3.4" @@ -1747,15 +1840,15 @@ tslib "^2.6.0" utility-types "^3.10.0" -"@docusaurus/theme-common@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-common/-/theme-common-3.8.0.tgz#102c385c3d1d3b7a6b52d1911c7e88c38d9a977e" - integrity sha512-YqV2vAWpXGLA+A3PMLrOMtqgTHJLDcT+1Caa6RF7N4/IWgrevy5diY8oIHFkXR/eybjcrFFjUPrHif8gSGs3Tw== +"@docusaurus/theme-common@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-common/-/theme-common-3.9.2.tgz#487172c6fef9815c2746ef62a71e4f5b326f9ba5" + integrity sha512-6c4DAbR6n6nPbnZhY2V3tzpnKnGL+6aOsLvFL26VRqhlczli9eWG0VDUNoCQEPnGwDMhPS42UhSAnz5pThm5Ag== dependencies: - "@docusaurus/mdx-loader" "3.8.0" - "@docusaurus/module-type-aliases" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-common" "3.8.0" + "@docusaurus/mdx-loader" "3.9.2" + "@docusaurus/module-type-aliases" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-common" "3.9.2" "@types/history" "^4.7.11" "@types/react" "*" "@types/react-router-config" "*" @@ -1765,21 +1858,21 @@ tslib "^2.6.0" utility-types "^3.10.0" -"@docusaurus/theme-search-algolia@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.8.0.tgz#21c2f18e07a73d13ca3b44fcf0ae9aac33bef60f" - integrity sha512-GBZ5UOcPgiu6nUw153+0+PNWvFKweSnvKIL6Rp04H9olKb475jfKjAwCCtju5D2xs5qXHvCMvzWOg5o9f6DtuQ== +"@docusaurus/theme-search-algolia@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.9.2.tgz#420fd5b27fc1673b48151fdc9fe7167ba135ed50" + integrity sha512-GBDSFNwjnh5/LdkxCKQHkgO2pIMX1447BxYUBG2wBiajS21uj64a+gH/qlbQjDLxmGrbrllBrtJkUHxIsiwRnw== dependencies: - "@docsearch/react" "^3.9.0" - "@docusaurus/core" "3.8.0" - "@docusaurus/logger" "3.8.0" - "@docusaurus/plugin-content-docs" "3.8.0" - "@docusaurus/theme-common" "3.8.0" - "@docusaurus/theme-translations" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-validation" "3.8.0" - algoliasearch "^5.17.1" - algoliasearch-helper "^3.22.6" + "@docsearch/react" "^3.9.0 || ^4.1.0" + "@docusaurus/core" "3.9.2" + "@docusaurus/logger" "3.9.2" + "@docusaurus/plugin-content-docs" "3.9.2" + "@docusaurus/theme-common" "3.9.2" + "@docusaurus/theme-translations" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-validation" "3.9.2" + algoliasearch "^5.37.0" + algoliasearch-helper "^3.26.0" clsx "^2.0.0" eta "^2.2.0" fs-extra "^11.1.1" @@ -1787,21 +1880,22 @@ tslib "^2.6.0" utility-types "^3.10.0" -"@docusaurus/theme-translations@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-translations/-/theme-translations-3.8.0.tgz#deb64dccab74361624c3cb352a4949a7ac868c74" - integrity sha512-1DTy/snHicgkCkryWq54fZvsAglTdjTx4qjOXgqnXJ+DIty1B+aPQrAVUu8LiM+6BiILfmNxYsxhKTj+BS3PZg== +"@docusaurus/theme-translations@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-translations/-/theme-translations-3.9.2.tgz#238cd69c2da92d612be3d3b4f95944c1d0f1e041" + integrity sha512-vIryvpP18ON9T9rjgMRFLr2xJVDpw1rtagEGf8Ccce4CkTrvM/fRB8N2nyWYOW5u3DdjkwKw5fBa+3tbn9P4PA== dependencies: fs-extra "^11.1.1" tslib "^2.6.0" -"@docusaurus/types@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-3.8.0.tgz#f6cd31c4e3e392e0270b8137d7fe4365ea7a022e" - integrity sha512-RDEClpwNxZq02c+JlaKLWoS13qwWhjcNsi2wG1UpzmEnuti/z1Wx4SGpqbUqRPNSd8QWWePR8Cb7DvG0VN/TtA== +"@docusaurus/types@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-3.9.2.tgz#e482cf18faea0d1fa5ce0e3f1e28e0f32d2593eb" + integrity sha512-Ux1JUNswg+EfUEmajJjyhIohKceitY/yzjRUpu04WXgvVz+fbhVC0p+R0JhvEu4ytw8zIAys2hrdpQPBHRIa8Q== dependencies: "@mdx-js/mdx" "^3.0.0" "@types/history" "^4.7.11" + "@types/mdast" "^4.0.2" "@types/react" "*" commander "^5.1.0" joi "^17.9.2" @@ -1810,36 +1904,36 @@ webpack "^5.95.0" webpack-merge "^5.9.0" -"@docusaurus/utils-common@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/utils-common/-/utils-common-3.8.0.tgz#2b1a6b1ec4a7fac62f1898d523d42f8cc4a8258f" - integrity sha512-3TGF+wVTGgQ3pAc9+5jVchES4uXUAhAt9pwv7uws4mVOxL4alvU3ue/EZ+R4XuGk94pDy7CNXjRXpPjlfZXQfw== +"@docusaurus/utils-common@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/utils-common/-/utils-common-3.9.2.tgz#e89bfcf43d66359f43df45293fcdf22814847460" + integrity sha512-I53UC1QctruA6SWLvbjbhCpAw7+X7PePoe5pYcwTOEXD/PxeP8LnECAhTHHwWCblyUX5bMi4QLRkxvyZ+IT8Aw== dependencies: - "@docusaurus/types" "3.8.0" + "@docusaurus/types" "3.9.2" tslib "^2.6.0" -"@docusaurus/utils-validation@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/utils-validation/-/utils-validation-3.8.0.tgz#aa02e9d998e20998fbcaacd94873878bc3b9a4cd" - integrity sha512-MrnEbkigr54HkdFeg8e4FKc4EF+E9dlVwsY3XQZsNkbv3MKZnbHQ5LsNJDIKDROFe8PBf5C4qCAg5TPBpsjrjg== +"@docusaurus/utils-validation@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/utils-validation/-/utils-validation-3.9.2.tgz#04aec285604790806e2fc5aa90aa950dc7ba75ae" + integrity sha512-l7yk3X5VnNmATbwijJkexdhulNsQaNDwoagiwujXoxFbWLcxHQqNQ+c/IAlzrfMMOfa/8xSBZ7KEKDesE/2J7A== dependencies: - "@docusaurus/logger" "3.8.0" - "@docusaurus/utils" "3.8.0" - "@docusaurus/utils-common" "3.8.0" + "@docusaurus/logger" "3.9.2" + "@docusaurus/utils" "3.9.2" + "@docusaurus/utils-common" "3.9.2" fs-extra "^11.2.0" joi "^17.9.2" js-yaml "^4.1.0" lodash "^4.17.21" tslib "^2.6.0" -"@docusaurus/utils@3.8.0": - version "3.8.0" - resolved "https://registry.yarnpkg.com/@docusaurus/utils/-/utils-3.8.0.tgz#92bad89d2a11f5f246196af153093b12cd79f9ac" - integrity sha512-2wvtG28ALCN/A1WCSLxPASFBFzXCnP0YKCAFIPcvEb6imNu1wg7ni/Svcp71b3Z2FaOFFIv4Hq+j4gD7gA0yfQ== +"@docusaurus/utils@3.9.2": + version "3.9.2" + resolved "https://registry.yarnpkg.com/@docusaurus/utils/-/utils-3.9.2.tgz#ffab7922631c7e0febcb54e6d499f648bf8a89eb" + integrity sha512-lBSBiRruFurFKXr5Hbsl2thmGweAPmddhF3jb99U4EMDA5L+e5Y1rAkOS07Nvrup7HUMBDrCV45meaxZnt28nQ== dependencies: - "@docusaurus/logger" "3.8.0" - "@docusaurus/types" "3.8.0" - "@docusaurus/utils-common" "3.8.0" + "@docusaurus/logger" "3.9.2" + "@docusaurus/types" "3.9.2" + "@docusaurus/utils-common" "3.9.2" escape-string-regexp "^4.0.0" execa "5.1.1" file-loader "^6.2.0" @@ -1890,13 +1984,20 @@ "@types/yargs" "^17.0.8" chalk "^4.0.0" -"@jridgewell/gen-mapping@^0.3.5": - version "0.3.8" - resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.8.tgz#4f0e06362e01362f823d348f1872b08f666d8142" - integrity sha512-imAbBGkb+ebQyxKgzv5Hu2nmROxoDOXHh80evxdoXNOrvAnVx7zimzc1Oo5h9RlfV4vPXaE2iM5pOFbvOCClWA== +"@jridgewell/gen-mapping@^0.3.12", "@jridgewell/gen-mapping@^0.3.5": + version "0.3.13" + resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz#6342a19f44347518c93e43b1ac69deb3c4656a1f" + integrity sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA== dependencies: - "@jridgewell/set-array" "^1.2.1" - "@jridgewell/sourcemap-codec" "^1.4.10" + "@jridgewell/sourcemap-codec" "^1.5.0" + "@jridgewell/trace-mapping" "^0.3.24" + +"@jridgewell/remapping@^2.3.5": + version "2.3.5" + resolved "https://registry.yarnpkg.com/@jridgewell/remapping/-/remapping-2.3.5.tgz#375c476d1972947851ba1e15ae8f123047445aa1" + integrity sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ== + dependencies: + "@jridgewell/gen-mapping" "^0.3.5" "@jridgewell/trace-mapping" "^0.3.24" "@jridgewell/resolve-uri@^3.1.0": @@ -1904,46 +2005,87 @@ resolved "https://registry.yarnpkg.com/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz#7a0ee601f60f99a20c7c7c5ff0c80388c1189bd6" integrity sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw== -"@jridgewell/set-array@^1.2.1": - version "1.2.1" - resolved "https://registry.yarnpkg.com/@jridgewell/set-array/-/set-array-1.2.1.tgz#558fb6472ed16a4c850b889530e6b36438c49280" - integrity sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A== - "@jridgewell/source-map@^0.3.3": - version "0.3.6" - resolved "https://registry.yarnpkg.com/@jridgewell/source-map/-/source-map-0.3.6.tgz#9d71ca886e32502eb9362c9a74a46787c36df81a" - integrity sha512-1ZJTZebgqllO79ue2bm3rIGud/bOe0pP5BjSRCRxxYkEZS8STV7zN84UBbiYu7jy+eCKSnVIUgoWWE/tt+shMQ== + version "0.3.11" + resolved "https://registry.yarnpkg.com/@jridgewell/source-map/-/source-map-0.3.11.tgz#b21835cbd36db656b857c2ad02ebd413cc13a9ba" + integrity sha512-ZMp1V8ZFcPG5dIWnQLr3NSI1MiCU7UETdS/A0G8V/XWHvJv3ZsFqutJn1Y5RPmAPX6F3BiE397OqveU/9NCuIA== dependencies: "@jridgewell/gen-mapping" "^0.3.5" "@jridgewell/trace-mapping" "^0.3.25" -"@jridgewell/sourcemap-codec@^1.4.10", "@jridgewell/sourcemap-codec@^1.4.14": - version "1.5.0" - resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz#3188bcb273a414b0d215fd22a58540b989b9409a" - integrity sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ== +"@jridgewell/sourcemap-codec@^1.4.14", "@jridgewell/sourcemap-codec@^1.5.0": + version "1.5.5" + resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz#6912b00d2c631c0d15ce1a7ab57cd657f2a8f8ba" + integrity sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og== -"@jridgewell/trace-mapping@^0.3.18", "@jridgewell/trace-mapping@^0.3.24", "@jridgewell/trace-mapping@^0.3.25": - version "0.3.25" - resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.25.tgz#15f190e98895f3fc23276ee14bc76b675c2e50f0" - integrity sha512-vNk6aEwybGtawWmy/PzwnGDOjCkLWSD2wqvjGGAgOAwCGWySYXfYoxt00IJkTF+8Lb57DwOb3Aa0o9CApepiYQ== +"@jridgewell/trace-mapping@^0.3.18", "@jridgewell/trace-mapping@^0.3.24", "@jridgewell/trace-mapping@^0.3.25", "@jridgewell/trace-mapping@^0.3.28": + version "0.3.31" + resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz#db15d6781c931f3a251a3dac39501c98a6082fd0" + integrity sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw== dependencies: "@jridgewell/resolve-uri" "^3.1.0" "@jridgewell/sourcemap-codec" "^1.4.14" +"@jsonjoy.com/base64@^1.1.2": + version "1.1.2" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/base64/-/base64-1.1.2.tgz#cf8ea9dcb849b81c95f14fc0aaa151c6b54d2578" + integrity sha512-q6XAnWQDIMA3+FTiOYajoYqySkO+JSat0ytXGSuRdq9uXE7o92gzuQwQM14xaCRlBLGq3v5miDGC4vkVTn54xA== + +"@jsonjoy.com/buffers@^1.0.0", "@jsonjoy.com/buffers@^1.2.0": + version "1.2.1" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/buffers/-/buffers-1.2.1.tgz#8d99c7f67eaf724d3428dfd9826c6455266a5c83" + integrity sha512-12cdlDwX4RUM3QxmUbVJWqZ/mrK6dFQH4Zxq6+r1YXKXYBNgZXndx2qbCJwh3+WWkCSn67IjnlG3XYTvmvYtgA== + +"@jsonjoy.com/codegen@^1.0.0": + version "1.0.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/codegen/-/codegen-1.0.0.tgz#5c23f796c47675f166d23b948cdb889184b93207" + integrity sha512-E8Oy+08cmCf0EK/NMxpaJZmOxPqM+6iSe2S4nlSBrPZOORoDJILxtbSUEDKQyTamm/BVAhIGllOBNU79/dwf0g== + +"@jsonjoy.com/json-pack@^1.11.0": + version "1.21.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/json-pack/-/json-pack-1.21.0.tgz#93f8dd57fe3a3a92132b33d1eb182dcd9e7629fa" + integrity sha512-+AKG+R2cfZMShzrF2uQw34v3zbeDYUqnQ+jg7ORic3BGtfw9p/+N6RJbq/kkV8JmYZaINknaEQ2m0/f693ZPpg== + dependencies: + "@jsonjoy.com/base64" "^1.1.2" + "@jsonjoy.com/buffers" "^1.2.0" + "@jsonjoy.com/codegen" "^1.0.0" + "@jsonjoy.com/json-pointer" "^1.0.2" + "@jsonjoy.com/util" "^1.9.0" + hyperdyperid "^1.2.0" + thingies "^2.5.0" + tree-dump "^1.1.0" + +"@jsonjoy.com/json-pointer@^1.0.2": + version "1.0.2" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/json-pointer/-/json-pointer-1.0.2.tgz#049cb530ac24e84cba08590c5e36b431c4843408" + integrity sha512-Fsn6wM2zlDzY1U+v4Nc8bo3bVqgfNTGcn6dMgs6FjrEnt4ZCe60o6ByKRjOGlI2gow0aE/Q41QOigdTqkyK5fg== + dependencies: + "@jsonjoy.com/codegen" "^1.0.0" + "@jsonjoy.com/util" "^1.9.0" + +"@jsonjoy.com/util@^1.9.0": + version "1.9.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/util/-/util-1.9.0.tgz#7ee95586aed0a766b746cd8d8363e336c3c47c46" + integrity sha512-pLuQo+VPRnN8hfPqUTLTHk126wuYdXVxE6aDmjSeV4NCAgyxWbiOIeNJVtID3h1Vzpoi9m4jXezf73I6LgabgQ== + dependencies: + "@jsonjoy.com/buffers" "^1.0.0" + "@jsonjoy.com/codegen" "^1.0.0" + "@leichtgewicht/ip-codec@^2.0.1": version "2.0.5" resolved "https://registry.yarnpkg.com/@leichtgewicht/ip-codec/-/ip-codec-2.0.5.tgz#4fc56c15c580b9adb7dc3c333a134e540b44bfb1" integrity sha512-Vo+PSpZG2/fmgmiNzYK9qWRh8h/CHrwD0mo1h1DzL4yzHNSfWYujGTYsWGreD000gcgmZ7K4Ys6Tx9TxtsKdDw== "@mdx-js/mdx@^3.0.0": - version "3.1.0" - resolved "https://registry.yarnpkg.com/@mdx-js/mdx/-/mdx-3.1.0.tgz#10235cab8ad7d356c262e8c21c68df5850a97dc3" - integrity sha512-/QxEhPAvGwbQmy1Px8F899L5Uc2KZ6JtXwlCgJmjSTBedwOZkByYcBG4GceIGPXRDsmfxhHazuS+hlOShRLeDw== + version "3.1.1" + resolved "https://registry.yarnpkg.com/@mdx-js/mdx/-/mdx-3.1.1.tgz#c5ffd991a7536b149e17175eee57a1a2a511c6d1" + integrity sha512-f6ZO2ifpwAQIpzGWaBQT2TXxPv6z3RBzQKpVftEWN78Vl/YweF1uwussDx8ECAXVtr3Rs89fKyG9YlzUs9DyGQ== dependencies: "@types/estree" "^1.0.0" "@types/estree-jsx" "^1.0.0" "@types/hast" "^3.0.0" "@types/mdx" "^2.0.0" + acorn "^8.0.0" collapse-white-space "^2.0.0" devlop "^1.0.0" estree-util-is-identifier-name "^3.0.0" @@ -1966,9 +2108,9 @@ vfile "^6.0.0" "@mdx-js/react@^3.0.0": - version "3.1.0" - resolved "https://registry.yarnpkg.com/@mdx-js/react/-/react-3.1.0.tgz#c4522e335b3897b9a845db1dbdd2f966ae8fb0ed" - integrity sha512-QjHtSaoameoalGnKDT3FoIl4+9RwyTmo9ZJGBdLOks/YOiWHoRDI3PUwEzOE7kEmGcV3AFcp9K6dYu9rEuKLAQ== + version "3.1.1" + resolved "https://registry.yarnpkg.com/@mdx-js/react/-/react-3.1.1.tgz#24bda7fffceb2fe256f954482123cda1be5f5fef" + integrity sha512-f++rKLQgUVYDAtECQ6fn/is15GkEH9+nZPM3MS0RcxVqoTfawHvDlSCH7JbMhAM6uJ32v3eXLvLmLvjGu7PTQw== dependencies: "@types/mdx" "^2.0.0" @@ -1993,6 +2135,11 @@ "@nodelib/fs.scandir" "2.1.5" fastq "^1.6.0" +"@opentelemetry/api@1.9.0": + version "1.9.0" + resolved "https://registry.yarnpkg.com/@opentelemetry/api/-/api-1.9.0.tgz#d03eba68273dc0f7509e2a3d5cba21eae10379fe" + integrity sha512-3giAOQvZiH5F9bMlMiv8+GSPMeqg0dbaeo58/0SlA9sxSqZhnUtxzX9/2FzyhS9sWQf5S0GJE0AKBrFqjpeYcg== + "@pnpm/config.env-replace@^1.1.0": version "1.1.0" resolved "https://registry.yarnpkg.com/@pnpm/config.env-replace/-/config.env-replace-1.1.0.tgz#ab29da53df41e8948a00f2433f085f54de8b3a4c" @@ -2060,6 +2207,11 @@ micromark-util-character "^1.1.0" micromark-util-symbol "^1.0.1" +"@standard-schema/spec@^1.0.0": + version "1.0.0" + resolved "https://registry.yarnpkg.com/@standard-schema/spec/-/spec-1.0.0.tgz#f193b73dc316c4170f2e82a881da0f550d551b9c" + integrity sha512-m2bOd0f2RT9k8QJx1JN85cZYyH1RqFBdlwtkSlf4tBDYLCiiZnv1fIIwacK6cqwXavOydf0NPToMQgpKq+dVlA== + "@svgr/babel-plugin-add-jsx-attribute@8.0.0": version "8.0.0" resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-add-jsx-attribute/-/babel-plugin-add-jsx-attribute-8.0.0.tgz#4001f5d5dd87fa13303e36ee106e3ff3a7eb8b22" @@ -2179,21 +2331,21 @@ integrity sha512-L7z9BgrNEcYyUYtF+HaEfiS5ebkh9jXqbszz7pC0hRBPaatV0XjSD3+eHrpqFemQfgwiFF0QPIarnIihIDn7OA== "@types/body-parser@*": - version "1.19.5" - resolved "https://registry.yarnpkg.com/@types/body-parser/-/body-parser-1.19.5.tgz#04ce9a3b677dc8bd681a17da1ab9835dc9d3ede4" - integrity sha512-fB3Zu92ucau0iQ0JMCFQE7b/dv8Ot07NI3KaZIkIUNXq82k4eBAqUaneXfleGY9JWskeS9y+u0nXMyspcuQrCg== + version "1.19.6" + resolved "https://registry.yarnpkg.com/@types/body-parser/-/body-parser-1.19.6.tgz#1859bebb8fd7dac9918a45d54c1971ab8b5af474" + integrity sha512-HLFeCYgz89uk22N5Qg3dvGvsv46B8GLvKKo1zKG4NybA8U2DiEO3w9lqGg29t/tfLRJpJ6iQxnVw4OnB7MoM9g== dependencies: "@types/connect" "*" "@types/node" "*" -"@types/bonjour@^3.5.9": +"@types/bonjour@^3.5.13": version "3.5.13" resolved "https://registry.yarnpkg.com/@types/bonjour/-/bonjour-3.5.13.tgz#adf90ce1a105e81dd1f9c61fdc5afda1bfb92956" integrity sha512-z9fJ5Im06zvUL548KvYNecEVlA7cVDkGUi6kZusb04mpyEFKCIZJvloCcmpmLaIahDpOQGHaHmG6imtPMmPXGQ== dependencies: "@types/node" "*" -"@types/connect-history-api-fallback@^1.3.5": +"@types/connect-history-api-fallback@^1.5.4": version "1.5.4" resolved "https://registry.yarnpkg.com/@types/connect-history-api-fallback/-/connect-history-api-fallback-1.5.4.tgz#7de71645a103056b48ac3ce07b3520b819c1d5b3" integrity sha512-n6Cr2xS1h4uAulPRdlw6Jl6s1oG8KrVilPN2yUITEs+K48EzMJJ3W1xy8K5eWuFvjp3R74AOIGSmp2UfBJ8HFw== @@ -2238,25 +2390,25 @@ dependencies: "@types/estree" "*" -"@types/estree@*", "@types/estree@^1.0.0", "@types/estree@^1.0.6": - version "1.0.7" - resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.7.tgz#4158d3105276773d5b7695cd4834b1722e4f37a8" - integrity sha512-w28IoSUCJpidD/TGviZwwMJckNESJZXFu7NBZ5YJ4mEUnNraUn9Pm8HSZm/jDF1pDWYKspWE7oVphigUPRakIQ== +"@types/estree@*", "@types/estree@^1.0.0", "@types/estree@^1.0.8": + version "1.0.8" + resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.8.tgz#958b91c991b1867ced318bedea0e215ee050726e" + integrity sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w== "@types/express-serve-static-core@*", "@types/express-serve-static-core@^5.0.0": - version "5.0.6" - resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-5.0.6.tgz#41fec4ea20e9c7b22f024ab88a95c6bb288f51b8" - integrity sha512-3xhRnjJPkULekpSzgtoNYYcTWgEZkp4myc+Saevii5JPnHNvHMRlBSHDbs7Bh1iPPoVTERHEZXyhyLbMEsExsA== + version "5.1.0" + resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-5.1.0.tgz#74f47555b3d804b54cb7030e6f9aa0c7485cfc5b" + integrity sha512-jnHMsrd0Mwa9Cf4IdOzbz543y4XJepXrbia2T4b6+spXC2We3t1y6K44D3mR8XMFSXMCf3/l7rCgddfx7UNVBA== dependencies: "@types/node" "*" "@types/qs" "*" "@types/range-parser" "*" "@types/send" "*" -"@types/express-serve-static-core@^4.17.33": - version "4.19.6" - resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-4.19.6.tgz#e01324c2a024ff367d92c66f48553ced0ab50267" - integrity sha512-N4LZ2xG7DatVqhCZzOGb1Yi5lMbXSZcmdLDe9EzSndPV2HpWYWzRbaerl2n27irrm94EPpprqa8KpskPT085+A== +"@types/express-serve-static-core@^4.17.21", "@types/express-serve-static-core@^4.17.33": + version "4.19.7" + resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-4.19.7.tgz#f1d306dcc03b1aafbfb6b4fe684cce8a31cffc10" + integrity sha512-FvPtiIf1LfhzsaIXhv/PHan/2FeQBbtBDtfX2QfvPxdUelMDEckK08SM6nqo1MIZY3RUlfA+HV8+hFUSio78qg== dependencies: "@types/node" "*" "@types/qs" "*" @@ -2264,18 +2416,18 @@ "@types/send" "*" "@types/express@*": - version "5.0.2" - resolved "https://registry.yarnpkg.com/@types/express/-/express-5.0.2.tgz#7be9e337a5745d6b43ef5b0c352dad94a7f0c256" - integrity sha512-BtjL3ZwbCQriyb0DGw+Rt12qAXPiBTPs815lsUvtt1Grk0vLRMZNMUZ741d5rjk+UQOxfDiBZ3dxpX00vSkK3g== + version "5.0.3" + resolved "https://registry.yarnpkg.com/@types/express/-/express-5.0.3.tgz#6c4bc6acddc2e2a587142e1d8be0bce20757e956" + integrity sha512-wGA0NX93b19/dZC1J18tKWVIYWyyF2ZjT9vin/NRu0qzzvfVzWjs04iq2rQ3H65vCTQYlRqs3YHfY7zjdV+9Kw== dependencies: "@types/body-parser" "*" "@types/express-serve-static-core" "^5.0.0" "@types/serve-static" "*" -"@types/express@^4.17.13": - version "4.17.22" - resolved "https://registry.yarnpkg.com/@types/express/-/express-4.17.22.tgz#14cfcf120f7eb56ebb8ca77b7fa9a14d21de7c96" - integrity sha512-eZUmSnhRX9YRSkplpz0N+k6NljUUn5l3EWZIKZvYzhvMphEuNiyyy1viH/ejgt66JWgALwC/gtSUAeQKtSwW/w== +"@types/express@^4.17.21": + version "4.17.23" + resolved "https://registry.yarnpkg.com/@types/express/-/express-4.17.23.tgz#35af3193c640bfd4d7fe77191cd0ed411a433bef" + integrity sha512-Crp6WY9aTYP3qPi2wGDo9iUe/rceX01UMhnF1jmwDcKCFM6cx7YhGP/Mpr3y9AASpfHixIG0E6azCcL5OcDHsQ== dependencies: "@types/body-parser" "*" "@types/express-serve-static-core" "^4.17.33" @@ -2310,9 +2462,9 @@ integrity sha512-1m0bIFVc7eJWyve9S0RnuRgcQqF/Xd5QsUZAZeQFr1Q3/p9JWoQQEqmVy+DPTNpGXwhgIetAoYF8JSc33q29QA== "@types/http-errors@*": - version "2.0.4" - resolved "https://registry.yarnpkg.com/@types/http-errors/-/http-errors-2.0.4.tgz#7eb47726c391b7345a6ec35ad7f4de469cf5ba4f" - integrity sha512-D0CFMMtydbJAegzOyHjtiKPLlvnm3iTZyZRSZoLq2mRhDdmLfIWOCYPfQJ4cu2erKghU++QvjcUjp/5h7hESpA== + version "2.0.5" + resolved "https://registry.yarnpkg.com/@types/http-errors/-/http-errors-2.0.5.tgz#5b749ab2b16ba113423feb1a64a95dcd30398472" + integrity sha512-r8Tayk8HJnX0FztbZN7oVqGccWgw98T/0neJphO91KkmOzug1KkofZURD4UaD5uH8AqcFLfdPErnBod0u71/qg== "@types/http-proxy@^1.17.8": version "1.17.16" @@ -2368,18 +2520,18 @@ integrity sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA== "@types/node-forge@^1.3.0": - version "1.3.11" - resolved "https://registry.yarnpkg.com/@types/node-forge/-/node-forge-1.3.11.tgz#0972ea538ddb0f4d9c2fa0ec5db5724773a604da" - integrity sha512-FQx220y22OKNTqaByeBGqHWYz4cl94tpcxeFdvBo3wjG6XPBuZ0BNgNZRV5J5TFmmcsJ4IzsLkmGRiQbnYsBEQ== + version "1.3.14" + resolved "https://registry.yarnpkg.com/@types/node-forge/-/node-forge-1.3.14.tgz#006c2616ccd65550560c2757d8472eb6d3ecea0b" + integrity sha512-mhVF2BnD4BO+jtOp7z1CdzaK4mbuK0LLQYAvdOLqHTavxFNq4zA1EmYkpnFjP8HOUzedfQkRnp0E2ulSAYSzAw== dependencies: "@types/node" "*" "@types/node@*": - version "22.15.21" - resolved "https://registry.yarnpkg.com/@types/node/-/node-22.15.21.tgz#196ef14fe20d87f7caf1e7b39832767f9a995b77" - integrity sha512-EV/37Td6c+MgKAbkcLG6vqZ2zEYHD7bvSrzqqs2RIhbA6w3x+Dqz8MZM3sP6kGTeLrdoOgKZe+Xja7tUB2DNkQ== + version "24.8.1" + resolved "https://registry.yarnpkg.com/@types/node/-/node-24.8.1.tgz#74c8ae00b045a0a351f2837ec00f25dfed0053be" + integrity sha512-alv65KGRadQVfVcG69MuB4IzdYVpRwMG/mq8KWOaoOdyY617P5ivaDiMCGOFDWD2sAn5Q0mR3mRtUOgm99hL9Q== dependencies: - undici-types "~6.21.0" + undici-types "~7.14.0" "@types/node@^17.0.5": version "17.0.45" @@ -2428,16 +2580,16 @@ "@types/react" "*" "@types/react@*": - version "19.1.6" - resolved "https://registry.yarnpkg.com/@types/react/-/react-19.1.6.tgz#dee39f3e1e9a7d693f156a5840570b6d57f325ea" - integrity sha512-JeG0rEWak0N6Itr6QUx+X60uQmN+5t3j9r/OVDtWzFXKaj6kD1BwJzOksD0FF6iWxZlbE1kB0q9vtnU2ekqa1Q== + version "19.2.2" + resolved "https://registry.yarnpkg.com/@types/react/-/react-19.2.2.tgz#ba123a75d4c2a51158697160a4ea2ff70aa6bf36" + integrity sha512-6mDvHUFSjyT2B2yeNx2nUgMxh9LtOWvkhIU3uePn2I2oyNymUAX1NIsdgviM4CH+JSrp2D2hsMvJOkxY+0wNRA== dependencies: csstype "^3.0.2" -"@types/retry@0.12.0": - version "0.12.0" - resolved "https://registry.yarnpkg.com/@types/retry/-/retry-0.12.0.tgz#2b35eccfcee7d38cd72ad99232fbd58bffb3c84d" - integrity sha512-wWKOClTTiizcZhXnPY4wikVAwmdYHp8q6DmC+EJUzAMsycb7HB32Kh9RN4+0gExjmPmZSAQjgURXIGATPegAvA== +"@types/retry@0.12.2": + version "0.12.2" + resolved "https://registry.yarnpkg.com/@types/retry/-/retry-0.12.2.tgz#ed279a64fa438bb69f2480eda44937912bb7480a" + integrity sha512-XISRgDJ2Tc5q4TRqvgJtzsRkFYNJzZrhTdtMoGVBttwzzQJkPnS3WWTFc7kuDRoPtPakl+T+OfdEUjYJj7Jbow== "@types/sax@^1.2.1": version "1.2.7" @@ -2447,30 +2599,37 @@ "@types/node" "*" "@types/send@*": - version "0.17.4" - resolved "https://registry.yarnpkg.com/@types/send/-/send-0.17.4.tgz#6619cd24e7270793702e4e6a4b958a9010cfc57a" - integrity sha512-x2EM6TJOybec7c52BX0ZspPodMsQUd5L6PRwOunVyVUhXiBSKf3AezDL8Dgvgt5o0UfKNfuA0eMLr2wLT4AiBA== + version "1.2.0" + resolved "https://registry.yarnpkg.com/@types/send/-/send-1.2.0.tgz#ae9dfa0e3ab0306d3c566182324a54c4be2fb45a" + integrity sha512-zBF6vZJn1IaMpg3xUF25VK3gd3l8zwE0ZLRX7dsQyQi+jp4E8mMDJNGDYnYse+bQhYwWERTxVwHpi3dMOq7RKQ== + dependencies: + "@types/node" "*" + +"@types/send@<1": + version "0.17.5" + resolved "https://registry.yarnpkg.com/@types/send/-/send-0.17.5.tgz#d991d4f2b16f2b1ef497131f00a9114290791e74" + integrity sha512-z6F2D3cOStZvuk2SaP6YrwkNO65iTZcwA2ZkSABegdkAh/lf+Aa/YQndZVfmEXT5vgAp6zv06VQ3ejSVjAny4w== dependencies: "@types/mime" "^1" "@types/node" "*" -"@types/serve-index@^1.9.1": +"@types/serve-index@^1.9.4": version "1.9.4" resolved "https://registry.yarnpkg.com/@types/serve-index/-/serve-index-1.9.4.tgz#e6ae13d5053cb06ed36392110b4f9a49ac4ec898" integrity sha512-qLpGZ/c2fhSs5gnYsQxtDEq3Oy8SXPClIXkW5ghvAvsNuVSA8k+gCONcUCS/UjLEYvYps+e8uBtfgXgvhwfNug== dependencies: "@types/express" "*" -"@types/serve-static@*", "@types/serve-static@^1.13.10": - version "1.15.7" - resolved "https://registry.yarnpkg.com/@types/serve-static/-/serve-static-1.15.7.tgz#22174bbd74fb97fe303109738e9b5c2f3064f714" - integrity sha512-W8Ym+h8nhuRwaKPaDw34QUkwsGi6Rc4yYqvKFo5rm2FUEhCFbzVWrxXUxuKK8TASjWsysJY0nsmNCGhCOIsrOw== +"@types/serve-static@*", "@types/serve-static@^1.15.5": + version "1.15.9" + resolved "https://registry.yarnpkg.com/@types/serve-static/-/serve-static-1.15.9.tgz#f9b08ab7dd8bbb076f06f5f983b683654fe0a025" + integrity sha512-dOTIuqpWLyl3BBXU3maNQsS4A3zuuoYRNIvYSxxhebPfXg2mzWQEPne/nlJ37yOse6uGgR386uTpdsx4D0QZWA== dependencies: "@types/http-errors" "*" "@types/node" "*" - "@types/send" "*" + "@types/send" "<1" -"@types/sockjs@^0.3.33": +"@types/sockjs@^0.3.36": version "0.3.36" resolved "https://registry.yarnpkg.com/@types/sockjs/-/sockjs-0.3.36.tgz#ce322cf07bcc119d4cbf7f88954f3a3bd0f67535" integrity sha512-MK9V6NzAS1+Ud7JV9lJLFqW85VbC9dq3LmwZCuBe4wBDgKC0Kj/jd8Xl+nSviU+Qc3+m7umHHyHg//2KSa0a0Q== @@ -2487,7 +2646,7 @@ resolved "https://registry.yarnpkg.com/@types/unist/-/unist-2.0.11.tgz#11af57b127e32487774841f7a4e54eab166d03c4" integrity sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA== -"@types/ws@^8.5.5": +"@types/ws@^8.5.10": version "8.18.1" resolved "https://registry.yarnpkg.com/@types/ws/-/ws-8.18.1.tgz#48464e4bf2ddfd17db13d845467f6070ffea4aa9" integrity sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg== @@ -2511,6 +2670,11 @@ resolved "https://registry.yarnpkg.com/@ungap/structured-clone/-/structured-clone-1.3.0.tgz#d06bbb384ebcf6c505fde1c3d0ed4ddffe0aaff8" integrity sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g== +"@vercel/oidc@3.0.3": + version "3.0.3" + resolved "https://registry.yarnpkg.com/@vercel/oidc/-/oidc-3.0.3.tgz#82c2b6dd4d5c3b37dcb1189718cdeb9db402d052" + integrity sha512-yNEQvPcVrK9sIe637+I0jD6leluPxzwJKx/Haw6F4H77CdDsszUn5V3o96LPziXkSNE2B83+Z3mjqGKBK/R6Gg== + "@webassemblyjs/ast@1.14.1", "@webassemblyjs/ast@^1.14.1": version "1.14.1" resolved "https://registry.yarnpkg.com/@webassemblyjs/ast/-/ast-1.14.1.tgz#a9f6a07f2b03c95c8d38c4536a1fdfb521ff55b6" @@ -2650,6 +2814,11 @@ accepts@~1.3.4, accepts@~1.3.8: mime-types "~2.1.34" negotiator "0.6.3" +acorn-import-phases@^1.0.3: + version "1.0.4" + resolved "https://registry.yarnpkg.com/acorn-import-phases/-/acorn-import-phases-1.0.4.tgz#16eb850ba99a056cb7cbfe872ffb8972e18c8bd7" + integrity sha512-wKmbr/DDiIXzEOiWrTTUcDm24kQ2vGfZQvM2fwg2vXqR5uW6aapr7ObPtj1th32b9u90/Pf4AItvdTh42fBmVQ== + acorn-jsx@^5.0.0: version "5.3.2" resolved "https://registry.yarnpkg.com/acorn-jsx/-/acorn-jsx-5.3.2.tgz#7ed5bb55908b3b2f1bc55c6af1653bada7f07937" @@ -2662,10 +2831,10 @@ acorn-walk@^8.0.0: dependencies: acorn "^8.11.0" -acorn@^8.0.0, acorn@^8.0.4, acorn@^8.11.0, acorn@^8.14.0: - version "8.14.1" - resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.14.1.tgz#721d5dc10f7d5b5609a891773d47731796935dfb" - integrity sha512-OvQ/2pUDKmgfCg++xsTX1wGxfTaszcHVcTctW4UJB4hibJx2HXxxO5UmVgyjMa+ZDsiaf5wWLXYpRWMmBI0QHg== +acorn@^8.0.0, acorn@^8.0.4, acorn@^8.11.0, acorn@^8.15.0: + version "8.15.0" + resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.15.0.tgz#a360898bc415edaac46c8241f6383975b930b816" + integrity sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg== address@^1.0.1: version "1.2.2" @@ -2680,6 +2849,16 @@ aggregate-error@^3.0.0: clean-stack "^2.0.0" indent-string "^4.0.0" +ai@5.0.76, ai@^5.0.30: + version "5.0.76" + resolved "https://registry.yarnpkg.com/ai/-/ai-5.0.76.tgz#cb34925808ecf557120aaa7648026c4b2d232d5d" + integrity sha512-ZCxi1vrpyCUnDbtYrO/W8GLvyacV9689f00yshTIQ3mFFphbD7eIv40a2AOZBv3GGRA7SSRYIDnr56wcS/gyQg== + dependencies: + "@ai-sdk/gateway" "2.0.0" + "@ai-sdk/provider" "2.0.0" + "@ai-sdk/provider-utils" "3.0.12" + "@opentelemetry/api" "1.9.0" + ajv-formats@^2.1.1: version "2.1.1" resolved "https://registry.yarnpkg.com/ajv-formats/-/ajv-formats-2.1.1.tgz#6e669400659eb74973bbf2e33327180a0996b520" @@ -2719,31 +2898,32 @@ ajv@^8.0.0, ajv@^8.9.0: json-schema-traverse "^1.0.0" require-from-string "^2.0.2" -algoliasearch-helper@^3.22.6: - version "3.25.0" - resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.25.0.tgz#15cc79ad7909db66b8bb5a5a9c38b40e3941fa2f" - integrity sha512-vQoK43U6HXA9/euCqLjvyNdM4G2Fiu/VFp4ae0Gau9sZeIKBPvUPnXfLYAe65Bg7PFuw03coeu5K6lTPSXRObw== +algoliasearch-helper@^3.26.0: + version "3.26.0" + resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.26.0.tgz#d6e283396a9fc5bf944f365dc3b712570314363f" + integrity sha512-Rv2x3GXleQ3ygwhkhJubhhYGsICmShLAiqtUuJTUkr9uOCOXyF2E71LVT4XDnVffbknv8XgScP4U0Oxtgm+hIw== dependencies: "@algolia/events" "^4.0.1" -algoliasearch@^5.14.2, algoliasearch@^5.17.1: - version "5.25.0" - resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-5.25.0.tgz#7337b097deadeca0e6e985c0f8724abea189994f" - integrity sha512-n73BVorL4HIwKlfJKb4SEzAYkR3Buwfwbh+MYxg2mloFph2fFGV58E90QTzdbfzWrLn4HE5Czx/WTjI8fcHaMg== +algoliasearch@^5.28.0, algoliasearch@^5.37.0: + version "5.40.1" + resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-5.40.1.tgz#e46565cb473fa967a12191398e2ddfa2596bf82b" + integrity sha512-iUNxcXUNg9085TJx0HJLjqtDE0r1RZ0GOGrt8KNQqQT5ugu8lZsHuMUYW/e0lHhq6xBvmktU9Bw4CXP9VQeKrg== dependencies: - "@algolia/client-abtesting" "5.25.0" - "@algolia/client-analytics" "5.25.0" - "@algolia/client-common" "5.25.0" - "@algolia/client-insights" "5.25.0" - "@algolia/client-personalization" "5.25.0" - "@algolia/client-query-suggestions" "5.25.0" - "@algolia/client-search" "5.25.0" - "@algolia/ingestion" "1.25.0" - "@algolia/monitoring" "1.25.0" - "@algolia/recommend" "5.25.0" - "@algolia/requester-browser-xhr" "5.25.0" - "@algolia/requester-fetch" "5.25.0" - "@algolia/requester-node-http" "5.25.0" + "@algolia/abtesting" "1.6.1" + "@algolia/client-abtesting" "5.40.1" + "@algolia/client-analytics" "5.40.1" + "@algolia/client-common" "5.40.1" + "@algolia/client-insights" "5.40.1" + "@algolia/client-personalization" "5.40.1" + "@algolia/client-query-suggestions" "5.40.1" + "@algolia/client-search" "5.40.1" + "@algolia/ingestion" "1.40.1" + "@algolia/monitoring" "1.40.1" + "@algolia/recommend" "5.40.1" + "@algolia/requester-browser-xhr" "5.40.1" + "@algolia/requester-fetch" "5.40.1" + "@algolia/requester-node-http" "5.40.1" ansi-align@^3.0.1: version "3.0.1" @@ -2770,9 +2950,9 @@ ansi-regex@^5.0.1: integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== ansi-regex@^6.0.1: - version "6.1.0" - resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.1.0.tgz#95ec409c69619d6cb1b8b34f14b660ef28ebd654" - integrity sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA== + version "6.2.2" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.2.2.tgz#60216eea464d864597ce2832000738a0589650c1" + integrity sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg== ansi-styles@^4.0.0, ansi-styles@^4.1.0: version "4.3.0" @@ -2782,9 +2962,9 @@ ansi-styles@^4.0.0, ansi-styles@^4.1.0: color-convert "^2.0.1" ansi-styles@^6.1.0: - version "6.2.1" - resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-6.2.1.tgz#0e62320cf99c21afff3b3012192546aacbfb05c5" - integrity sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug== + version "6.2.3" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-6.2.3.tgz#c044d5dcc521a076413472597a1acb1f103c4041" + integrity sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg== anymatch@~3.1.2: version "3.1.3" @@ -2853,29 +3033,29 @@ babel-plugin-dynamic-import-node@^2.3.3: dependencies: object.assign "^4.1.0" -babel-plugin-polyfill-corejs2@^0.4.10: - version "0.4.13" - resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.13.tgz#7d445f0e0607ebc8fb6b01d7e8fb02069b91dd8b" - integrity sha512-3sX/eOms8kd3q2KZ6DAhKPc0dgm525Gqq5NtWKZ7QYYZEv57OQ54KtblzJzH1lQF/eQxO8KjWGIK9IPUJNus5g== +babel-plugin-polyfill-corejs2@^0.4.14: + version "0.4.14" + resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.14.tgz#8101b82b769c568835611542488d463395c2ef8f" + integrity sha512-Co2Y9wX854ts6U8gAAPXfn0GmAyctHuK8n0Yhfjd6t30g7yvKjspvvOo9yG+z52PZRgFErt7Ka2pYnXCjLKEpg== dependencies: - "@babel/compat-data" "^7.22.6" - "@babel/helper-define-polyfill-provider" "^0.6.4" + "@babel/compat-data" "^7.27.7" + "@babel/helper-define-polyfill-provider" "^0.6.5" semver "^6.3.1" -babel-plugin-polyfill-corejs3@^0.11.0: - version "0.11.1" - resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.11.1.tgz#4e4e182f1bb37c7ba62e2af81d8dd09df31344f6" - integrity sha512-yGCqvBT4rwMczo28xkH/noxJ6MZ4nJfkVYdoDaC/utLtWrXxv27HVrzAeSbqR8SxDsp46n0YF47EbHoixy6rXQ== +babel-plugin-polyfill-corejs3@^0.13.0: + version "0.13.0" + resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.13.0.tgz#bb7f6aeef7addff17f7602a08a6d19a128c30164" + integrity sha512-U+GNwMdSFgzVmfhNm8GJUX88AadB3uo9KpJqS3FaqNIPKgySuvMb+bHPsOmmuWyIcuqZj/pzt1RUIUZns4y2+A== dependencies: - "@babel/helper-define-polyfill-provider" "^0.6.3" - core-js-compat "^3.40.0" + "@babel/helper-define-polyfill-provider" "^0.6.5" + core-js-compat "^3.43.0" -babel-plugin-polyfill-regenerator@^0.6.1: - version "0.6.4" - resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.4.tgz#428c615d3c177292a22b4f93ed99e358d7906a9b" - integrity sha512-7gD3pRadPrbjhjLyxebmx/WrFYcuSjZ0XbdUujQMZ/fcE9oeewk2U/7PCvez84UeuK3oSjmPZ0Ch0dlupQvGzw== +babel-plugin-polyfill-regenerator@^0.6.5: + version "0.6.5" + resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.5.tgz#32752e38ab6f6767b92650347bf26a31b16ae8c5" + integrity sha512-ISqQ2frbiNU9vIJkzg7dlPpznPZ4jOiUQ1uSmB0fEHeowtN3COYRsXr/xexn64NpU13P06jc/L5TgiJXOgrbEg== dependencies: - "@babel/helper-define-polyfill-provider" "^0.6.4" + "@babel/helper-define-polyfill-provider" "^0.6.5" bail@^2.0.0: version "2.0.2" @@ -2887,6 +3067,11 @@ balanced-match@^1.0.0: resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== +baseline-browser-mapping@^2.8.9: + version "2.8.17" + resolved "https://registry.yarnpkg.com/baseline-browser-mapping/-/baseline-browser-mapping-2.8.17.tgz#85aff3f7dd6326ea25b77ce834b96bb698545dc6" + integrity sha512-j5zJcx6golJYTG6c05LUZ3Z8Gi+M62zRT/ycz4Xq4iCOdpcxwg7ngEYD4KA0eWZC7U17qh/Smq8bYbACJ0ipBA== + batch@0.6.1: version "0.6.1" resolved "https://registry.yarnpkg.com/batch/-/batch-0.6.1.tgz#dc34314f4e679318093fc760272525f94bf25c16" @@ -2920,7 +3105,7 @@ body-parser@1.20.3: type-is "~1.6.18" unpipe "1.0.0" -bonjour-service@^1.0.11: +bonjour-service@^1.2.1: version "1.3.0" resolved "https://registry.yarnpkg.com/bonjour-service/-/bonjour-service-1.3.0.tgz#80d867430b5a0da64e82a8047fc1e355bdb71722" integrity sha512-3YuAUiSkWykd+2Azjgyxei8OWf8thdn8AITIog2M4UICzoqfjlqr64WIjEXZllf/W6vK1goqleSR6brGomxQqA== @@ -2962,9 +3147,9 @@ boxen@^7.0.0: wrap-ansi "^8.1.0" brace-expansion@^1.1.7: - version "1.1.11" - resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.11.tgz#3c7fcbf529d87226f3d2f52b966ff5271eb441dd" - integrity sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA== + version "1.1.12" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.12.tgz#ab9b454466e5a8cc3a187beaad580412a9c5b843" + integrity sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg== dependencies: balanced-match "^1.0.0" concat-map "0.0.1" @@ -2976,14 +3161,15 @@ braces@^3.0.3, braces@~3.0.2: dependencies: fill-range "^7.1.1" -browserslist@^4.0.0, browserslist@^4.23.0, browserslist@^4.24.0, browserslist@^4.24.4: - version "4.24.5" - resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.24.5.tgz#aa0f5b8560fe81fde84c6dcb38f759bafba0e11b" - integrity sha512-FDToo4Wo82hIdgc1CQ+NQD0hEhmpPjrZ3hiUgwgOG6IuTdlpr8jdjyG24P6cNP1yJpTLzS5OcGgSw0xmDU1/Tw== +browserslist@^4.0.0, browserslist@^4.23.0, browserslist@^4.24.0, browserslist@^4.24.4, browserslist@^4.26.0, browserslist@^4.26.3: + version "4.26.3" + resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.26.3.tgz#40fbfe2d1cd420281ce5b1caa8840049c79afb56" + integrity sha512-lAUU+02RFBuCKQPj/P6NgjlbCnLBMp4UtgTx7vNHd3XSIJF87s9a5rA3aH2yw3GS9DqZAUbOtZdCCiZeVRqt0w== dependencies: - caniuse-lite "^1.0.30001716" - electron-to-chromium "^1.5.149" - node-releases "^2.0.19" + baseline-browser-mapping "^2.8.9" + caniuse-lite "^1.0.30001746" + electron-to-chromium "^1.5.227" + node-releases "^2.0.21" update-browserslist-db "^1.1.3" buffer-from@^1.0.0: @@ -2991,6 +3177,13 @@ buffer-from@^1.0.0: resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.1.2.tgz#2b146a6fd72e80b4f55d255f35ed59a3a9a41bd5" integrity sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ== +bundle-name@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/bundle-name/-/bundle-name-4.1.0.tgz#f3b96b34160d6431a19d7688135af7cfb8797889" + integrity sha512-tjwM5exMg6BGRI+kNmTntNsvdZS1X8BFYS6tnJ2hdH0kVxM6/eVZ2xy+FqStSWvYmtfFMDLIxurorHwDKfDz5Q== + dependencies: + run-applescript "^7.0.0" + bytes@3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/bytes/-/bytes-3.0.0.tgz#d32815404d689699f85a4ea4fa8755dd13a96048" @@ -3078,10 +3271,10 @@ caniuse-api@^3.0.0: lodash.memoize "^4.1.2" lodash.uniq "^4.5.0" -caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001702, caniuse-lite@^1.0.30001716: - version "1.0.30001718" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001718.tgz#dae13a9c80d517c30c6197515a96131c194d8f82" - integrity sha512-AflseV1ahcSunK53NfEs9gFWgOEmzr0f+kaMFA4xiLZlr9Hzt7HxcSpIFcnNCUkz6R6dWKa54rUz3HUmI3nVcw== +caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001702, caniuse-lite@^1.0.30001746: + version "1.0.30001751" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001751.tgz#dacd5d9f4baeea841641640139d2b2a4df4226ad" + integrity sha512-A0QJhug0Ly64Ii3eIqHu5X51ebln3k4yTUkY1j8drqpWHVreg/VLijN48cZ1bYPiqOQuqpkIKnzr/Ul8V+p6Cw== ccount@^2.0.0: version "2.0.1" @@ -3097,9 +3290,9 @@ chalk@^4.0.0, chalk@^4.1.2: supports-color "^7.1.0" chalk@^5.0.1, chalk@^5.2.0: - version "5.4.1" - resolved "https://registry.yarnpkg.com/chalk/-/chalk-5.4.1.tgz#1b48bf0963ec158dce2aacf69c093ae2dd2092d8" - integrity sha512-zgVZuo2WcZgfUEmsn6eO3kINexW8RAE4maiQ8QNs8CtpPCSyMiYsULR3HQYkm3w8FIA3SberyMJMSldGsW+U3w== + version "5.6.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-5.6.2.tgz#b1238b6e23ea337af71c7f8a295db5af0c158aea" + integrity sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA== char-regex@^1.0.2: version "1.0.2" @@ -3151,7 +3344,7 @@ cheerio@1.0.0-rc.12: parse5 "^7.0.0" parse5-htmlparser2-tree-adapter "^7.0.0" -chokidar@^3.5.3: +chokidar@^3.5.3, chokidar@^3.6.0: version "3.6.0" resolved "https://registry.yarnpkg.com/chokidar/-/chokidar-3.6.0.tgz#197c6cc669ef2a8dc5e7b4d97ee4e092c3eb0d5b" integrity sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw== @@ -3176,7 +3369,7 @@ ci-info@^3.2.0: resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-3.9.0.tgz#4279a62028a7b1f262f3473fc9605f5e218c59b4" integrity sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ== -clean-css@^5.2.2, clean-css@^5.3.2, clean-css@~5.3.2: +clean-css@^5.2.2, clean-css@^5.3.3, clean-css@~5.3.2: version "5.3.3" resolved "https://registry.yarnpkg.com/clean-css/-/clean-css-5.3.3.tgz#b330653cd3bd6b75009cc25c714cae7b93351ccd" integrity sha512-D5J+kHaVb/wKSFcyyV75uCn8fiY4sV38XJoe4CUyGQ+mOU/fMVYUdH1hJC+CJQ5uY3EnW27SbJYS4X8BiLrAFg== @@ -3291,15 +3484,15 @@ compressible@~2.0.18: mime-db ">= 1.43.0 < 2" compression@^1.7.4: - version "1.8.0" - resolved "https://registry.yarnpkg.com/compression/-/compression-1.8.0.tgz#09420efc96e11a0f44f3a558de59e321364180f7" - integrity sha512-k6WLKfunuqCYD3t6AsuPGvQWaKwuLLh2/xHNcX4qE+vIfDNXpSqnrhwA7O53R7WVQUnt8dVAIW+YHr7xTgOgGA== + version "1.8.1" + resolved "https://registry.yarnpkg.com/compression/-/compression-1.8.1.tgz#4a45d909ac16509195a9a28bd91094889c180d79" + integrity sha512-9mAqGPHLakhCLeNyxPkK4xVo746zQ/czLH1Ky+vkitMnWfWZps8r0qXuwhwizagCRttsL4lfG4pIOvaWLpAP0w== dependencies: bytes "3.1.2" compressible "~2.0.18" debug "2.6.9" negotiator "~0.6.4" - on-headers "~1.0.2" + on-headers "~1.1.0" safe-buffer "5.2.1" vary "~1.1.2" @@ -3369,11 +3562,6 @@ cookie@0.7.1: resolved "https://registry.yarnpkg.com/cookie/-/cookie-0.7.1.tgz#2f73c42142d5d5cf71310a74fc4ae61670e5dbc9" integrity sha512-6DnInpx7SJ2AK3+CTUE/ZM0vWTUboZCegxhC2xiIydHR9jNuTAASBrfEpHhiGOZw/nX51bHt6YQl8jsGo4y/0w== -copy-text-to-clipboard@^3.2.0: - version "3.2.0" - resolved "https://registry.yarnpkg.com/copy-text-to-clipboard/-/copy-text-to-clipboard-3.2.0.tgz#0202b2d9bdae30a49a53f898626dcc3b49ad960b" - integrity sha512-RnJFp1XR/LOBDckxTib5Qjr/PMfkatD0MUCQgdpqS8MdKiNUzBjAQBEN6oUy+jW7LI93BBG3DtMB2KOOKpGs2Q== - copy-webpack-plugin@^11.0.0: version "11.0.0" resolved "https://registry.yarnpkg.com/copy-webpack-plugin/-/copy-webpack-plugin-11.0.0.tgz#96d4dbdb5f73d02dd72d0528d1958721ab72e04a" @@ -3386,22 +3574,22 @@ copy-webpack-plugin@^11.0.0: schema-utils "^4.0.0" serialize-javascript "^6.0.0" -core-js-compat@^3.40.0: - version "3.42.0" - resolved "https://registry.yarnpkg.com/core-js-compat/-/core-js-compat-3.42.0.tgz#ce19c29706ee5806e26d3cb3c542d4cfc0ed51bb" - integrity sha512-bQasjMfyDGyaeWKBIu33lHh9qlSR0MFE/Nmc6nMjf/iU9b3rSMdAYz1Baxrv4lPdGUsTqZudHA4jIGSJy0SWZQ== +core-js-compat@^3.43.0: + version "3.46.0" + resolved "https://registry.yarnpkg.com/core-js-compat/-/core-js-compat-3.46.0.tgz#0c87126a19a1af00371e12b02a2b088a40f3c6f7" + integrity sha512-p9hObIIEENxSV8xIu+V68JjSeARg6UVMG5mR+JEUguG3sI6MsiS1njz2jHmyJDvA+8jX/sytkBHup6kxhM9law== dependencies: - browserslist "^4.24.4" + browserslist "^4.26.3" -core-js-pure@^3.30.2: - version "3.42.0" - resolved "https://registry.yarnpkg.com/core-js-pure/-/core-js-pure-3.42.0.tgz#e86c45a7f3bdcb608823e872f73d1ad9ddf0531d" - integrity sha512-007bM04u91fF4kMgwom2I5cQxAFIy8jVulgr9eozILl/SZE53QOqnW/+vviC+wQWLv+AunBG+8Q0TLoeSsSxRQ== +core-js-pure@^3.43.0: + version "3.46.0" + resolved "https://registry.yarnpkg.com/core-js-pure/-/core-js-pure-3.46.0.tgz#9bb80248584c6334bb54cd381b0f41c619ef1b43" + integrity sha512-NMCW30bHNofuhwLhYPt66OLOKTMbOhgTTatKVbaQC3KRHpTCiRIBYvtshr+NBYSnBxwAFhjW/RfJ0XbIjS16rw== core-js@^3.31.1: - version "3.42.0" - resolved "https://registry.yarnpkg.com/core-js/-/core-js-3.42.0.tgz#edbe91f78ac8cfb6df8d997e74d368a68082fe37" - integrity sha512-Sz4PP4ZA+Rq4II21qkNqOEDTDrCvcANId3xpIgB34NDkWc3UduWj2dqEtN9yZIq8Dk3HyPI33x9sqqU5C8sr0g== + version "3.46.0" + resolved "https://registry.yarnpkg.com/core-js/-/core-js-3.46.0.tgz#323a092b96381a9184d0cd49ee9083b2f93373bb" + integrity sha512-vDMm9B0xnqqZ8uSBpZ8sNtRtOdmfShrvT6h2TuQGLs0Is+cR0DYbj/KWP6ALVNbWPpqA/qPLoOuppJN07humpA== core-util-is@~1.0.0: version "1.0.3" @@ -3442,20 +3630,20 @@ css-blank-pseudo@^7.0.1: postcss-selector-parser "^7.0.0" css-declaration-sorter@^7.2.0: - version "7.2.0" - resolved "https://registry.yarnpkg.com/css-declaration-sorter/-/css-declaration-sorter-7.2.0.tgz#6dec1c9523bc4a643e088aab8f09e67a54961024" - integrity sha512-h70rUM+3PNFuaBDTLe8wF/cdWu+dOZmb7pJt8Z2sedYbAcQVQV/tEchueg3GWxwqS0cxtbxmaHEdkNACqcvsow== + version "7.3.0" + resolved "https://registry.yarnpkg.com/css-declaration-sorter/-/css-declaration-sorter-7.3.0.tgz#edc45c36bcdfea0788b1d4452829f142ef1c4a4a" + integrity sha512-LQF6N/3vkAMYF4xoHLJfG718HRJh34Z8BnNhd6bosOMIVjMlhuZK5++oZa3uYAgrI5+7x2o27gUqTR2U/KjUOQ== -css-has-pseudo@^7.0.2: - version "7.0.2" - resolved "https://registry.yarnpkg.com/css-has-pseudo/-/css-has-pseudo-7.0.2.tgz#fb42e8de7371f2896961e1f6308f13c2c7019b72" - integrity sha512-nzol/h+E0bId46Kn2dQH5VElaknX2Sr0hFuB/1EomdC7j+OISt2ZzK7EHX9DZDY53WbIVAR7FYKSO2XnSf07MQ== +css-has-pseudo@^7.0.3: + version "7.0.3" + resolved "https://registry.yarnpkg.com/css-has-pseudo/-/css-has-pseudo-7.0.3.tgz#a5ee2daf5f70a2032f3cefdf1e36e7f52a243873" + integrity sha512-oG+vKuGyqe/xvEMoxAQrhi7uY16deJR3i7wwhBerVrGQKSqUC5GiOVxTpM9F9B9hw0J+eKeOWLH7E9gZ1Dr5rA== dependencies: "@csstools/selector-specificity" "^5.0.0" postcss-selector-parser "^7.0.0" postcss-value-parser "^4.2.0" -css-loader@^6.8.1: +css-loader@^6.11.0: version "6.11.0" resolved "https://registry.yarnpkg.com/css-loader/-/css-loader-6.11.0.tgz#33bae3bf6363d0a7c2cf9031c96c744ff54d85ba" integrity sha512-CTJ+AEQJjq5NzLga5pE39qdiSV56F8ywCIsqNIRF0r7BDgWsN25aazToqAFg7ZrtA/U016xudB3ffgweORxX7g== @@ -3498,9 +3686,9 @@ css-select@^4.1.3: nth-check "^2.0.1" css-select@^5.1.0: - version "5.1.0" - resolved "https://registry.yarnpkg.com/css-select/-/css-select-5.1.0.tgz#b8ebd6554c3637ccc76688804ad3f6a6fdaea8a6" - integrity sha512-nwoRF1rvRRnnCqqY7updORDsuqKzqYJ28+oSMaJMMgOauh3fvwHqMS7EZpIPqK8GL+g9mKxF1vP/ZjSeNjEVHg== + version "5.2.2" + resolved "https://registry.yarnpkg.com/css-select/-/css-select-5.2.2.tgz#01b6e8d163637bb2dd6c982ca4ed65863682786e" + integrity sha512-TizTzUddG/xYLA3NXodFM0fSbNizXjOKhqiQQwvhlspadZokn1KDy0NZFS0wuEubIYAV5/c1/lAr0TaaFXEXzw== dependencies: boolbase "^1.0.0" css-what "^6.1.0" @@ -3525,14 +3713,14 @@ css-tree@~2.2.0: source-map-js "^1.0.1" css-what@^6.0.1, css-what@^6.1.0: - version "6.1.0" - resolved "https://registry.yarnpkg.com/css-what/-/css-what-6.1.0.tgz#fb5effcf76f1ddea2c81bdfaa4de44e79bac70f4" - integrity sha512-HTUrgRJ7r4dsZKU6GjmpfRK1O76h97Z8MfS1G0FozR+oF2kG6Vfe8JE6zwrkbxigziPHinCJ+gCPjA9EaBDtRw== + version "6.2.2" + resolved "https://registry.yarnpkg.com/css-what/-/css-what-6.2.2.tgz#cdcc8f9b6977719fdfbd1de7aec24abf756b9dea" + integrity sha512-u/O3vwbptzhMs3L1fQE82ZSLHQQfto5gyZzwteVIEyeaY5Fc7R4dapF/BvRoSYFeqfBk4m0V1Vafq5Pjv25wvA== -cssdb@^8.2.5: - version "8.3.0" - resolved "https://registry.yarnpkg.com/cssdb/-/cssdb-8.3.0.tgz#940becad497b8509ad822a28fb0cfe54c969ccfe" - integrity sha512-c7bmItIg38DgGjSwDPZOYF/2o0QU/sSgkWOMyl8votOfgFuyiFKWPesmCGEsrGLxEA9uL540cp8LdaGEjUGsZQ== +cssdb@^8.4.2: + version "8.4.2" + resolved "https://registry.yarnpkg.com/cssdb/-/cssdb-8.4.2.tgz#1a367ab1904c97af0bb2c7ae179764deae7b078b" + integrity sha512-PzjkRkRUS+IHDJohtxkIczlxPPZqRo0nXplsYXOMBRPjcVRjj1W4DfvRgshUYTVuUigU7ptVYkFJQ7abUB0nyg== cssesc@^3.0.0: version "3.0.0" @@ -3625,17 +3813,17 @@ debug@2.6.9: dependencies: ms "2.0.0" -debug@4, debug@^4.0.0, debug@^4.1.0, debug@^4.1.1, debug@^4.3.1: - version "4.4.1" - resolved "https://registry.yarnpkg.com/debug/-/debug-4.4.1.tgz#e5a8bc6cbc4c6cd3e64308b0693a3d4fa550189b" - integrity sha512-KcKCqiftBJcZr++7ykoDIEwSa3XWowTfNPo92BYxjXiyYEVrUQh2aLyhxBCwww+heortUFxEJYcRzosstTEBYQ== +debug@4, debug@^4.0.0, debug@^4.1.0, debug@^4.3.1, debug@^4.4.1: + version "4.4.3" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.4.3.tgz#c6ae432d9bd9662582fce08709b038c58e9e3d6a" + integrity sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA== dependencies: ms "^2.1.3" decode-named-character-reference@^1.0.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/decode-named-character-reference/-/decode-named-character-reference-1.1.0.tgz#5d6ce68792808901210dac42a8e9853511e2b8bf" - integrity sha512-Wy+JTSbFThEOXQIR2L6mxJvEs+veIzpmqD7ynWxMXGpnk3smkHQOp6forLdHsKpAMW9iJpaBBIxz285t1n1C3w== + version "1.2.0" + resolved "https://registry.yarnpkg.com/decode-named-character-reference/-/decode-named-character-reference-1.2.0.tgz#25c32ae6dd5e21889549d40f676030e9514cc0ed" + integrity sha512-c6fcElNV6ShtZXmsgNgFFV5tVX2PaV4g+MOAkb8eXHvn6sryJBrZa9r0zV6+dtTyoCKxtDy5tyQ5ZwQuidtd+Q== dependencies: character-entities "^2.0.0" @@ -3656,12 +3844,18 @@ deepmerge@^4.3.1: resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-4.3.1.tgz#44b5f2147cd3b00d4b56137685966f26fd25dd4a" integrity sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A== -default-gateway@^6.0.3: - version "6.0.3" - resolved "https://registry.yarnpkg.com/default-gateway/-/default-gateway-6.0.3.tgz#819494c888053bdb743edbf343d6cdf7f2943a71" - integrity sha512-fwSOJsbbNzZ/CUFpqFBqYfYNLj1NbMPm8MMCIzHjC83iSJRBEGmDUxU+WP661BaBQImeC2yHwXtz+P/O9o+XEg== +default-browser-id@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/default-browser-id/-/default-browser-id-5.0.0.tgz#a1d98bf960c15082d8a3fa69e83150ccccc3af26" + integrity sha512-A6p/pu/6fyBcA1TRz/GqWYPViplrftcW2gZC9q79ngNCKAeR/X3gcEdXQHl4KNXV+3wgIJ1CPkJQ3IHM6lcsyA== + +default-browser@^5.2.1: + version "5.2.1" + resolved "https://registry.yarnpkg.com/default-browser/-/default-browser-5.2.1.tgz#7b7ba61204ff3e425b556869ae6d3e9d9f1712cf" + integrity sha512-WY/3TUME0x3KPYdRRxEJJvXRHV4PyPoUsxtZa78lwItwRQRHhd2U9xOscaT/YTf8uCXIAjeJOFBVEh/7FtD8Xg== dependencies: - execa "^5.0.0" + bundle-name "^4.1.0" + default-browser-id "^5.0.0" defer-to-connect@^2.0.1: version "2.0.1" @@ -3682,6 +3876,11 @@ define-lazy-prop@^2.0.0: resolved "https://registry.yarnpkg.com/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz#3f7ae421129bcaaac9bc74905c98a0009ec9ee7f" integrity sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og== +define-lazy-prop@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/define-lazy-prop/-/define-lazy-prop-3.0.0.tgz#dbb19adfb746d7fc6d734a06b72f4a00d021255f" + integrity sha512-N+MeXYoqr3pOgn8xfyRPREN7gHakLYjhsHhWGT3fWAiL4IkAt0iDw14QiiEm2bE30c5XX5q0FtAA3CK5f9/BUg== + define-properties@^1.2.1: version "1.2.1" resolved "https://registry.yarnpkg.com/define-properties/-/define-properties-1.2.1.tgz#10781cc616eb951a80a034bafcaa7377f6af2b6c" @@ -3701,7 +3900,7 @@ depd@~1.1.2: resolved "https://registry.yarnpkg.com/depd/-/depd-1.1.2.tgz#9bcd52e14c097763e749b274c4346ed2e560b5a9" integrity sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ== -dequal@^2.0.0: +dequal@^2.0.0, dequal@^2.0.3: version "2.0.3" resolved "https://registry.yarnpkg.com/dequal/-/dequal-2.0.3.tgz#2644214f1997d39ed0ee0ece72335490a7ac67be" integrity sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA== @@ -3846,10 +4045,10 @@ ee-first@1.1.1: resolved "https://registry.yarnpkg.com/ee-first/-/ee-first-1.1.1.tgz#590c61156b0ae2f4f0255732a158b266bc56b21d" integrity sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow== -electron-to-chromium@^1.5.149: - version "1.5.158" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.158.tgz#e5f01fc7fdf810d9d223e30593e0839c306276d4" - integrity sha512-9vcp2xHhkvraY6AHw2WMi+GDSLPX42qe2xjYaVoZqFRJiOcilVQFq9mZmpuHEQpzlgGDelKlV7ZiGcmMsc8WxQ== +electron-to-chromium@^1.5.227: + version "1.5.237" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.237.tgz#eacf61cef3f6345d0069ab427585c5a04d7084f0" + integrity sha512-icUt1NvfhGLar5lSWH3tHNzablaA5js3HVHacQimfP8ViEBOQv+L7DKEuHdbTZ0SKCO1ogTJTIL1Gwk9S6Qvcg== emoji-regex@^8.0.0: version "8.0.0" @@ -3886,10 +4085,10 @@ encodeurl@~2.0.0: resolved "https://registry.yarnpkg.com/encodeurl/-/encodeurl-2.0.0.tgz#7b8ea898077d7e409d3ac45474ea38eaf0857a58" integrity sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg== -enhanced-resolve@^5.17.1: - version "5.18.1" - resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.18.1.tgz#728ab082f8b7b6836de51f1637aab5d3b9568faf" - integrity sha512-ZSW3ma5GkcQBIpwZTSRAI8N71Uuwgs93IezB7mf7R60tC8ZbJideoDNKjHn2O9KIlx6rkGTTEk1xUCK2E1Y2Yg== +enhanced-resolve@^5.17.3: + version "5.18.3" + resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.18.3.tgz#9b5f4c5c076b8787c78fe540392ce76a88855b44" + integrity sha512-d4lC8xfavMeBjzGr2vECC3fsGXziXZQyJxD868h2M/mBI3PwAuODxAkLkq5HYuvrPYcUtiLzsTo8U3PgX3Ocww== dependencies: graceful-fs "^4.2.4" tapable "^2.2.0" @@ -3905,14 +4104,14 @@ entities@^4.2.0, entities@^4.4.0: integrity sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw== entities@^6.0.0: - version "6.0.0" - resolved "https://registry.yarnpkg.com/entities/-/entities-6.0.0.tgz#09c9e29cb79b0a6459a9b9db9efb418ac5bb8e51" - integrity sha512-aKstq2TDOndCn4diEyp9Uq/Flu2i1GlLkc6XIDQSDMuaFE3OPW5OphLCyQ5SpSJZTb4reN+kTcYru5yIfXoRPw== + version "6.0.1" + resolved "https://registry.yarnpkg.com/entities/-/entities-6.0.1.tgz#c28c34a43379ca7f61d074130b2f5f7020a30694" + integrity sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g== error-ex@^1.3.1: - version "1.3.2" - resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.2.tgz#b4ac40648107fdcdcfae242f428bea8a14d4f1bf" - integrity sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g== + version "1.3.4" + resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.4.tgz#b3a8d8bb6f92eecc1629e3e27d3c8607a8a32414" + integrity sha512-sqQamAnR14VgCr1A618A3sGrygcpK+HEbenA/HiEAkkUwcZIIB/tgWqHFxWgOyDh4nB4JCRimh79dR5Ywc9MDQ== dependencies: is-arrayish "^0.2.1" @@ -4112,7 +4311,12 @@ events@^3.2.0: resolved "https://registry.yarnpkg.com/events/-/events-3.3.0.tgz#31a95ad0a924e2d2c419a813aeb2c4e878ea7400" integrity sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q== -execa@5.1.1, execa@^5.0.0: +eventsource-parser@^3.0.5: + version "3.0.6" + resolved "https://registry.yarnpkg.com/eventsource-parser/-/eventsource-parser-3.0.6.tgz#292e165e34cacbc936c3c92719ef326d4aeb4e90" + integrity sha512-Vo1ab+QXPzZ4tCa8SwIHJFaSzy4R6SHf7BY79rFBDf0idraZWAkYrDjDj8uWaSm3S2TK+hJ7/t1CEmZ7jXw+pg== + +execa@5.1.1: version "5.1.1" resolved "https://registry.yarnpkg.com/execa/-/execa-5.1.1.tgz#f80ad9cbf4298f7bd1d4c9555c21e93741c411dd" integrity sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg== @@ -4127,7 +4331,7 @@ execa@5.1.1, execa@^5.0.0: signal-exit "^3.0.3" strip-final-newline "^2.0.0" -express@^4.17.3: +express@^4.21.2: version "4.21.2" resolved "https://registry.yarnpkg.com/express/-/express-4.21.2.tgz#cf250e48362174ead6cea4a566abef0162c1ec32" integrity sha512-28HqgMZAmih1Czt9ny7qr6ek2qddF4FclbMzwhCREB6OFfH+rXAnuNCwo1/wFvrtbgsQDb4kSbX9de9lFbrXnA== @@ -4198,9 +4402,9 @@ fast-json-stable-stringify@^2.0.0: integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== fast-uri@^3.0.1: - version "3.0.6" - resolved "https://registry.yarnpkg.com/fast-uri/-/fast-uri-3.0.6.tgz#88f130b77cfaea2378d56bf970dea21257a68748" - integrity sha512-Atfo14OibSv5wAp4VWNsFYE1AchQRTv9cBGWET4pZWHzYshFSS9NQI6I57rdKn9croWVMbYFbLhJ+yJvmZIIHw== + version "3.1.0" + resolved "https://registry.yarnpkg.com/fast-uri/-/fast-uri-3.1.0.tgz#66eecff6c764c0df9b762e62ca7edcfb53b4edfa" + integrity sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA== fastq@^1.6.0: version "1.19.1" @@ -4287,9 +4491,9 @@ flat@^5.0.2: integrity sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ== follow-redirects@^1.0.0: - version "1.15.9" - resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.9.tgz#a604fa10e443bf98ca94228d9eebcc2e8a2c8ee1" - integrity sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ== + version "1.15.11" + resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.11.tgz#777d73d72a92f8ec4d2e410eb47352a56b8e8340" + integrity sha512-deG2P0JfjrTxl50XGCDyfI97ZGVCxIpfKYmfyrQ54n5FO/0gfIES8C/Psl6kWVDolizcaaxZJnTS0QSMxvnsBQ== form-data-encoder@^2.1.2: version "2.1.4" @@ -4317,24 +4521,14 @@ fresh@0.5.2: integrity sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q== fs-extra@^11.1.1, fs-extra@^11.2.0: - version "11.3.0" - resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-11.3.0.tgz#0daced136bbaf65a555a326719af931adc7a314d" - integrity sha512-Z4XaCL6dUDHfP/jT25jJKMmtxvuwbkrD1vNSMFlo9lNLY2c5FHYSQgHPRZUjAB26TpDEoW9HCOgplrdbaPV/ew== + version "11.3.2" + resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-11.3.2.tgz#c838aeddc6f4a8c74dd15f85e11fe5511bfe02a4" + integrity sha512-Xr9F6z6up6Ws+NjzMCZc6WXg2YFRlrLP9NQDO3VQrWrfiojdhS56TzueT88ze0uBdCTwEIhQ3ptnmKeWGFAe0A== dependencies: graceful-fs "^4.2.0" jsonfile "^6.0.1" universalify "^2.0.0" -fs-monkey@^1.0.4: - version "1.0.6" - resolved "https://registry.yarnpkg.com/fs-monkey/-/fs-monkey-1.0.6.tgz#8ead082953e88d992cf3ff844faa907b26756da2" - integrity sha512-b1FMfwetIKymC0eioW7mTywihSQE4oLzQn1dB6rZB5fx/3NpNEdAWeCSMB+60/AeT0TCXsxzAlcYVEFCTAksWg== - -fs.realpath@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" - integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw== - fsevents@~2.3.2: version "2.3.3" resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.3.tgz#cac6407785d03675a2a5e1a5305c697b347d90d6" @@ -4403,23 +4597,16 @@ glob-parent@^6.0.1: dependencies: is-glob "^4.0.3" +glob-to-regex.js@^1.0.1: + version "1.2.0" + resolved "https://registry.yarnpkg.com/glob-to-regex.js/-/glob-to-regex.js-1.2.0.tgz#2b323728271d133830850e32311f40766c5f6413" + integrity sha512-QMwlOQKU/IzqMUOAZWubUOT8Qft+Y0KQWnX9nK3ch0CJg0tTp4TvGZsTfudYKv2NzoQSyPcnA6TYeIQ3jGichQ== + glob-to-regexp@^0.4.1: version "0.4.1" resolved "https://registry.yarnpkg.com/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz#c75297087c851b9a578bd217dd59a92f59fe546e" integrity sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw== -glob@^7.1.3: - version "7.2.3" - resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.3.tgz#b8df0fb802bbfa8e89bd1d938b4e16578ed44f2b" - integrity sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q== - dependencies: - fs.realpath "^1.0.0" - inflight "^1.0.4" - inherits "2" - minimatch "^3.1.1" - once "^1.3.0" - path-is-absolute "^1.0.0" - global-dirs@^3.0.0: version "3.0.1" resolved "https://registry.yarnpkg.com/global-dirs/-/global-dirs-3.0.1.tgz#0c488971f066baceda21447aecb1a8b911d22485" @@ -4427,11 +4614,6 @@ global-dirs@^3.0.0: dependencies: ini "2.0.0" -globals@^11.1.0: - version "11.12.0" - resolved "https://registry.yarnpkg.com/globals/-/globals-11.12.0.tgz#ab8795338868a0babd8525758018c2a7eb95c42e" - integrity sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA== - globby@^11.1.0: version "11.1.0" resolved "https://registry.yarnpkg.com/globby/-/globby-11.1.0.tgz#bd4be98bb042f83d796f7e3811991fbe82a0d34b" @@ -4686,11 +4868,6 @@ hpack.js@^2.1.6: readable-stream "^2.0.1" wbuf "^1.1.0" -html-entities@^2.3.2: - version "2.6.0" - resolved "https://registry.yarnpkg.com/html-entities/-/html-entities-2.6.0.tgz#7c64f1ea3b36818ccae3d3fb48b6974208e984f8" - integrity sha512-kig+rMn/QOVRvr7c86gQ8lWXq+Hkv6CbAH1hLu+RG338StTpE8Z0b44SDVaqVu7HGKf27frdmUYEs9hTUX/cLQ== - html-escaper@^2.0.2: version "2.0.2" resolved "https://registry.yarnpkg.com/html-escaper/-/html-escaper-2.0.2.tgz#dfd60027da36a36dfcbe236262c00a5822681453" @@ -4733,9 +4910,9 @@ html-void-elements@^3.0.0: integrity sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg== html-webpack-plugin@^5.6.0: - version "5.6.3" - resolved "https://registry.yarnpkg.com/html-webpack-plugin/-/html-webpack-plugin-5.6.3.tgz#a31145f0fee4184d53a794f9513147df1e653685" - integrity sha512-QSf1yjtSAsmf7rYBV7XX86uua4W/vkhIt0xNXKbsi2foEeW7vjJQz4bhnpL3xH+l1ryl1680uNv968Z+X6jSYg== + version "5.6.4" + resolved "https://registry.yarnpkg.com/html-webpack-plugin/-/html-webpack-plugin-5.6.4.tgz#d8cb0f7edff7745ae7d6cccb0bff592e9f7f7959" + integrity sha512-V/PZeWsqhfpE27nKeX9EO2sbR+D17A+tLf6qU+ht66jdUsN0QLKJN27Z+1+gHrVMKgndBahes0PU6rRihDgHTw== dependencies: "@types/html-minifier-terser" "^6.0.0" html-minifier-terser "^6.0.2" @@ -4799,7 +4976,7 @@ http-parser-js@>=0.5.1: resolved "https://registry.yarnpkg.com/http-parser-js/-/http-parser-js-0.5.10.tgz#b3277bd6d7ed5588e20ea73bf724fcbe44609075" integrity sha512-Pysuw9XpUq5dVc/2SMHpuTY01RFl8fttgcyunjL7eEMhGM3cI4eOmiCycJDVCo/7O7ClfQD3SaI6ftDzqOXYMA== -http-proxy-middleware@^2.0.3: +http-proxy-middleware@^2.0.9: version "2.0.9" resolved "https://registry.yarnpkg.com/http-proxy-middleware/-/http-proxy-middleware-2.0.9.tgz#e9e63d68afaa4eee3d147f39149ab84c0c2815ef" integrity sha512-c1IyJYLYppU574+YI7R4QyX2ystMtVXZwIdzazUIPIJsHuWNd+mho2j+bKoHftndicGj9yh+xjd+l0yj7VeT1Q== @@ -4832,6 +5009,11 @@ human-signals@^2.1.0: resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0" integrity sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw== +hyperdyperid@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/hyperdyperid/-/hyperdyperid-1.2.0.tgz#59668d323ada92228d2a869d3e474d5a33b69e6b" + integrity sha512-Y93lCzHYgGWdrJ66yIktxiaGULYc6oGiABxhcO5AufBeOyoIdZF7bIfLaOrbM0iGIOXQQgxxRrFEnb+Y6w1n4A== + iconv-lite@0.4.24: version "0.4.24" resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b" @@ -4882,24 +5064,16 @@ infima@0.2.0-alpha.45: resolved "https://registry.yarnpkg.com/infima/-/infima-0.2.0-alpha.45.tgz#542aab5a249274d81679631b492973dd2c1e7466" integrity sha512-uyH0zfr1erU1OohLk0fT4Rrb94AOhguWNOcD9uGrSpRvNB+6gZXUoJX5J0NtvzBO10YZ9PgvA4NFgt+fYg8ojw== -inflight@^1.0.4: - version "1.0.6" - resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" - integrity sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA== - dependencies: - once "^1.3.0" - wrappy "1" - -inherits@2, inherits@2.0.4, inherits@^2.0.1, inherits@^2.0.3, inherits@~2.0.3: - version "2.0.4" - resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" - integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== - inherits@2.0.3: version "2.0.3" resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.3.tgz#633c2c83e3da42a502f52466022480f4208261de" integrity sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw== +inherits@2.0.4, inherits@^2.0.1, inherits@^2.0.3, inherits@~2.0.3: + version "2.0.4" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" + integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== + ini@2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/ini/-/ini-2.0.0.tgz#e5fd556ecdd5726be978fa1001862eacb0a94bc5" @@ -4927,7 +5101,7 @@ ipaddr.js@1.9.1: resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-1.9.1.tgz#bff38543eeb8984825079ff3a2a8e6cbd46781b3" integrity sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g== -ipaddr.js@^2.0.1: +ipaddr.js@^2.1.0: version "2.2.0" resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-2.2.0.tgz#d33fa7bac284f4de7af949638c9d68157c6b92e8" integrity sha512-Ag3wB2o37wslZS19hZqorUnrnzSkpOVy+IiiDEiTqNubEYpYuHWIf6K4psgN2ZWKExS4xhVCrRVfb/wfW8fWJA== @@ -4981,6 +5155,11 @@ is-docker@^2.0.0, is-docker@^2.1.1: resolved "https://registry.yarnpkg.com/is-docker/-/is-docker-2.2.1.tgz#33eeabe23cfe86f14bde4408a02c0cfb853acdaa" integrity sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ== +is-docker@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-docker/-/is-docker-3.0.0.tgz#90093aa3106277d8a77a5910dbae71747e15a200" + integrity sha512-eljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ== + is-extendable@^0.1.0: version "0.1.1" resolved "https://registry.yarnpkg.com/is-extendable/-/is-extendable-0.1.1.tgz#62b110e289a471418e3ec36a617d472e301dfc89" @@ -5008,6 +5187,13 @@ is-hexadecimal@^2.0.0: resolved "https://registry.yarnpkg.com/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz#86b5bf668fca307498d319dfc03289d781a90027" integrity sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg== +is-inside-container@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-inside-container/-/is-inside-container-1.0.0.tgz#e81fba699662eb31dbdaf26766a61d4814717ea4" + integrity sha512-KIYLCCJghfHZxqjYBE7rEy0OBuTd5xCHS7tHVgvCLkx7StIoaxwNW3hCALgEUjFfeRk+MG/Qxmp/vtETEF3tRA== + dependencies: + is-docker "^3.0.0" + is-installed-globally@^0.4.0: version "0.4.0" resolved "https://registry.yarnpkg.com/is-installed-globally/-/is-installed-globally-0.4.0.tgz#9a0fd407949c30f86eb6959ef1b7994ed0b7b520" @@ -5016,10 +5202,15 @@ is-installed-globally@^0.4.0: global-dirs "^3.0.0" is-path-inside "^3.0.2" +is-network-error@^1.0.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/is-network-error/-/is-network-error-1.3.0.tgz#2ce62cbca444abd506f8a900f39d20b898d37512" + integrity sha512-6oIwpsgRfnDiyEDLMay/GqCl3HoAtH5+RUKW29gYkL0QA+ipzpDLA16yQs7/RHCSu+BwgbJaOUqa4A99qNVQVw== + is-npm@^6.0.0: - version "6.0.0" - resolved "https://registry.yarnpkg.com/is-npm/-/is-npm-6.0.0.tgz#b59e75e8915543ca5d881ecff864077cba095261" - integrity sha512-JEjxbSmtPSt1c8XTkVrlujcXdKV1/tvuQ7GwKcAlyiVLeYFQ2VHat8xfrDJsIkhCdF/tZ7CiIR3sy141c6+gPQ== + version "6.1.0" + resolved "https://registry.yarnpkg.com/is-npm/-/is-npm-6.1.0.tgz#f70e0b6c132dfc817ac97d3badc0134945b098d3" + integrity sha512-O2z4/kNgyjhQwVR1Wpkbfc19JIhggF97NZNCpWTnjH7kVcZMUrnut9XSN7txI7VdyIYk5ZatOq3zvSuWpU8hoA== is-number@^7.0.0: version "7.0.0" @@ -5080,6 +5271,13 @@ is-wsl@^2.2.0: dependencies: is-docker "^2.0.0" +is-wsl@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/is-wsl/-/is-wsl-3.1.0.tgz#e1c657e39c10090afcbedec61720f6b924c3cbd2" + integrity sha512-UcVfVfaK4Sc4m7X3dUSoHoozQGBEFeDC+zVo06t98xe8CzHSZZBekNXH+tu0NalHolcJ/QAGqS46Hef7QXBIMw== + dependencies: + is-inside-container "^1.0.0" + is-yarn-global@^0.4.0: version "0.4.1" resolved "https://registry.yarnpkg.com/is-yarn-global/-/is-yarn-global-0.4.1.tgz#b312d902b313f81e4eaf98b6361ba2b45cd694bb" @@ -5172,16 +5370,11 @@ js-yaml@^4.1.0: dependencies: argparse "^2.0.1" -jsesc@^3.0.2: +jsesc@^3.0.2, jsesc@~3.1.0: version "3.1.0" resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-3.1.0.tgz#74d335a234f67ed19907fdadfac7ccf9d409825d" integrity sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA== -jsesc@~3.0.2: - version "3.0.2" - resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-3.0.2.tgz#bb8b09a6597ba426425f2e4a07245c3d00b9343e" - integrity sha512-xKqzzWXDttJuOcawBt4KnKHHIf5oQ/Cxax+0PWFG+DFDgHNAdi+TXECADI+RYiFUMmx8792xsMbbgXj4CwnP4g== - json-buffer@3.0.1: version "3.0.1" resolved "https://registry.yarnpkg.com/json-buffer/-/json-buffer-3.0.1.tgz#9338802a30d3b6605fbe0613e094008ca8c05a13" @@ -5202,15 +5395,20 @@ json-schema-traverse@^1.0.0: resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz#ae7bcb3656ab77a73ba5c49bf654f38e6b6860e2" integrity sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug== +json-schema@^0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/json-schema/-/json-schema-0.4.0.tgz#f7de4cf6efab838ebaeb3236474cbba5a1930ab5" + integrity sha512-es94M3nTIfsEPisRafak+HDLfHXnKBhV3vU5eqPcS3flIWqcxJWgXHXiey3YrpaNsanY5ei1VoYEbOzijuq9BA== + json5@^2.1.2, json5@^2.2.3: version "2.2.3" resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283" integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg== jsonfile@^6.0.1: - version "6.1.0" - resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.1.0.tgz#bc55b2634793c679ec6403094eb13698a6ec0aae" - integrity sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ== + version "6.2.0" + resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.2.0.tgz#7c265bd1b65de6977478300087c99f1c84383f62" + integrity sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg== dependencies: universalify "^2.0.0" optionalDependencies: @@ -5240,13 +5438,13 @@ latest-version@^7.0.0: dependencies: package-json "^8.1.0" -launch-editor@^2.6.0: - version "2.10.0" - resolved "https://registry.yarnpkg.com/launch-editor/-/launch-editor-2.10.0.tgz#5ca3edfcb9667df1e8721310f3a40f1127d4bc42" - integrity sha512-D7dBRJo/qcGX9xlvt/6wUYzQxjh5G1RvZPgPv8vi4KRU99DVQL/oW7tnVOCCTm2HGeo3C5HvGE5Yrh6UBoZ0vA== +launch-editor@^2.6.1: + version "2.11.1" + resolved "https://registry.yarnpkg.com/launch-editor/-/launch-editor-2.11.1.tgz#61a0b7314a42fd84a6cbb564573d9e9ffcf3d72b" + integrity sha512-SEET7oNfgSaB6Ym0jufAdCeo3meJVeCaaDyzRygy0xsp2BFKCprcfHljTq4QkzTLUxEKkFK6OK4811YM2oSrRg== dependencies: - picocolors "^1.0.0" - shell-quote "^1.8.1" + picocolors "^1.1.1" + shell-quote "^1.8.3" leven@^3.1.0: version "3.1.0" @@ -5264,9 +5462,9 @@ lines-and-columns@^1.1.6: integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg== loader-runner@^4.2.0: - version "4.3.0" - resolved "https://registry.yarnpkg.com/loader-runner/-/loader-runner-4.3.0.tgz#c1b4a163b99f614830353b16755e7149ac2314e1" - integrity sha512-3R/1M+yS3j5ou80Me59j7F9IMs4PXs3VqRrm0TU3AbKPxlmpoY1TNscJV/oGJXo8qCatFGTfDbY6W6ipGOYXfg== + version "4.3.1" + resolved "https://registry.yarnpkg.com/loader-runner/-/loader-runner-4.3.1.tgz#6c76ed29b0ccce9af379208299f07f876de737e3" + integrity sha512-IWqP2SCPhyVFTBtRcgMHdzlf9ul25NwaFx4wCEH/KjAXuuHY4yNjvPXsBokp8jCB936PyWRaPKUNh8NvylLp2Q== loader-utils@^2.0.0: version "2.0.4" @@ -5352,6 +5550,11 @@ markdown-table@^3.0.0: resolved "https://registry.yarnpkg.com/markdown-table/-/markdown-table-3.0.4.tgz#fe44d6d410ff9d6f2ea1797a3f60aa4d2b631c2a" integrity sha512-wiYz4+JrLyb/DqW2hkFJxP7Vd7JuTDm77fvbM8VfEQdmSMqcImWeeRbHwZjBjIFki/VaMK2BhFi7oUUZeM5bqw== +marked@^16.3.0: + version "16.4.1" + resolved "https://registry.yarnpkg.com/marked/-/marked-16.4.1.tgz#db37c878cfa28fa57b8dd471fe92a83282911052" + integrity sha512-ntROs7RaN3EvWfy3EZi14H4YxmT6A5YvywfhO+0pm+cH/dnSQRmdAmoFIc3B9aiwTehyk7pESH4ofyBY+V5hZg== + math-intrinsics@^1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/math-intrinsics/-/math-intrinsics-1.1.0.tgz#a0dd74be81e2aa5c2f27e65ce283605ee4e2b7f9" @@ -5590,12 +5793,17 @@ media-typer@0.3.0: resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748" integrity sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ== -memfs@^3.4.3: - version "3.6.0" - resolved "https://registry.yarnpkg.com/memfs/-/memfs-3.6.0.tgz#d7a2110f86f79dd950a8b6df6d57bc984aa185f6" - integrity sha512-EGowvkkgbMcIChjMTMkESFDbZeSh8xZ7kNSF0hAiAN4Jh6jgHCRS0Ga/+C8y6Au+oqpezRHCfPsmJ2+DwAgiwQ== +memfs@^4.43.1: + version "4.49.0" + resolved "https://registry.yarnpkg.com/memfs/-/memfs-4.49.0.tgz#bc35069570d41a31c62e31f1a6ec6057a8ea82f0" + integrity sha512-L9uC9vGuc4xFybbdOpRLoOAOq1YEBBsocCs5NVW32DfU+CZWWIn3OVF+lB8Gp4ttBVSMazwrTrjv8ussX/e3VQ== dependencies: - fs-monkey "^1.0.4" + "@jsonjoy.com/json-pack" "^1.11.0" + "@jsonjoy.com/util" "^1.9.0" + glob-to-regex.js "^1.0.1" + thingies "^2.5.0" + tree-dump "^1.0.3" + tslib "^2.0.0" merge-descriptors@1.0.3: version "1.0.3" @@ -6046,7 +6254,7 @@ mime-db@1.52.0: resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.52.0.tgz#bbabcdc02859f4987301c856e3387ce5ec43bf70" integrity sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg== -"mime-db@>= 1.43.0 < 2": +"mime-db@>= 1.43.0 < 2", mime-db@^1.54.0: version "1.54.0" resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.54.0.tgz#cddb3ee4f9c64530dff640236661d42cb6a314f5" integrity sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ== @@ -6063,13 +6271,20 @@ mime-types@2.1.18: dependencies: mime-db "~1.33.0" -mime-types@^2.1.27, mime-types@^2.1.31, mime-types@~2.1.17, mime-types@~2.1.24, mime-types@~2.1.34: +mime-types@^2.1.27, mime-types@~2.1.17, mime-types@~2.1.24, mime-types@~2.1.34: version "2.1.35" resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.35.tgz#381a871b62a734450660ae3deee44813f70d959a" integrity sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw== dependencies: mime-db "1.52.0" +mime-types@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-3.0.1.tgz#b1d94d6997a9b32fd69ebaed0db73de8acb519ce" + integrity sha512-xRc4oEhT6eaBpU1XF7AjpOFD+xQmXNB5OVKwp4tqCuBpHLS/ZbBDrc07mYTDqVMg6PfxUjjNp85O6Cd2Z/5HWA== + dependencies: + mime-db "^1.54.0" + mime@1.6.0: version "1.6.0" resolved "https://registry.yarnpkg.com/mime/-/mime-1.6.0.tgz#32cd9e5c64553bd58d19a568af452acff04981b1" @@ -6090,10 +6305,10 @@ mimic-response@^4.0.0: resolved "https://registry.yarnpkg.com/mimic-response/-/mimic-response-4.0.0.tgz#35468b19e7c75d10f5165ea25e75a5ceea7cf70f" integrity sha512-e5ISH9xMYU0DzrT+jl8q2ze9D6eWBto+I8CNpe+VI+K2J/F/k3PdkdTdz4wvGVH4NTpo+NRYTVIuMQEMMcsLqg== -mini-css-extract-plugin@^2.9.1: - version "2.9.2" - resolved "https://registry.yarnpkg.com/mini-css-extract-plugin/-/mini-css-extract-plugin-2.9.2.tgz#966031b468917a5446f4c24a80854b2947503c5b" - integrity sha512-GJuACcS//jtq4kCtd5ii/M0SZf7OZRH+BxdqXZHaJfb8TJiVl+NgQRPwiYt2EuqeSkNydn/7vP+bcE27C5mb9w== +mini-css-extract-plugin@^2.9.2: + version "2.9.4" + resolved "https://registry.yarnpkg.com/mini-css-extract-plugin/-/mini-css-extract-plugin-2.9.4.tgz#cafa1a42f8c71357f49cd1566810d74ff1cb0200" + integrity sha512-ZWYT7ln73Hptxqxk2DxPU9MmapXRhxkJD6tkSR04dnQxm8BGu2hzgKLugK5yySD97u/8yy7Ma7E76k9ZdvtjkQ== dependencies: schema-utils "^4.0.0" tapable "^2.2.1" @@ -6103,7 +6318,7 @@ minimalistic-assert@^1.0.0: resolved "https://registry.yarnpkg.com/minimalistic-assert/-/minimalistic-assert-1.0.1.tgz#2e194de044626d4a10e7f7fbc00ce73e83e4d5c7" integrity sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A== -minimatch@3.1.2, minimatch@^3.1.1: +minimatch@3.1.2: version "3.1.2" resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b" integrity sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw== @@ -6138,7 +6353,7 @@ multicast-dns@^7.2.5: dns-packet "^5.2.2" thunky "^1.0.2" -nanoid@^3.3.8: +nanoid@^3.3.11: version "3.3.11" resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.3.11.tgz#4f4f112cefbe303202f2199838128936266d185b" integrity sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w== @@ -6181,10 +6396,10 @@ node-forge@^1: resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-1.3.1.tgz#be8da2af243b2417d5f646a770663a92b7e9ded3" integrity sha512-dPEtOeMvF9VMcYV/1Wb8CPoVAXtp6MKMlcbAt4ddqmGqUJ6fQZFXkNZNkNlfevtNkGtaSoXf/vNNNSvgrdXwtA== -node-releases@^2.0.19: - version "2.0.19" - resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.19.tgz#9e445a52950951ec4d177d843af370b411caf314" - integrity sha512-xxOWJsBKtzAq7DY0J+DTzuz58K8e7sJbdgwkbMWQe8UYB6ekmsQ45q0M/tJDsGaZmbC+l7n57UV8Hl5tHxO9uw== +node-releases@^2.0.21: + version "2.0.25" + resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.25.tgz#95479437bd409231e03981c1f6abee67f5e962df" + integrity sha512-4auku8B/vw5psvTiiN9j1dAOsXvMoGqJuKJcR+dTdqiXEK20mMTk1UEo3HS16LeGQsVG6+qKTPM9u/qQ2LqATA== normalize-path@^3.0.0, normalize-path@~3.0.0: version "3.0.0" @@ -6197,9 +6412,9 @@ normalize-range@^0.1.2: integrity sha512-bdok/XvKII3nUpklnV6P2hxtMNrCboOjAcyBuQnWEhO665FwrSNRxU+AqpsyvO6LgGYPspN+lu5CLtw4jPRKNA== normalize-url@^8.0.0: - version "8.0.1" - resolved "https://registry.yarnpkg.com/normalize-url/-/normalize-url-8.0.1.tgz#9b7d96af9836577c58f5883e939365fa15623a4a" - integrity sha512-IO9QvjUMWxPQQhs60oOu10CRkWCiZzSUkzbXGGV9pviYl1fXYcvkzQ5jV9z8Y6un8ARoVRl4EtC6v6jNqbaJ/w== + version "8.1.0" + resolved "https://registry.yarnpkg.com/normalize-url/-/normalize-url-8.1.0.tgz#d33504f67970decf612946fd4880bc8c0983486d" + integrity sha512-X06Mfd/5aKsRHc0O0J5CUedwnPmnDtLF2+nq+KN9KSDlJHkPuh0JUviWjEWMe0SW/9TDdSLVPuk7L5gGTIA1/w== npm-run-path@^4.0.1: version "4.0.1" @@ -6260,24 +6475,17 @@ obuf@^1.0.0, obuf@^1.1.2: resolved "https://registry.yarnpkg.com/obuf/-/obuf-1.1.2.tgz#09bea3343d41859ebd446292d11c9d4db619084e" integrity sha512-PX1wu0AmAdPqOL1mWhqmlOd8kOIZQwGZw6rh7uby9fTc5lhaOWFLX3I6R1hrF9k3zUY40e6igsLGkDXK92LJNg== -on-finished@2.4.1: +on-finished@2.4.1, on-finished@^2.4.1: version "2.4.1" resolved "https://registry.yarnpkg.com/on-finished/-/on-finished-2.4.1.tgz#58c8c44116e54845ad57f14ab10b03533184ac3f" integrity sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg== dependencies: ee-first "1.1.1" -on-headers@~1.0.2: - version "1.0.2" - resolved "https://registry.yarnpkg.com/on-headers/-/on-headers-1.0.2.tgz#772b0ae6aaa525c399e489adfad90c403eb3c28f" - integrity sha512-pZAE+FJLoyITytdqK0U5s+FIpjN0JP3OzFi/u8Rx+EV5/W+JTWGXG8xFzevE7AjBfDqHv/8vL8qQsIhHnqRkrA== - -once@^1.3.0: - version "1.4.0" - resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" - integrity sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w== - dependencies: - wrappy "1" +on-headers@~1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/on-headers/-/on-headers-1.1.0.tgz#59da4f91c45f5f989c6e4bcedc5a3b0aed70ff65" + integrity sha512-737ZY3yNnXy37FHkQxPzt4UZ2UWPWiCZWLvFZ4fu5cueciegX0zGPnrlY6bwRg4FdQOe9YU8MkmJwGhoMybl8A== onetime@^5.1.2: version "5.1.2" @@ -6286,7 +6494,17 @@ onetime@^5.1.2: dependencies: mimic-fn "^2.1.0" -open@^8.0.9, open@^8.4.0: +open@^10.0.3: + version "10.2.0" + resolved "https://registry.yarnpkg.com/open/-/open-10.2.0.tgz#b9d855be007620e80b6fb05fac98141fe62db73c" + integrity sha512-YgBpdJHPyQ2UE5x+hlSXcnejzAvD0b22U2OuAP+8OnlJT+PjWPxtgmGqKKc+RgTM63U9gN0YzrYc71R2WT/hTA== + dependencies: + default-browser "^5.2.1" + define-lazy-prop "^3.0.0" + is-inside-container "^1.0.0" + wsl-utils "^0.1.0" + +open@^8.4.0: version "8.4.2" resolved "https://registry.yarnpkg.com/open/-/open-8.4.2.tgz#5b5ffe2a8f793dcd2aad73e550cb87b59cb084f9" integrity sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ== @@ -6339,12 +6557,13 @@ p-queue@^6.6.2: eventemitter3 "^4.0.4" p-timeout "^3.2.0" -p-retry@^4.5.0: - version "4.6.2" - resolved "https://registry.yarnpkg.com/p-retry/-/p-retry-4.6.2.tgz#9baae7184057edd4e17231cee04264106e092a16" - integrity sha512-312Id396EbJdvRONlngUx0NydfrIQ5lsYu0znKVUzVvArzEIt08V1qhtyESbGVd1FGX7UKtiFp5uwKZdM8wIuQ== +p-retry@^6.2.0: + version "6.2.1" + resolved "https://registry.yarnpkg.com/p-retry/-/p-retry-6.2.1.tgz#81828f8dc61c6ef5a800585491572cc9892703af" + integrity sha512-hEt02O4hUct5wtwg4H4KcWgDdm+l1bOaEy/hWzd8xtXB9BqxTWBBhb+2ImAtH4Cv4rPjV76xN3Zumqk3k3AhhQ== dependencies: - "@types/retry" "0.12.0" + "@types/retry" "0.12.2" + is-network-error "^1.0.0" retry "^0.13.1" p-timeout@^3.2.0: @@ -6440,11 +6659,6 @@ path-exists@^5.0.0: resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-5.0.0.tgz#a6aad9489200b21fab31e49cf09277e5116fb9e7" integrity sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ== -path-is-absolute@^1.0.0: - version "1.0.1" - resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" - integrity sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg== - path-is-inside@1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/path-is-inside/-/path-is-inside-1.0.2.tgz#365417dede44430d1c11af61027facf074bdfc53" @@ -6521,15 +6735,15 @@ postcss-clamp@^4.1.0: dependencies: postcss-value-parser "^4.2.0" -postcss-color-functional-notation@^7.0.9: - version "7.0.9" - resolved "https://registry.yarnpkg.com/postcss-color-functional-notation/-/postcss-color-functional-notation-7.0.9.tgz#2be1abbdd68fc7e8906a7a4ae6e6c8484aae8485" - integrity sha512-WScwD3pSsIz+QP97sPkGCeJm7xUH0J18k6zV5o8O2a4cQJyv15vLUx/WFQajuJVgZhmJL5awDu8zHnqzAzm4lw== +postcss-color-functional-notation@^7.0.12: + version "7.0.12" + resolved "https://registry.yarnpkg.com/postcss-color-functional-notation/-/postcss-color-functional-notation-7.0.12.tgz#9a3df2296889e629fde18b873bb1f50a4ecf4b83" + integrity sha512-TLCW9fN5kvO/u38/uesdpbx3e8AkTYhMvDZYa9JpmImWuTE99bDQ7GU7hdOADIZsiI9/zuxfAJxny/khknp1Zw== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" postcss-color-hex-alpha@^10.0.0: @@ -6566,35 +6780,35 @@ postcss-convert-values@^6.1.0: browserslist "^4.23.0" postcss-value-parser "^4.2.0" -postcss-custom-media@^11.0.5: - version "11.0.5" - resolved "https://registry.yarnpkg.com/postcss-custom-media/-/postcss-custom-media-11.0.5.tgz#2fcd88a9b1d4da41c67dac6f2def903063a3377d" - integrity sha512-SQHhayVNgDvSAdX9NQ/ygcDQGEY+aSF4b/96z7QUX6mqL5yl/JgG/DywcF6fW9XbnCRE+aVYk+9/nqGuzOPWeQ== +postcss-custom-media@^11.0.6: + version "11.0.6" + resolved "https://registry.yarnpkg.com/postcss-custom-media/-/postcss-custom-media-11.0.6.tgz#6b450e5bfa209efb736830066682e6567bd04967" + integrity sha512-C4lD4b7mUIw+RZhtY7qUbf4eADmb7Ey8BFA2px9jUbwg7pjTZDl4KY4bvlUV+/vXQvzQRfiGEVJyAbtOsCMInw== dependencies: - "@csstools/cascade-layer-name-parser" "^2.0.4" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/media-query-list-parser" "^4.0.2" + "@csstools/cascade-layer-name-parser" "^2.0.5" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/media-query-list-parser" "^4.0.3" -postcss-custom-properties@^14.0.4: - version "14.0.4" - resolved "https://registry.yarnpkg.com/postcss-custom-properties/-/postcss-custom-properties-14.0.4.tgz#de9c663285a98833a946d7003a34369d3ce373a9" - integrity sha512-QnW8FCCK6q+4ierwjnmXF9Y9KF8q0JkbgVfvQEMa93x1GT8FvOiUevWCN2YLaOWyByeDX8S6VFbZEeWoAoXs2A== +postcss-custom-properties@^14.0.6: + version "14.0.6" + resolved "https://registry.yarnpkg.com/postcss-custom-properties/-/postcss-custom-properties-14.0.6.tgz#1af73a650bf115ba052cf915287c9982825fc90e" + integrity sha512-fTYSp3xuk4BUeVhxCSJdIPhDLpJfNakZKoiTDx7yRGCdlZrSJR7mWKVOBS4sBF+5poPQFMj2YdXx1VHItBGihQ== dependencies: - "@csstools/cascade-layer-name-parser" "^2.0.4" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/cascade-layer-name-parser" "^2.0.5" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" "@csstools/utilities" "^2.0.0" postcss-value-parser "^4.2.0" -postcss-custom-selectors@^8.0.4: - version "8.0.4" - resolved "https://registry.yarnpkg.com/postcss-custom-selectors/-/postcss-custom-selectors-8.0.4.tgz#95ef8268fdbbbd84f34cf84a4517c9d99d419c5a" - integrity sha512-ASOXqNvDCE0dAJ/5qixxPeL1aOVGHGW2JwSy7HyjWNbnWTQCl+fDc968HY1jCmZI0+BaYT5CxsOiUhavpG/7eg== +postcss-custom-selectors@^8.0.5: + version "8.0.5" + resolved "https://registry.yarnpkg.com/postcss-custom-selectors/-/postcss-custom-selectors-8.0.5.tgz#9448ed37a12271d7ab6cb364b6f76a46a4a323e8" + integrity sha512-9PGmckHQswiB2usSO6XMSswO2yFWVoCAuih1yl9FVcwkscLjRKjwsjM3t+NIWpSU2Jx3eOiK2+t4vVTQaoCHHg== dependencies: - "@csstools/cascade-layer-name-parser" "^2.0.4" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" + "@csstools/cascade-layer-name-parser" "^2.0.5" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" postcss-selector-parser "^7.0.0" postcss-dir-pseudo-class@^9.0.1: @@ -6631,12 +6845,12 @@ postcss-discard-unused@^6.0.5: dependencies: postcss-selector-parser "^6.0.16" -postcss-double-position-gradients@^6.0.1: - version "6.0.1" - resolved "https://registry.yarnpkg.com/postcss-double-position-gradients/-/postcss-double-position-gradients-6.0.1.tgz#5fde3de9fb78b467244d8c4fde39f60397beb0ce" - integrity sha512-ZitCwmvOR4JzXmKw6sZblTgwV1dcfLvClcyjADuqZ5hU0Uk4SVNpvSN9w8NcJ7XuxhRYxVA8m8AB3gy+HNBQOA== +postcss-double-position-gradients@^6.0.4: + version "6.0.4" + resolved "https://registry.yarnpkg.com/postcss-double-position-gradients/-/postcss-double-position-gradients-6.0.4.tgz#b482d08b5ced092b393eb297d07976ab482d4cad" + integrity sha512-m6IKmxo7FxSP5nF2l63QbCC3r+bWpFUWmZXZf096WxG0m7Vl1Q1+ruFOhpdDRmKrRS+S3Jtk+TVk/7z0+BVK6g== dependencies: - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" postcss-value-parser "^4.2.0" @@ -6672,18 +6886,18 @@ postcss-image-set-function@^7.0.0: "@csstools/utilities" "^2.0.0" postcss-value-parser "^4.2.0" -postcss-lab-function@^7.0.9: - version "7.0.9" - resolved "https://registry.yarnpkg.com/postcss-lab-function/-/postcss-lab-function-7.0.9.tgz#09052f22cc2b8c589e9b29b5c0a10be105b29b69" - integrity sha512-IGbsIXbqMDusymJAKYX+f9oakPo89wL9Pzd/qRBQOVf3EIQWT9hgvqC4Me6Dkzxp3KPuIBf6LPkjrLHe/6ZMIQ== +postcss-lab-function@^7.0.12: + version "7.0.12" + resolved "https://registry.yarnpkg.com/postcss-lab-function/-/postcss-lab-function-7.0.12.tgz#eb555ac542607730eb0a87555074e4a5c6eef6e4" + integrity sha512-tUcyRk1ZTPec3OuKFsqtRzW2Go5lehW29XA21lZ65XmzQkz43VY2tyWEC202F7W3mILOjw0voOiuxRGTsN+J9w== dependencies: - "@csstools/css-color-parser" "^3.0.9" - "@csstools/css-parser-algorithms" "^3.0.4" - "@csstools/css-tokenizer" "^3.0.3" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" "@csstools/utilities" "^2.0.0" -postcss-loader@^7.3.3: +postcss-loader@^7.3.4: version "7.3.4" resolved "https://registry.yarnpkg.com/postcss-loader/-/postcss-loader-7.3.4.tgz#aed9b79ce4ed7e9e89e56199d25ad1ec8f606209" integrity sha512-iW5WTTBSC5BfsBJ9daFMPVrLT36MrNiC6fqOZTTaHjBNX6Pfd5p+hSBqe/fEeNd7pc13QiAyGt7VdGMw4eRC4A== @@ -6785,12 +6999,12 @@ postcss-modules-values@^4.0.0: dependencies: icss-utils "^5.0.0" -postcss-nesting@^13.0.1: - version "13.0.1" - resolved "https://registry.yarnpkg.com/postcss-nesting/-/postcss-nesting-13.0.1.tgz#c405796d7245a3e4c267a9956cacfe9670b5d43e" - integrity sha512-VbqqHkOBOt4Uu3G8Dm8n6lU5+9cJFxiuty9+4rcoyRPO9zZS1JIs6td49VIoix3qYqELHlJIn46Oih9SAKo+yQ== +postcss-nesting@^13.0.2: + version "13.0.2" + resolved "https://registry.yarnpkg.com/postcss-nesting/-/postcss-nesting-13.0.2.tgz#fde0d4df772b76d03b52eccc84372e8d1ca1402e" + integrity sha512-1YCI290TX+VP0U/K/aFxzHzQWHWURL+CtHMSbex1lCdpXD1SoR2sYuxDu5aNI9lPoXpKTCggFZiDJbwylU0LEQ== dependencies: - "@csstools/selector-resolve-nested" "^3.0.0" + "@csstools/selector-resolve-nested" "^3.1.0" "@csstools/selector-specificity" "^5.0.0" postcss-selector-parser "^7.0.0" @@ -6888,67 +7102,71 @@ postcss-place@^10.0.0: dependencies: postcss-value-parser "^4.2.0" -postcss-preset-env@^10.1.0: - version "10.1.6" - resolved "https://registry.yarnpkg.com/postcss-preset-env/-/postcss-preset-env-10.1.6.tgz#0f5456ea55a6bcbd0fd3c5f41e194881f42b17e5" - integrity sha512-1jRD7vttKLJ7o0mcmmYWKRLm7W14rI8K1I7Y41OeXUPEVc/CAzfTssNUeJ0zKbR+zMk4boqct/gwS/poIFF5Lg== +postcss-preset-env@^10.2.1: + version "10.4.0" + resolved "https://registry.yarnpkg.com/postcss-preset-env/-/postcss-preset-env-10.4.0.tgz#fa6167a307f337b2bcdd1d125604ff97cdeb5142" + integrity sha512-2kqpOthQ6JhxqQq1FSAAZGe9COQv75Aw8WbsOvQVNJ2nSevc9Yx/IKZGuZ7XJ+iOTtVon7LfO7ELRzg8AZ+sdw== dependencies: - "@csstools/postcss-cascade-layers" "^5.0.1" - "@csstools/postcss-color-function" "^4.0.9" - "@csstools/postcss-color-mix-function" "^3.0.9" - "@csstools/postcss-content-alt-text" "^2.0.5" - "@csstools/postcss-exponential-functions" "^2.0.8" + "@csstools/postcss-alpha-function" "^1.0.1" + "@csstools/postcss-cascade-layers" "^5.0.2" + "@csstools/postcss-color-function" "^4.0.12" + "@csstools/postcss-color-function-display-p3-linear" "^1.0.1" + "@csstools/postcss-color-mix-function" "^3.0.12" + "@csstools/postcss-color-mix-variadic-function-arguments" "^1.0.2" + "@csstools/postcss-content-alt-text" "^2.0.8" + "@csstools/postcss-contrast-color-function" "^2.0.12" + "@csstools/postcss-exponential-functions" "^2.0.9" "@csstools/postcss-font-format-keywords" "^4.0.0" - "@csstools/postcss-gamut-mapping" "^2.0.9" - "@csstools/postcss-gradients-interpolation-method" "^5.0.9" - "@csstools/postcss-hwb-function" "^4.0.9" - "@csstools/postcss-ic-unit" "^4.0.1" + "@csstools/postcss-gamut-mapping" "^2.0.11" + "@csstools/postcss-gradients-interpolation-method" "^5.0.12" + "@csstools/postcss-hwb-function" "^4.0.12" + "@csstools/postcss-ic-unit" "^4.0.4" "@csstools/postcss-initial" "^2.0.1" - "@csstools/postcss-is-pseudo-class" "^5.0.1" - "@csstools/postcss-light-dark-function" "^2.0.8" + "@csstools/postcss-is-pseudo-class" "^5.0.3" + "@csstools/postcss-light-dark-function" "^2.0.11" "@csstools/postcss-logical-float-and-clear" "^3.0.0" "@csstools/postcss-logical-overflow" "^2.0.0" "@csstools/postcss-logical-overscroll-behavior" "^2.0.0" "@csstools/postcss-logical-resize" "^3.0.0" - "@csstools/postcss-logical-viewport-units" "^3.0.3" - "@csstools/postcss-media-minmax" "^2.0.8" - "@csstools/postcss-media-queries-aspect-ratio-number-values" "^3.0.4" + "@csstools/postcss-logical-viewport-units" "^3.0.4" + "@csstools/postcss-media-minmax" "^2.0.9" + "@csstools/postcss-media-queries-aspect-ratio-number-values" "^3.0.5" "@csstools/postcss-nested-calc" "^4.0.0" "@csstools/postcss-normalize-display-values" "^4.0.0" - "@csstools/postcss-oklab-function" "^4.0.9" - "@csstools/postcss-progressive-custom-properties" "^4.0.1" - "@csstools/postcss-random-function" "^2.0.0" - "@csstools/postcss-relative-color-syntax" "^3.0.9" + "@csstools/postcss-oklab-function" "^4.0.12" + "@csstools/postcss-progressive-custom-properties" "^4.2.1" + "@csstools/postcss-random-function" "^2.0.1" + "@csstools/postcss-relative-color-syntax" "^3.0.12" "@csstools/postcss-scope-pseudo-class" "^4.0.1" - "@csstools/postcss-sign-functions" "^1.1.3" - "@csstools/postcss-stepped-value-functions" "^4.0.8" - "@csstools/postcss-text-decoration-shorthand" "^4.0.2" - "@csstools/postcss-trigonometric-functions" "^4.0.8" + "@csstools/postcss-sign-functions" "^1.1.4" + "@csstools/postcss-stepped-value-functions" "^4.0.9" + "@csstools/postcss-text-decoration-shorthand" "^4.0.3" + "@csstools/postcss-trigonometric-functions" "^4.0.9" "@csstools/postcss-unset-value" "^4.0.0" autoprefixer "^10.4.21" - browserslist "^4.24.4" + browserslist "^4.26.0" css-blank-pseudo "^7.0.1" - css-has-pseudo "^7.0.2" + css-has-pseudo "^7.0.3" css-prefers-color-scheme "^10.0.0" - cssdb "^8.2.5" + cssdb "^8.4.2" postcss-attribute-case-insensitive "^7.0.1" postcss-clamp "^4.1.0" - postcss-color-functional-notation "^7.0.9" + postcss-color-functional-notation "^7.0.12" postcss-color-hex-alpha "^10.0.0" postcss-color-rebeccapurple "^10.0.0" - postcss-custom-media "^11.0.5" - postcss-custom-properties "^14.0.4" - postcss-custom-selectors "^8.0.4" + postcss-custom-media "^11.0.6" + postcss-custom-properties "^14.0.6" + postcss-custom-selectors "^8.0.5" postcss-dir-pseudo-class "^9.0.1" - postcss-double-position-gradients "^6.0.1" + postcss-double-position-gradients "^6.0.4" postcss-focus-visible "^10.0.1" postcss-focus-within "^9.0.1" postcss-font-variant "^5.0.0" postcss-gap-properties "^6.0.0" postcss-image-set-function "^7.0.0" - postcss-lab-function "^7.0.9" + postcss-lab-function "^7.0.12" postcss-logical "^8.1.0" - postcss-nesting "^13.0.1" + postcss-nesting "^13.0.2" postcss-opacity-percentage "^3.0.0" postcss-overflow-shorthand "^6.0.0" postcss-page-break "^3.0.4" @@ -7046,12 +7264,12 @@ postcss-zindex@^6.0.2: resolved "https://registry.yarnpkg.com/postcss-zindex/-/postcss-zindex-6.0.2.tgz#e498304b83a8b165755f53db40e2ea65a99b56e1" integrity sha512-5BxW9l1evPB/4ZIc+2GobEBoKC+h8gPGCMi+jxsYvd2x0mjq7wazk6DrP71pStqxE9Foxh5TVnonbWpFZzXaYg== -postcss@^8.4.21, postcss@^8.4.24, postcss@^8.4.26, postcss@^8.4.33, postcss@^8.4.38: - version "8.5.3" - resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.5.3.tgz#1463b6f1c7fb16fe258736cba29a2de35237eafb" - integrity sha512-dle9A3yYxlBSrt8Fu+IpjGT8SY8hN0mlaA6GY8t0P5PjIOZemULz/E2Bnm/2dcUOena75OTNkHI76uZBNUUq3A== +postcss@^8.4.21, postcss@^8.4.24, postcss@^8.4.33, postcss@^8.5.4: + version "8.5.6" + resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.5.6.tgz#2825006615a619b4f62a9e7426cc120b349a8f3c" + integrity sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg== dependencies: - nanoid "^3.3.8" + nanoid "^3.3.11" picocolors "^1.1.1" source-map-js "^1.2.1" @@ -7132,9 +7350,9 @@ punycode@^2.1.0: integrity sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg== pupa@^3.1.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/pupa/-/pupa-3.1.0.tgz#f15610274376bbcc70c9a3aa8b505ea23f41c579" - integrity sha512-FLpr4flz5xZTSJxSeaheeMKN/EDzMdK7b8PTOC6a5PYFKTucWbdqjgqaEyH0shFiSJrVB1+Qqi4Tk19ccU6Aug== + version "3.3.0" + resolved "https://registry.yarnpkg.com/pupa/-/pupa-3.3.0.tgz#bc4036f9e8920c08ad472bc18fb600067cb83810" + integrity sha512-LjgDO2zPtoXP2wJpDjZrGdojii1uqO0cnwKoIoUzkfS98HDmbeiGmYiXo3lXeFlq2xvne1QFQhwYXSUCLKtEuA== dependencies: escape-goat "^4.0.0" @@ -7193,11 +7411,11 @@ rc@1.2.8: strip-json-comments "~2.0.1" react-dom@^19.0.0: - version "19.1.0" - resolved "https://registry.yarnpkg.com/react-dom/-/react-dom-19.1.0.tgz#133558deca37fa1d682708df8904b25186793623" - integrity sha512-Xs1hdnE+DyKgeHJeJznQmYMIBG3TKIHJJT95Q58nHLSrElKlGQqDTR2HQ9fx5CN/Gk6Vh/kupBTDLU11/nDk/g== + version "19.2.0" + resolved "https://registry.yarnpkg.com/react-dom/-/react-dom-19.2.0.tgz#00ed1e959c365e9a9d48f8918377465466ec3af8" + integrity sha512-UlbRu4cAiGaIewkPyiRGJk0imDN2T3JjieT6spoL2UeSf5od4n5LB/mQ4ejmxhCFT1tYe8IvaFulzynWovsEFQ== dependencies: - scheduler "^0.26.0" + scheduler "^0.27.0" react-fast-compare@^3.2.0: version "3.2.2" @@ -7221,9 +7439,9 @@ react-is@^16.13.1, react-is@^16.6.0, react-is@^16.7.0: integrity sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ== react-json-view-lite@^2.3.0: - version "2.4.1" - resolved "https://registry.yarnpkg.com/react-json-view-lite/-/react-json-view-lite-2.4.1.tgz#0d06696a06aaf4a74e890302b76cf8cddcc45d60" - integrity sha512-fwFYknRIBxjbFm0kBDrzgBy1xa5tDg2LyXXBepC5f1b+MY3BUClMCsvanMPn089JbV1Eg3nZcrp0VCuH43aXnA== + version "2.5.0" + resolved "https://registry.yarnpkg.com/react-json-view-lite/-/react-json-view-lite-2.5.0.tgz#c7ff011c7cc80e9900abc7aa4916c6a5c6d6c1c6" + integrity sha512-tk7o7QG9oYyELWHL8xiMQ8x4WzjCzbWNyig3uexmkLb54r8jO0yH3WCWx8UZS0c49eSA4QUmG5caiRJ8fAn58g== react-loadable-ssr-addon-v5-slorber@^1.0.1: version "1.0.1" @@ -7275,9 +7493,9 @@ react-router@5.3.4, react-router@^5.3.4: tiny-warning "^1.0.0" react@^19.0.0: - version "19.1.0" - resolved "https://registry.yarnpkg.com/react/-/react-19.1.0.tgz#926864b6c48da7627f004795d6cce50e90793b75" - integrity sha512-FS+XFBNvn3GTAWq26joslQgWNoFu08F4kl0J4CgdNKADkdSGXQyTCnKteIAJy96Br6YbpEU1LSzV5dYtjMkMDg== + version "19.2.0" + resolved "https://registry.yarnpkg.com/react/-/react-19.2.0.tgz#d33dd1721698f4376ae57a54098cb47fc75d93a5" + integrity sha512-tmbWg6W31tQLeB5cdIBOicJDJRR2KzXsV7uSK9iNfLWQ5bIZfxuPEHp7M8wiHyHnn0DD1i7w3Zmin0FtkrwoCQ== readable-stream@^2.0.1: version "2.3.8" @@ -7318,9 +7536,9 @@ recma-build-jsx@^1.0.0: vfile "^6.0.0" recma-jsx@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/recma-jsx/-/recma-jsx-1.0.0.tgz#f7bef02e571a49d6ba3efdfda8e2efab48dbe3aa" - integrity sha512-5vwkv65qWwYxg+Atz95acp8DMu1JDSqdGkA2Of1j6rCreyFUE/gp15fC8MnGEuG1W68UKjM6x6+YTWIh7hZM/Q== + version "1.0.1" + resolved "https://registry.yarnpkg.com/recma-jsx/-/recma-jsx-1.0.1.tgz#58e718f45e2102ed0bf2fa994f05b70d76801a1a" + integrity sha512-huSIy7VU2Z5OLv6oFLosQGGDqPqdO1iq6bWNAdhzMxSJP7RAso4fCZ1cKu8j9YHCZf3TPrq4dw3okhrylgcd7w== dependencies: acorn-jsx "^5.0.0" estree-util-to-js "^2.0.0" @@ -7348,10 +7566,10 @@ recma-stringify@^1.0.0: unified "^11.0.0" vfile "^6.0.0" -regenerate-unicode-properties@^10.2.0: - version "10.2.0" - resolved "https://registry.yarnpkg.com/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.0.tgz#626e39df8c372338ea9b8028d1f99dc3fd9c3db0" - integrity sha512-DqHn3DwbmmPVzeKj9woBadqmXxLvQoQIwu7nopMc72ztvxVmVk2SBhSnx67zuye5TP+lJsb/TBQsjLKhnDf3MA== +regenerate-unicode-properties@^10.2.2: + version "10.2.2" + resolved "https://registry.yarnpkg.com/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.2.tgz#aa113812ba899b630658c7623466be71e1f86f66" + integrity sha512-m03P+zhBeQd1RGnYxrGyDAPpWX/epKirLrp8e3qevZdVkKtnCrjjWczIbYc8+xd6vcTStVlqfycTx1KR4LOr0g== dependencies: regenerate "^1.4.2" @@ -7361,16 +7579,16 @@ regenerate@^1.4.2: integrity sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A== regexpu-core@^6.2.0: - version "6.2.0" - resolved "https://registry.yarnpkg.com/regexpu-core/-/regexpu-core-6.2.0.tgz#0e5190d79e542bf294955dccabae04d3c7d53826" - integrity sha512-H66BPQMrv+V16t8xtmq+UC0CBpiTBA60V8ibS1QVReIp8T1z8hwFxqcGzm9K6lgsN7sB5edVH8a+ze6Fqm4weA== + version "6.4.0" + resolved "https://registry.yarnpkg.com/regexpu-core/-/regexpu-core-6.4.0.tgz#3580ce0c4faedef599eccb146612436b62a176e5" + integrity sha512-0ghuzq67LI9bLXpOX/ISfve/Mq33a4aFRzoQYhnnok1JOFpmE/A2TBGkNVenOGEeSBCjIiWcc6MVOG5HEQv0sA== dependencies: regenerate "^1.4.2" - regenerate-unicode-properties "^10.2.0" + regenerate-unicode-properties "^10.2.2" regjsgen "^0.8.0" - regjsparser "^0.12.0" + regjsparser "^0.13.0" unicode-match-property-ecmascript "^2.0.0" - unicode-match-property-value-ecmascript "^2.1.0" + unicode-match-property-value-ecmascript "^2.2.1" registry-auth-token@^5.0.1: version "5.1.0" @@ -7391,12 +7609,12 @@ regjsgen@^0.8.0: resolved "https://registry.yarnpkg.com/regjsgen/-/regjsgen-0.8.0.tgz#df23ff26e0c5b300a6470cad160a9d090c3a37ab" integrity sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q== -regjsparser@^0.12.0: - version "0.12.0" - resolved "https://registry.yarnpkg.com/regjsparser/-/regjsparser-0.12.0.tgz#0e846df6c6530586429377de56e0475583b088dc" - integrity sha512-cnE+y8bz4NhMjISKbgeVJtqNbtf5QpjZP+Bslo+UqkIt9QPnX9q095eiRRASJG1/tz6dlNr6Z5NsBiWYokp6EQ== +regjsparser@^0.13.0: + version "0.13.0" + resolved "https://registry.yarnpkg.com/regjsparser/-/regjsparser-0.13.0.tgz#01f8351335cf7898d43686bc74d2dd71c847ecc0" + integrity sha512-NZQZdC5wOE/H3UT28fVGL+ikOZcEzfMGk/c3iN9UGxzWHMa1op7274oyiUVrAG4B2EuFhus8SvkaYnhvW92p9Q== dependencies: - jsesc "~3.0.2" + jsesc "~3.1.0" rehype-raw@^7.0.0: version "7.0.0" @@ -7465,9 +7683,9 @@ remark-gfm@^4.0.0: unified "^11.0.0" remark-mdx@^3.0.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/remark-mdx/-/remark-mdx-3.1.0.tgz#f979be729ecb35318fa48e2135c1169607a78343" - integrity sha512-Ngl/H3YXyBV9RcRNdlYsZujAmhsxwzxpDzpDEhFBVAGthS4GDgnctpDjgFl/ULx5UEDzqtW1cyBSNKqYYrqLBA== + version "3.1.1" + resolved "https://registry.yarnpkg.com/remark-mdx/-/remark-mdx-3.1.1.tgz#047f97038bc7ec387aebb4b0a4fe23779999d845" + integrity sha512-Pjj2IYlUY3+D8x00UJsIOg5BEvfMyeI+2uLPn9VO9Wg4MEtN/VTIq2NEJQfde9PnX15KgtHyl9S0BcTnWrIuWg== dependencies: mdast-util-mdx "^3.0.0" micromark-extension-mdxjs "^3.0.0" @@ -7548,7 +7766,7 @@ resolve-pathname@^3.0.0: resolved "https://registry.yarnpkg.com/resolve-pathname/-/resolve-pathname-3.0.0.tgz#99d02224d3cf263689becbb393bc560313025dcd" integrity sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng== -resolve@^1.14.2: +resolve@^1.22.10: version "1.22.10" resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.22.10.tgz#b663e83ffb09bbf2386944736baae803029b8b39" integrity sha512-NPRy+/ncIMeDlTAsuqwKIiferiawhefFJtkNSW0qZJEqMEb+qBt/77B/jGeeek+F0uOeN05CDa6HXbbIgtVX4w== @@ -7574,13 +7792,6 @@ reusify@^1.0.4: resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.1.0.tgz#0fe13b9522e1473f51b558ee796e08f11f9b489f" integrity sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw== -rimraf@^3.0.2: - version "3.0.2" - resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a" - integrity sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA== - dependencies: - glob "^7.1.3" - rtlcss@^4.1.0: version "4.3.0" resolved "https://registry.yarnpkg.com/rtlcss/-/rtlcss-4.3.0.tgz#f8efd4d5b64f640ec4af8fa25b65bacd9e07cc97" @@ -7591,6 +7802,11 @@ rtlcss@^4.1.0: postcss "^8.4.21" strip-json-comments "^3.1.1" +run-applescript@^7.0.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/run-applescript/-/run-applescript-7.1.0.tgz#2e9e54c4664ec3106c5b5630e249d3d6595c4911" + integrity sha512-DPe5pVFaAsinSaV6QjQ6gdiedWDcRCbUuiQfQa2wmWV7+xC9bGulGI8+TdRmoFkAPaBXk8CrAbnlY2ISniJ47Q== + run-parallel@^1.1.9: version "1.2.0" resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" @@ -7618,10 +7834,10 @@ sax@^1.2.4: resolved "https://registry.yarnpkg.com/sax/-/sax-1.4.1.tgz#44cc8988377f126304d3b3fc1010c733b929ef0f" integrity sha512-+aWOz7yVScEGoKNd4PA10LZ8sk0A/z5+nXQG5giUO5rprX9jgYsTdov9qCchZiPIZezbZH+jRut8nPodFAX4Jg== -scheduler@^0.26.0: - version "0.26.0" - resolved "https://registry.yarnpkg.com/scheduler/-/scheduler-0.26.0.tgz#4ce8a8c2a2095f13ea11bf9a445be50c555d6337" - integrity sha512-NlHwttCI/l5gCPR3D1nNXtWABUmBwvZpEQiD4IXSbIDq8BzLIK/7Ir5gTFSGZDUu37K5cMNp0hFtzO38sC7gWA== +scheduler@^0.27.0: + version "0.27.0" + resolved "https://registry.yarnpkg.com/scheduler/-/scheduler-0.27.0.tgz#0c4ef82d67d1e5c1e359e8fc76d3a87f045fe5bd" + integrity sha512-eNv+WrVbKu1f3vbYJT/xtiF5syA5HPIMtf9IgY/nKg0sWqzAUEvqY/xm7OcZc/qafLx/iO9FgOmeSAp4v5ti/Q== schema-dts@^1.1.2: version "1.1.5" @@ -7637,10 +7853,10 @@ schema-utils@^3.0.0: ajv "^6.12.5" ajv-keywords "^3.5.2" -schema-utils@^4.0.0, schema-utils@^4.0.1, schema-utils@^4.3.0, schema-utils@^4.3.2: - version "4.3.2" - resolved "https://registry.yarnpkg.com/schema-utils/-/schema-utils-4.3.2.tgz#0c10878bf4a73fd2b1dfd14b9462b26788c806ae" - integrity sha512-Gn/JaSk/Mt9gYubxTtSn/QCV4em9mpAPiR1rqy/Ocu19u/G9J5WWdNoUT4SiV6mFC3y6cxyFcFwdzPM3FgxGAQ== +schema-utils@^4.0.0, schema-utils@^4.0.1, schema-utils@^4.2.0, schema-utils@^4.3.0, schema-utils@^4.3.3: + version "4.3.3" + resolved "https://registry.yarnpkg.com/schema-utils/-/schema-utils-4.3.3.tgz#5b1850912fa31df90716963d45d9121fdfc09f46" + integrity sha512-eflK8wEtyOE6+hsaRVPxvUKYCpRgzLqDTb8krvAsRIwOGlHoSgYLgBXoubGgLd2fT41/OUYdb48v4k4WWHQurA== dependencies: "@types/json-schema" "^7.0.9" ajv "^8.9.0" @@ -7660,7 +7876,7 @@ select-hose@^2.0.0: resolved "https://registry.yarnpkg.com/select-hose/-/select-hose-2.0.0.tgz#625d8658f865af43ec962bfc376a37359a4994ca" integrity sha512-mEugaLK+YfkijB4fx0e6kImuJdCIt2LxCRcbEYPqRGCs4F2ogyfZU5IAZRdjCP8JPq2AtdNoC/Dux63d9Kiryg== -selfsigned@^2.1.1: +selfsigned@^2.4.1: version "2.4.1" resolved "https://registry.yarnpkg.com/selfsigned/-/selfsigned-2.4.1.tgz#560d90565442a3ed35b674034cec4e95dceb4ae0" integrity sha512-th5B4L2U+eGLq1TVh7zNRGBapioSORUeymIydxgFpwww9d2qyKvtuPU2jJuHvYAwwqi2Y596QBL3eEqcPEYL8Q== @@ -7681,9 +7897,9 @@ semver@^6.3.1: integrity sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA== semver@^7.3.5, semver@^7.3.7, semver@^7.5.4: - version "7.7.2" - resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.2.tgz#67d99fdcd35cec21e6f8b87a7fd515a33f982b58" - integrity sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA== + version "7.7.3" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.3.tgz#4b5f4143d007633a8dc671cd0a6ef9147b8bb946" + integrity sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q== send@0.19.0: version "0.19.0" @@ -7793,10 +8009,10 @@ shebang-regex@^3.0.0: resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172" integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== -shell-quote@^1.8.1: - version "1.8.2" - resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.8.2.tgz#d2d83e057959d53ec261311e9e9b8f51dcb2934a" - integrity sha512-AzqKpGKjrj7EM6rKVQEPpB288oCfnrEIuyoT9cyF4nmGa7V8Zk6f7RRqYisX8X9m+Q7bd632aZW4ky7EhbQztA== +shell-quote@^1.8.3: + version "1.8.3" + resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.8.3.tgz#55e40ef33cf5c689902353a3d8cd1a6725f08b4b" + integrity sha512-ObmnIF4hXNg1BqhnHmgbDETF8dLPCggZWBjkQfhZpbszZnYur5DUljTcCHii5LC3J5E0yeO/1LIMyH+UvHQgyw== side-channel-list@^1.0.0: version "1.0.0" @@ -7925,9 +8141,9 @@ source-map@^0.6.0, source-map@~0.6.0: integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g== source-map@^0.7.0: - version "0.7.4" - resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.7.4.tgz#a9bbe705c9d8846f4e08ff6765acf0f1b0898656" - integrity sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA== + version "0.7.6" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.7.6.tgz#a3658ab87e5b6429c8a1f3ba0083d4c61ca3ef02" + integrity sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ== space-separated-tokens@^2.0.0: version "2.0.2" @@ -7978,9 +8194,9 @@ statuses@2.0.1: integrity sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA== std-env@^3.7.0: - version "3.9.0" - resolved "https://registry.yarnpkg.com/std-env/-/std-env-3.9.0.tgz#1a6f7243b339dca4c9fd55e1c7504c77ef23e8f1" - integrity sha512-UGvjygr6F6tpH7o2qyqR6QYpwraIjKSdtzyBdyytFOHmPZY917kwdwLG0RbOjWOnKmnm3PeHjaoLLMie7kPLQw== + version "3.10.0" + resolved "https://registry.yarnpkg.com/std-env/-/std-env-3.10.0.tgz#d810b27e3a073047b2b5e40034881f5ea6f9c83b" + integrity sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg== string-width@^4.1.0, string-width@^4.2.0: version "4.2.3" @@ -8039,9 +8255,9 @@ strip-ansi@^6.0.0, strip-ansi@^6.0.1: ansi-regex "^5.0.1" strip-ansi@^7.0.1: - version "7.1.0" - resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-7.1.0.tgz#d5b6568ca689d8561370b0707685d22434faff45" - integrity sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ== + version "7.1.2" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-7.1.2.tgz#132875abde678c7ea8d691533f2e7e22bb744dba" + integrity sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA== dependencies: ansi-regex "^6.0.1" @@ -8066,16 +8282,16 @@ strip-json-comments@~2.0.1: integrity sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ== style-to-js@^1.0.0: - version "1.1.16" - resolved "https://registry.yarnpkg.com/style-to-js/-/style-to-js-1.1.16.tgz#e6bd6cd29e250bcf8fa5e6591d07ced7575dbe7a" - integrity sha512-/Q6ld50hKYPH3d/r6nr117TZkHR0w0kGGIVfpG9N6D8NymRPM9RqCUv4pRpJ62E5DqOYx2AFpbZMyCPnjQCnOw== + version "1.1.18" + resolved "https://registry.yarnpkg.com/style-to-js/-/style-to-js-1.1.18.tgz#3e6c13bd4c4db079bd2c2c94571cce5c758bc2ff" + integrity sha512-JFPn62D4kJaPTnhFUI244MThx+FEGbi+9dw1b9yBBQ+1CZpV7QAT8kUtJ7b7EUNdHajjF/0x8fT+16oLJoojLg== dependencies: - style-to-object "1.0.8" + style-to-object "1.0.11" -style-to-object@1.0.8: - version "1.0.8" - resolved "https://registry.yarnpkg.com/style-to-object/-/style-to-object-1.0.8.tgz#67a29bca47eaa587db18118d68f9d95955e81292" - integrity sha512-xT47I/Eo0rwJmaXC4oilDGDWLohVhR6o/xAQcPQN8q6QBuZVL8qMYL85kLmST5cPjAorwvqIA4qXTRQoYHaL6g== +style-to-object@1.0.11: + version "1.0.11" + resolved "https://registry.yarnpkg.com/style-to-object/-/style-to-object-1.0.11.tgz#cf252c4051758b7acb18a5efb296f91fb79bb9c4" + integrity sha512-5A560JmXr7wDyGLK12Nq/EYS38VkGlglVzkis1JEdbGWSnbQIEhZzTJhzURXN5/8WwwFCs/f/VVcmkTppbXLow== dependencies: inline-style-parser "0.2.4" @@ -8124,10 +8340,18 @@ svgo@^3.0.2, svgo@^3.2.0: csso "^5.0.5" picocolors "^1.0.0" -tapable@^2.0.0, tapable@^2.1.1, tapable@^2.2.0, tapable@^2.2.1: - version "2.2.2" - resolved "https://registry.yarnpkg.com/tapable/-/tapable-2.2.2.tgz#ab4984340d30cb9989a490032f086dbb8b56d872" - integrity sha512-Re10+NauLTMCudc7T5WLFLAwDhQ0JWdrMK+9B2M8zR5hRExKmsRDCBA7/aV/pNJFltmBFO5BAMlQFi/vq3nKOg== +swr@^2.2.5: + version "2.3.6" + resolved "https://registry.yarnpkg.com/swr/-/swr-2.3.6.tgz#5fee0ee8a0762a16871ee371075cb09422b64f50" + integrity sha512-wfHRmHWk/isGNMwlLGlZX5Gzz/uTgo0o2IRuTMcf4CPuPFJZlq0rDaKUx+ozB5nBOReNV1kiOyzMfj+MBMikLw== + dependencies: + dequal "^2.0.3" + use-sync-external-store "^1.4.0" + +tapable@^2.0.0, tapable@^2.2.0, tapable@^2.2.1, tapable@^2.3.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/tapable/-/tapable-2.3.0.tgz#7e3ea6d5ca31ba8e078b560f0d83ce9a14aa8be6" + integrity sha512-g9ljZiwki/LfxmQADO3dEY1CbpmXT5Hm2fJ+QaGKwSXUylMybePR7/67YW7jOrrvjEgL1Fmz5kzyAjWVWLlucg== terser-webpack-plugin@^5.3.11, terser-webpack-plugin@^5.3.9: version "5.3.14" @@ -8141,15 +8365,25 @@ terser-webpack-plugin@^5.3.11, terser-webpack-plugin@^5.3.9: terser "^5.31.1" terser@^5.10.0, terser@^5.15.1, terser@^5.31.1: - version "5.39.2" - resolved "https://registry.yarnpkg.com/terser/-/terser-5.39.2.tgz#5a1626030724a672e2e5b5c9cd9070308c20e8f9" - integrity sha512-yEPUmWve+VA78bI71BW70Dh0TuV4HHd+I5SHOAfS1+QBOmvmCiiffgjR8ryyEd3KIfvPGFqoADt8LdQ6XpXIvg== + version "5.44.0" + resolved "https://registry.yarnpkg.com/terser/-/terser-5.44.0.tgz#ebefb8e5b8579d93111bfdfc39d2cf63879f4a82" + integrity sha512-nIVck8DK+GM/0Frwd+nIhZ84pR/BX7rmXMfYwyg+Sri5oGVE99/E3KvXqpC2xHFxyqXyGHTKBSioxxplrO4I4w== dependencies: "@jridgewell/source-map" "^0.3.3" - acorn "^8.14.0" + acorn "^8.15.0" commander "^2.20.0" source-map-support "~0.5.20" +thingies@^2.5.0: + version "2.5.0" + resolved "https://registry.yarnpkg.com/thingies/-/thingies-2.5.0.tgz#5f7b882c933b85989f8466b528a6247a6881e04f" + integrity sha512-s+2Bwztg6PhWUD7XMfeYm5qliDdSiZm7M7n8KjTkIsm3l/2lgVRc2/Gx/v+ZX8lT4FMA+i8aQvhcWylldc+ZNw== + +throttleit@2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/throttleit/-/throttleit-2.1.0.tgz#a7e4aa0bf4845a5bd10daa39ea0c783f631a07b4" + integrity sha512-nt6AMGKW1p/70DF/hGBdJB57B8Tspmbp5gfJ8ilhLnt7kkr2ye7hzD6NVG8GGErk2HWF34igrL2CXmNIkzKqKw== + thunky@^1.0.2: version "1.1.0" resolved "https://registry.yarnpkg.com/thunky/-/thunky-1.1.0.tgz#5abaf714a9405db0504732bbccd2cedd9ef9537d" @@ -8166,9 +8400,9 @@ tiny-warning@^1.0.0: integrity sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA== tinypool@^1.0.2: - version "1.0.2" - resolved "https://registry.yarnpkg.com/tinypool/-/tinypool-1.0.2.tgz#706193cc532f4c100f66aa00b01c42173d9051b2" - integrity sha512-al6n+QEANGFOMf/dmUMsuS5/r9B06uwlyNjZZql/zv8J7ybHCgoihBNORZCY2mzUuAnomQa2JdhyHKzZxPCrFA== + version "1.1.1" + resolved "https://registry.yarnpkg.com/tinypool/-/tinypool-1.1.1.tgz#059f2d042bd37567fbc017d3d426bdd2a2612591" + integrity sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg== to-regex-range@^5.0.1: version "5.0.1" @@ -8187,6 +8421,11 @@ totalist@^3.0.0: resolved "https://registry.yarnpkg.com/totalist/-/totalist-3.0.1.tgz#ba3a3d600c915b1a97872348f79c127475f6acf8" integrity sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ== +tree-dump@^1.0.3, tree-dump@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/tree-dump/-/tree-dump-1.1.0.tgz#ab29129169dc46004414f5a9d4a3c6e89f13e8a4" + integrity sha512-rMuvhU4MCDbcbnleZTFezWsaZXRFemSqAM+7jPnzUl1fo9w3YEKOxAeui0fz3OI4EU4hf23iyA7uQRVko+UaBA== + trim-lines@^3.0.0: version "3.0.1" resolved "https://registry.yarnpkg.com/trim-lines/-/trim-lines-3.0.1.tgz#d802e332a07df861c48802c04321017b1bd87338" @@ -8197,7 +8436,7 @@ trough@^2.0.0: resolved "https://registry.yarnpkg.com/trough/-/trough-2.2.0.tgz#94a60bd6bd375c152c1df911a4b11d5b0256f50f" integrity sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw== -tslib@^2.0.3, tslib@^2.6.0: +tslib@^2.0.0, tslib@^2.0.3, tslib@^2.6.0: version "2.8.1" resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f" integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w== @@ -8232,10 +8471,10 @@ typedarray-to-buffer@^3.1.5: dependencies: is-typedarray "^1.0.0" -undici-types@~6.21.0: - version "6.21.0" - resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-6.21.0.tgz#691d00af3909be93a7faa13be61b3a5b50ef12cb" - integrity sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ== +undici-types@~7.14.0: + version "7.14.0" + resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-7.14.0.tgz#4c037b32ca4d7d62fae042174604341588bc0840" + integrity sha512-QQiYxHuyZ9gQUIrmPo3IA+hUl4KYk8uSA7cHrcKd/l3p1OTpZcM0Tbp9x7FAtXdAYhlasd60ncPpgu6ihG6TOA== unicode-canonical-property-names-ecmascript@^2.0.0: version "2.0.1" @@ -8255,15 +8494,15 @@ unicode-match-property-ecmascript@^2.0.0: unicode-canonical-property-names-ecmascript "^2.0.0" unicode-property-aliases-ecmascript "^2.0.0" -unicode-match-property-value-ecmascript@^2.1.0: - version "2.2.0" - resolved "https://registry.yarnpkg.com/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.2.0.tgz#a0401aee72714598f739b68b104e4fe3a0cb3c71" - integrity sha512-4IehN3V/+kkr5YeSSDDQG8QLqO26XpL2XP3GQtqwlT/QYSECAwFztxVHjlbh0+gjJ3XmNLS0zDsbgs9jWKExLg== +unicode-match-property-value-ecmascript@^2.2.1: + version "2.2.1" + resolved "https://registry.yarnpkg.com/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.2.1.tgz#65a7adfad8574c219890e219285ce4c64ed67eaa" + integrity sha512-JQ84qTuMg4nVkx8ga4A16a1epI9H6uTXAknqxkGF/aFfRLw1xC/Bp24HNLaZhHSkWd3+84t8iXnp1J0kYcZHhg== unicode-property-aliases-ecmascript@^2.0.0: - version "2.1.0" - resolved "https://registry.yarnpkg.com/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.1.0.tgz#43d41e3be698bd493ef911077c9b131f827e8ccd" - integrity sha512-6t3foTQI9qne+OZoVQB/8x8rk2k1eVy1gRXhV3oFQ5T6R1dqQ1xtin3XqSlx3+ATBkliTaR/hHyJBm+LVPNM8w== + version "2.2.0" + resolved "https://registry.yarnpkg.com/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.2.0.tgz#301d4f8a43d2b75c97adfad87c9dd5350c9475d1" + integrity sha512-hpbDzxUY9BFwX+UeBnxv3Sh1q7HFxj48DTmXchNgRa46lO8uj3/1iEn3MiNUYTg1g9ctIqXCCERn8gYZhHC5lQ== unified@^11.0.0, unified@^11.0.3, unified@^11.0.4: version "11.0.5" @@ -8286,9 +8525,9 @@ unique-string@^3.0.0: crypto-random-string "^4.0.0" unist-util-is@^6.0.0: - version "6.0.0" - resolved "https://registry.yarnpkg.com/unist-util-is/-/unist-util-is-6.0.0.tgz#b775956486aff107a9ded971d996c173374be424" - integrity sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw== + version "6.0.1" + resolved "https://registry.yarnpkg.com/unist-util-is/-/unist-util-is-6.0.1.tgz#d0a3f86f2dd0db7acd7d8c2478080b5c67f9c6a9" + integrity sha512-LsiILbtBETkDz8I9p1dQ0uyRUWuaQzd/cuEeS1hoRSyW5E5XGmTzlwY1OrNzzakGowI9Dr/I8HVaw4hTtnxy8g== dependencies: "@types/unist" "^3.0.0" @@ -8314,9 +8553,9 @@ unist-util-stringify-position@^4.0.0: "@types/unist" "^3.0.0" unist-util-visit-parents@^6.0.0: - version "6.0.1" - resolved "https://registry.yarnpkg.com/unist-util-visit-parents/-/unist-util-visit-parents-6.0.1.tgz#4d5f85755c3b8f0dc69e21eca5d6d82d22162815" - integrity sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw== + version "6.0.2" + resolved "https://registry.yarnpkg.com/unist-util-visit-parents/-/unist-util-visit-parents-6.0.2.tgz#777df7fb98652ce16b4b7cd999d0a1a40efa3a02" + integrity sha512-goh1s1TBrqSqukSc8wrjwWhL0hiJxgA8m4kFxGlQ+8FYQ3C/m11FcTs4YYem7V664AhHVvgoQLk890Ssdsr2IQ== dependencies: "@types/unist" "^3.0.0" unist-util-is "^6.0.0" @@ -8384,6 +8623,11 @@ url-loader@^4.1.1: mime-types "^2.1.27" schema-utils "^3.0.0" +use-sync-external-store@^1.4.0: + version "1.6.0" + resolved "https://registry.yarnpkg.com/use-sync-external-store/-/use-sync-external-store-1.6.0.tgz#b174bfa65cb2b526732d9f2ac0a408027876f32d" + integrity sha512-Pp6GSwGP/NrPIrxVFAIkOQeyw8lFenOHijQWkUTrDvrF4ALqylP2C/KCkeS9dpUM3KvYRQhna5vt7IL95+ZQ9w== + util-deprecate@^1.0.1, util-deprecate@^1.0.2, util-deprecate@~1.0.1: version "1.0.2" resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf" @@ -8428,9 +8672,9 @@ vfile-location@^5.0.0: vfile "^6.0.0" vfile-message@^4.0.0: - version "4.0.2" - resolved "https://registry.yarnpkg.com/vfile-message/-/vfile-message-4.0.2.tgz#c883c9f677c72c166362fd635f21fc165a7d1181" - integrity sha512-jRDZ1IMLttGj41KcZvlrYAaI3CfqpLpfpf+Mfig13viT6NKvRzWZ+lXz0Y5D60w6uJIBAOGq9mSHf0gktF0duw== + version "4.0.3" + resolved "https://registry.yarnpkg.com/vfile-message/-/vfile-message-4.0.3.tgz#87b44dddd7b70f0641c2e3ed0864ba73e2ea8df4" + integrity sha512-QTHzsGd1EhbZs4AsQ20JX1rC3cOlt/IWJruk893DfLRr57lcnOeMaWG4K0JrRta4mIJZKth2Au3mM3u03/JWKw== dependencies: "@types/unist" "^3.0.0" unist-util-stringify-position "^4.0.0" @@ -8443,7 +8687,7 @@ vfile@^6.0.0, vfile@^6.0.1: "@types/unist" "^3.0.0" vfile-message "^4.0.0" -watchpack@^2.4.1: +watchpack@^2.4.4: version "2.4.4" resolved "https://registry.yarnpkg.com/watchpack/-/watchpack-2.4.4.tgz#473bda72f0850453da6425081ea46fc0d7602947" integrity sha512-c5EGNOiyxxV5qmTtAB7rbiXxi1ooX1pQKMLX/MIabJjRA0SJBQOjKF+KSVfHkr9U1cADPon0mRiVe/riyaiDUA== @@ -8481,52 +8725,51 @@ webpack-bundle-analyzer@^4.10.2: sirv "^2.0.3" ws "^7.3.1" -webpack-dev-middleware@^5.3.4: - version "5.3.4" - resolved "https://registry.yarnpkg.com/webpack-dev-middleware/-/webpack-dev-middleware-5.3.4.tgz#eb7b39281cbce10e104eb2b8bf2b63fce49a3517" - integrity sha512-BVdTqhhs+0IfoeAf7EoH5WE+exCmqGerHfDM0IL096Px60Tq2Mn9MAbnaGUe6HiMa41KMCYF19gyzZmBcq/o4Q== +webpack-dev-middleware@^7.4.2: + version "7.4.5" + resolved "https://registry.yarnpkg.com/webpack-dev-middleware/-/webpack-dev-middleware-7.4.5.tgz#d4e8720aa29cb03bc158084a94edb4594e3b7ac0" + integrity sha512-uxQ6YqGdE4hgDKNf7hUiPXOdtkXvBJXrfEGYSx7P7LC8hnUYGK70X6xQXUvXeNyBDDcsiQXpG2m3G9vxowaEuA== dependencies: colorette "^2.0.10" - memfs "^3.4.3" - mime-types "^2.1.31" + memfs "^4.43.1" + mime-types "^3.0.1" + on-finished "^2.4.1" range-parser "^1.2.1" schema-utils "^4.0.0" -webpack-dev-server@^4.15.2: - version "4.15.2" - resolved "https://registry.yarnpkg.com/webpack-dev-server/-/webpack-dev-server-4.15.2.tgz#9e0c70a42a012560860adb186986da1248333173" - integrity sha512-0XavAZbNJ5sDrCbkpWL8mia0o5WPOd2YGtxrEiZkBK9FjLppIUK2TgxK6qGD2P3hUXTJNNPVibrerKcx5WkR1g== +webpack-dev-server@^5.2.2: + version "5.2.2" + resolved "https://registry.yarnpkg.com/webpack-dev-server/-/webpack-dev-server-5.2.2.tgz#96a143d50c58fef0c79107e61df911728d7ceb39" + integrity sha512-QcQ72gh8a+7JO63TAx/6XZf/CWhgMzu5m0QirvPfGvptOusAxG12w2+aua1Jkjr7hzaWDnJ2n6JFeexMHI+Zjg== dependencies: - "@types/bonjour" "^3.5.9" - "@types/connect-history-api-fallback" "^1.3.5" - "@types/express" "^4.17.13" - "@types/serve-index" "^1.9.1" - "@types/serve-static" "^1.13.10" - "@types/sockjs" "^0.3.33" - "@types/ws" "^8.5.5" + "@types/bonjour" "^3.5.13" + "@types/connect-history-api-fallback" "^1.5.4" + "@types/express" "^4.17.21" + "@types/express-serve-static-core" "^4.17.21" + "@types/serve-index" "^1.9.4" + "@types/serve-static" "^1.15.5" + "@types/sockjs" "^0.3.36" + "@types/ws" "^8.5.10" ansi-html-community "^0.0.8" - bonjour-service "^1.0.11" - chokidar "^3.5.3" + bonjour-service "^1.2.1" + chokidar "^3.6.0" colorette "^2.0.10" compression "^1.7.4" connect-history-api-fallback "^2.0.0" - default-gateway "^6.0.3" - express "^4.17.3" + express "^4.21.2" graceful-fs "^4.2.6" - html-entities "^2.3.2" - http-proxy-middleware "^2.0.3" - ipaddr.js "^2.0.1" - launch-editor "^2.6.0" - open "^8.0.9" - p-retry "^4.5.0" - rimraf "^3.0.2" - schema-utils "^4.0.0" - selfsigned "^2.1.1" + http-proxy-middleware "^2.0.9" + ipaddr.js "^2.1.0" + launch-editor "^2.6.1" + open "^10.0.3" + p-retry "^6.2.0" + schema-utils "^4.2.0" + selfsigned "^2.4.1" serve-index "^1.9.1" sockjs "^0.3.24" spdy "^4.0.2" - webpack-dev-middleware "^5.3.4" - ws "^8.13.0" + webpack-dev-middleware "^7.4.2" + ws "^8.18.0" webpack-merge@^5.9.0: version "5.10.0" @@ -8546,26 +8789,27 @@ webpack-merge@^6.0.1: flat "^5.0.2" wildcard "^2.0.1" -webpack-sources@^3.2.3: - version "3.3.0" - resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-3.3.0.tgz#8d3449f1ed3f254e722a529a0a344a37d2d17048" - integrity sha512-77R0RDmJfj9dyv5p3bM5pOHa+X8/ZkO9c7kpDstigkC4nIDobadsfSGCwB4bKhMVxqAok8tajaoR8rirM7+VFQ== +webpack-sources@^3.3.3: + version "3.3.3" + resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-3.3.3.tgz#d4bf7f9909675d7a070ff14d0ef2a4f3c982c723" + integrity sha512-yd1RBzSGanHkitROoPFd6qsrxt+oFhg/129YzheDGqeustzX0vTZJZsSsQjVQC4yzBQ56K55XU8gaNCtIzOnTg== webpack@^5.88.1, webpack@^5.95.0: - version "5.99.9" - resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.99.9.tgz#d7de799ec17d0cce3c83b70744b4aedb537d8247" - integrity sha512-brOPwM3JnmOa+7kd3NsmOUOwbDAj8FT9xDsG3IW0MgbN9yZV7Oi/s/+MNQ/EcSMqw7qfoRyXPoeEWT8zLVdVGg== + version "5.102.1" + resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.102.1.tgz#1003a3024741a96ba99c37431938bf61aad3d988" + integrity sha512-7h/weGm9d/ywQ6qzJ+Xy+r9n/3qgp/thalBbpOi5i223dPXKi04IBtqPN9nTd+jBc7QKfvDbaBnFipYp4sJAUQ== dependencies: "@types/eslint-scope" "^3.7.7" - "@types/estree" "^1.0.6" + "@types/estree" "^1.0.8" "@types/json-schema" "^7.0.15" "@webassemblyjs/ast" "^1.14.1" "@webassemblyjs/wasm-edit" "^1.14.1" "@webassemblyjs/wasm-parser" "^1.14.1" - acorn "^8.14.0" - browserslist "^4.24.0" + acorn "^8.15.0" + acorn-import-phases "^1.0.3" + browserslist "^4.26.3" chrome-trace-event "^1.0.2" - enhanced-resolve "^5.17.1" + enhanced-resolve "^5.17.3" es-module-lexer "^1.2.1" eslint-scope "5.1.1" events "^3.2.0" @@ -8575,11 +8819,11 @@ webpack@^5.88.1, webpack@^5.95.0: loader-runner "^4.2.0" mime-types "^2.1.27" neo-async "^2.6.2" - schema-utils "^4.3.2" - tapable "^2.1.1" + schema-utils "^4.3.3" + tapable "^2.3.0" terser-webpack-plugin "^5.3.11" - watchpack "^2.4.1" - webpack-sources "^3.2.3" + watchpack "^2.4.4" + webpack-sources "^3.3.3" webpackbar@^6.0.1: version "6.0.1" @@ -8646,11 +8890,6 @@ wrap-ansi@^8.0.1, wrap-ansi@^8.1.0: string-width "^5.0.1" strip-ansi "^7.0.1" -wrappy@1: - version "1.0.2" - resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" - integrity sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ== - write-file-atomic@^3.0.3: version "3.0.3" resolved "https://registry.yarnpkg.com/write-file-atomic/-/write-file-atomic-3.0.3.tgz#56bd5c5a5c70481cd19c571bd39ab965a5de56e8" @@ -8666,10 +8905,17 @@ ws@^7.3.1: resolved "https://registry.yarnpkg.com/ws/-/ws-7.5.10.tgz#58b5c20dc281633f6c19113f39b349bd8bd558d9" integrity sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ== -ws@^8.13.0: - version "8.18.2" - resolved "https://registry.yarnpkg.com/ws/-/ws-8.18.2.tgz#42738b2be57ced85f46154320aabb51ab003705a" - integrity sha512-DMricUmwGZUVr++AEAe2uiVM7UoO9MAVZMDu05UQOaUII0lp+zOzLLU4Xqh/JvTqklB1T4uELaaPBKyjE1r4fQ== +ws@^8.18.0: + version "8.18.3" + resolved "https://registry.yarnpkg.com/ws/-/ws-8.18.3.tgz#b56b88abffde62791c639170400c93dcb0c95472" + integrity sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg== + +wsl-utils@^0.1.0: + version "0.1.0" + resolved "https://registry.yarnpkg.com/wsl-utils/-/wsl-utils-0.1.0.tgz#8783d4df671d4d50365be2ee4c71917a0557baab" + integrity sha512-h3Fbisa2nKGPxCpm89Hk33lBLsnaGBvctQopaBSOW/uIs6FTe1ATyAnKFJrzVs9vpGdsTe73WF3V4lIsk4Gacw== + dependencies: + is-wsl "^3.1.0" xdg-basedir@^5.0.1, xdg-basedir@^5.1.0: version "5.1.0" @@ -8693,6 +8939,11 @@ yocto-queue@^1.0.0: resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-1.2.1.tgz#36d7c4739f775b3cbc28e6136e21aa057adec418" integrity sha512-AyeEbWOu/TAXdxlV9wmGcR0+yh2j3vYPGOECcIj2S7MkrLyC7ne+oye2BKTItt0ii2PHk4cDy+95+LshzbXnGg== +zod@^4.1.8: + version "4.1.12" + resolved "https://registry.yarnpkg.com/zod/-/zod-4.1.12.tgz#64f1ea53d00eab91853195653b5af9eee68970f0" + integrity sha512-JInaHOamG8pt5+Ey8kGmdcAcg3OL9reK8ltczgHTAwNhMys/6ThXHityHxVV2p3fkw/c+MAvBHFVYHFZDmjMCQ== + zwitch@^2.0.0: version "2.0.4" resolved "https://registry.yarnpkg.com/zwitch/-/zwitch-2.0.4.tgz#c827d4b0acb76fc3e685a4c6ec2902d51070e9d7" diff --git a/jest/deps.d.ts b/jest/deps.d.ts index 93d80cc3d6..9f52d9c321 100644 --- a/jest/deps.d.ts +++ b/jest/deps.d.ts @@ -12,8 +12,3 @@ declare module 'to-vfile' { export function read(path: string, encoding?: string): Promise; } - -declare module '@testing-utils/git' { - const createTempRepo: typeof import('./utils/git').createTempRepo; - export {createTempRepo}; -} diff --git a/jest/snapshotPathNormalizer.ts b/jest/snapshotPathNormalizer.ts index a0e9a3f4d3..b8a5ec33ab 100644 --- a/jest/snapshotPathNormalizer.ts +++ b/jest/snapshotPathNormalizer.ts @@ -82,7 +82,7 @@ function normalizePaths(value: T): T { (val) => val.split(cwdReal).join(''), (val) => val.split(cwd).join(''), - // Replace home directory with + // Replace temp directory with (val) => val.split(tempDirReal).join(''), (val) => val.split(tempDir).join(''), diff --git a/jest/utils/git.ts b/jest/utils/git.ts deleted file mode 100644 index 38db021dcc..0000000000 --- a/jest/utils/git.ts +++ /dev/null @@ -1,63 +0,0 @@ -/** - * Copyright (c) Facebook, Inc. and its affiliates. - * - * This source code is licensed under the MIT license found in the - * LICENSE file in the root directory of this source tree. - */ - -import fs from 'fs-extra'; -import os from 'os'; -import path from 'path'; -import shell from 'shelljs'; - -class Git { - constructor(private dir: string) { - const res = shell.exec('git init', {cwd: dir, silent: true}); - if (res.code !== 0) { - throw new Error(`git init exited with code ${res.code}. -stderr: ${res.stderr} -stdout: ${res.stdout}`); - } - // Doesn't matter currently - shell.exec('git config user.email "test@jc-verse.com"', { - cwd: dir, - silent: true, - }); - shell.exec('git config user.name "Test"', {cwd: dir, silent: true}); - - shell.exec('git commit --allow-empty -m "First commit"', { - cwd: dir, - silent: true, - }); - } - commit(msg: string, date: string, author: string): void { - const addRes = shell.exec('git add .', {cwd: this.dir, silent: true}); - const commitRes = shell.exec( - `git commit -m "${msg}" --date "${date}T00:00:00Z" --author "${author}"`, - { - cwd: this.dir, - env: {GIT_COMMITTER_DATE: `${date}T00:00:00Z`}, - silent: true, - }, - ); - if (addRes.code !== 0) { - throw new Error(`git add exited with code ${addRes.code}. -stderr: ${addRes.stderr} -stdout: ${addRes.stdout}`); - } - if (commitRes.code !== 0) { - throw new Error(`git commit exited with code ${commitRes.code}. -stderr: ${commitRes.stderr} -stdout: ${commitRes.stdout}`); - } - } -} - -// This function is sync so the same mock repo can be shared across tests -export function createTempRepo(): {repoDir: string; git: Git} { - const repoDir = fs.mkdtempSync(path.join(os.tmpdir(), 'git-test-repo')); - - const git = new Git(repoDir); - - return {repoDir, git}; -} diff --git a/lerna.json b/lerna.json index 08d375dded..c7dfbb0655 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "3.8.1", + "version": "3.9.2", "npmClient": "yarn", "useWorkspaces": true, "useNx": false, diff --git a/packages/create-docusaurus/package.json b/packages/create-docusaurus/package.json index 7c2ce37e28..a865c1052a 100755 --- a/packages/create-docusaurus/package.json +++ b/packages/create-docusaurus/package.json @@ -1,6 +1,6 @@ { "name": "create-docusaurus", - "version": "3.8.1", + "version": "3.9.2", "description": "Create Docusaurus apps easily.", "type": "module", "repository": { @@ -22,10 +22,10 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "3.8.1", - "@docusaurus/utils": "3.8.1", + "@docusaurus/logger": "3.9.2", + "@docusaurus/utils": "3.9.2", "commander": "^5.1.0", - "execa": "5.1.1", + "execa": "^5.1.1", "fs-extra": "^11.1.1", "lodash": "^4.17.21", "prompts": "^2.4.2", @@ -37,6 +37,6 @@ "@types/supports-color": "^8.1.1" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/create-docusaurus/templates/classic-typescript/package.json b/packages/create-docusaurus/templates/classic-typescript/package.json index 543f44f99b..7d01472f6b 100644 --- a/packages/create-docusaurus/templates/classic-typescript/package.json +++ b/packages/create-docusaurus/templates/classic-typescript/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-2-classic-typescript-template", - "version": "3.8.1", + "version": "3.9.2", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -15,8 +15,8 @@ "typecheck": "tsc" }, "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/preset-classic": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/preset-classic": "3.9.2", "@mdx-js/react": "^3.0.0", "clsx": "^2.0.0", "prism-react-renderer": "^2.3.0", @@ -24,9 +24,9 @@ "react-dom": "^19.0.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.8.1", - "@docusaurus/tsconfig": "3.8.1", - "@docusaurus/types": "3.8.1", + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/tsconfig": "3.9.2", + "@docusaurus/types": "3.9.2", "typescript": "~5.6.2" }, "browserslist": { @@ -42,6 +42,6 @@ ] }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/create-docusaurus/templates/classic/package.json b/packages/create-docusaurus/templates/classic/package.json index 91083729fd..549f25cff3 100644 --- a/packages/create-docusaurus/templates/classic/package.json +++ b/packages/create-docusaurus/templates/classic/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-2-classic-template", - "version": "3.8.1", + "version": "3.9.2", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -14,8 +14,8 @@ "write-heading-ids": "docusaurus write-heading-ids" }, "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/preset-classic": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/preset-classic": "3.9.2", "@mdx-js/react": "^3.0.0", "clsx": "^2.0.0", "prism-react-renderer": "^2.3.0", @@ -23,8 +23,8 @@ "react-dom": "^19.0.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.8.1", - "@docusaurus/types": "3.8.1" + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/types": "3.9.2" }, "browserslist": { "production": [ @@ -39,6 +39,6 @@ ] }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/create-docusaurus/templates/shared/docs/intro.md b/packages/create-docusaurus/templates/shared/docs/intro.md index 45e8604c8b..88f9571445 100644 --- a/packages/create-docusaurus/templates/shared/docs/intro.md +++ b/packages/create-docusaurus/templates/shared/docs/intro.md @@ -14,7 +14,7 @@ Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new ### What you'll need -- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: +- [Node.js](https://nodejs.org/en/download/) version 20.0 or above: - When installing Node.js, you are recommended to check all checkboxes related to dependencies. ## Generate a new site diff --git a/packages/docusaurus-babel/package.json b/packages/docusaurus-babel/package.json index 1c111b7c8b..2da7cef99c 100644 --- a/packages/docusaurus-babel/package.json +++ b/packages/docusaurus-babel/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/babel", - "version": "3.8.1", + "version": "3.9.2", "description": "Docusaurus package for Babel-related utils.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -36,15 +36,14 @@ "@babel/preset-react": "^7.25.9", "@babel/preset-typescript": "^7.25.9", "@babel/runtime": "^7.25.9", - "@babel/runtime-corejs3": "^7.25.9", "@babel/traverse": "^7.25.9", - "@docusaurus/logger": "3.8.1", - "@docusaurus/utils": "3.8.1", + "@docusaurus/logger": "3.9.2", + "@docusaurus/utils": "3.9.2", "babel-plugin-dynamic-import-node": "^2.3.3", "fs-extra": "^11.1.1", "tslib": "^2.6.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-bundler/package.json b/packages/docusaurus-bundler/package.json index 6b6e252cdf..3798532573 100644 --- a/packages/docusaurus-bundler/package.json +++ b/packages/docusaurus-bundler/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/bundler", - "version": "3.8.1", + "version": "3.9.2", "description": "Docusaurus util package to abstract the current bundler.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -19,11 +19,11 @@ "license": "MIT", "dependencies": { "@babel/core": "^7.25.9", - "@docusaurus/babel": "3.8.1", - "@docusaurus/cssnano-preset": "3.8.1", - "@docusaurus/logger": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils": "3.8.1", + "@docusaurus/babel": "3.9.2", + "@docusaurus/cssnano-preset": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", "babel-loader": "^9.2.1", "clean-css": "^5.3.3", "copy-webpack-plugin": "^11.0.0", @@ -55,6 +55,6 @@ "@total-typescript/shoehorn": "^0.1.2" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-bundler/src/loaders/jsLoader.ts b/packages/docusaurus-bundler/src/loaders/jsLoader.ts index 6f9213454d..51d749ce64 100644 --- a/packages/docusaurus-bundler/src/loaders/jsLoader.ts +++ b/packages/docusaurus-bundler/src/loaders/jsLoader.ts @@ -28,7 +28,7 @@ async function createSwcJsLoaderFactory(): Promise< return ({isServer}) => { return { loader, - options: getOptions({isServer}), + options: getOptions({isServer, bundlerName: 'webpack'}), }; }; } @@ -42,7 +42,7 @@ async function createRspackSwcJsLoaderFactory(): Promise< return ({isServer}) => { return { loader, - options: getOptions({isServer}), + options: getOptions({isServer, bundlerName: 'rspack'}), }; }; } diff --git a/packages/docusaurus-bundler/src/minification.ts b/packages/docusaurus-bundler/src/minification.ts index 0c4d2d8dde..a06b81c988 100644 --- a/packages/docusaurus-bundler/src/minification.ts +++ b/packages/docusaurus-bundler/src/minification.ts @@ -142,7 +142,10 @@ async function getRspackMinimizers({ }: MinimizersConfig): Promise { const rspack = getCurrentBundlerAsRspack({currentBundler}); const getBrowserslistQueries = await importGetBrowserslistQueries(); - const browserslistQueries = getBrowserslistQueries({isServer: false}); + const browserslistQueries = getBrowserslistQueries({ + isServer: false, + bundlerName: 'rspack', + }); const swcJsMinimizerOptions = await importSwcJsMinimizerOptions(); return [ // See https://rspack.dev/plugins/rspack/swc-js-minimizer-rspack-plugin diff --git a/packages/docusaurus-bundler/src/minifyHtml.ts b/packages/docusaurus-bundler/src/minifyHtml.ts index d9dc29135f..8c564986f8 100644 --- a/packages/docusaurus-bundler/src/minifyHtml.ts +++ b/packages/docusaurus-bundler/src/minifyHtml.ts @@ -84,6 +84,10 @@ async function getSwcMinifier(): Promise { // TODO maybe it's fine to only keep React comments? preserveComments: [], + // Keep tag: important for social image crawlers like LinkedIn + // See https://github.com/swc-project/swc/issues/10994 + tagOmission: 'keep-head-and-body', + // Sorting these attributes (class) can lead to React hydration errors sortSpaceSeparatedAttributeValues: false, sortAttributes: false, diff --git a/packages/docusaurus-cssnano-preset/package.json b/packages/docusaurus-cssnano-preset/package.json index d4d8fbacd1..9b8cd87176 100644 --- a/packages/docusaurus-cssnano-preset/package.json +++ b/packages/docusaurus-cssnano-preset/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/cssnano-preset", - "version": "3.8.1", + "version": "3.9.2", "description": "Advanced cssnano preset for maximum optimization.", "main": "lib/index.js", "license": "MIT", @@ -26,6 +26,6 @@ "to-vfile": "^6.1.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-cssnano-preset/src/index.ts b/packages/docusaurus-cssnano-preset/src/index.ts index bdb0a37ad5..c3f4927d9f 100644 --- a/packages/docusaurus-cssnano-preset/src/index.ts +++ b/packages/docusaurus-cssnano-preset/src/index.ts @@ -13,6 +13,9 @@ const preset: typeof advancedBasePreset = function preset(opts) { const advancedPreset = advancedBasePreset({ autoprefixer: {add: false}, discardComments: {removeAll: true}, + // See CodeBlock custom line number bug: https://github.com/facebook/docusaurus/pull/11487 + /* cSpell:ignore Idents */ + reduceIdents: {counter: false}, /* cSpell:ignore zindex */ zindex: false, ...opts, diff --git a/packages/docusaurus-faster/package.json b/packages/docusaurus-faster/package.json index 0fe018b679..23c119d216 100644 --- a/packages/docusaurus-faster/package.json +++ b/packages/docusaurus-faster/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/faster", - "version": "3.8.1", + "version": "3.9.2", "description": "Docusaurus experimental package exposing new modern dependencies to make the build faster.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -18,18 +18,19 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/types": "3.8.1", - "@rspack/core": "^1.4.0", + "@docusaurus/types": "3.9.2", + "@rspack/core": "^1.5.0", "@swc/core": "^1.7.39", - "@swc/html": "^1.7.39", + "@swc/html": "^1.13.5", "browserslist": "^4.24.2", "lightningcss": "^1.27.0", + "semver": "^7.5.4", "swc-loader": "^0.2.6", "tslib": "^2.6.0", "webpack": "^5.95.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" }, "peerDependencies": { "@docusaurus/types": "*" diff --git a/packages/docusaurus-faster/src/index.ts b/packages/docusaurus-faster/src/index.ts index cba2c68730..27cc387a7a 100644 --- a/packages/docusaurus-faster/src/index.ts +++ b/packages/docusaurus-faster/src/index.ts @@ -9,18 +9,22 @@ import Rspack from '@rspack/core'; import * as lightningcss from 'lightningcss'; import browserslist from 'browserslist'; import {minify as swcHtmlMinifier} from '@swc/html'; +import semver from 'semver'; import type {JsMinifyOptions, Options as SwcOptions} from '@swc/core'; +import type {CurrentBundler} from '@docusaurus/types'; export const swcLoader = require.resolve('swc-loader'); export const getSwcLoaderOptions = ({ isServer, + bundlerName, }: { isServer: boolean; + bundlerName: CurrentBundler['name']; }): SwcOptions => { return { env: { - targets: getBrowserslistQueries({isServer}), + targets: getBrowserslistQueries({isServer, bundlerName}), }, jsc: { parser: { @@ -63,20 +67,53 @@ export function getSwcJsMinimizerOptions(): JsMinifyOptions { }; } +// TODO this is not accurate +// for Rspack we should read from the built-in browserslist data +// see https://github.com/facebook/docusaurus/pull/11496 +function getLastBrowserslistKnownNodeVersion( + bundlerName: CurrentBundler['name'], +): string { + if (bundlerName === 'rspack') { + // TODO hardcoded value until Rspack exposes its Browserslist data + // see https://github.com/facebook/docusaurus/pull/11496 + return '22.0.0'; + } + // browserslist('last 1 node versions')[0]!.replace('node ', '') + return browserslist.nodeVersions.at(-1)!; +} + +function getMinVersion(v1: string, v2: string): string { + return semver.lt(v1, v2) ? v1 : v2; +} + // We need this because of Rspack built-in LightningCSS integration // See https://github.com/orgs/browserslist/discussions/846 export function getBrowserslistQueries({ isServer, + bundlerName, }: { isServer: boolean; + bundlerName: CurrentBundler['name']; }): string[] { if (isServer) { - return [`node ${process.versions.node}`]; + // Escape hatch env variable + if (process.env.DOCUSAURUS_SERVER_NODE_TARGET) { + return [`node ${process.env.DOCUSAURUS_SERVER_NODE_TARGET}`]; + } + // For server builds, we want to use the current Node version as target + // But we can't pass a target that Browserslist doesn't know about yet + const nodeTarget = getMinVersion( + process.versions.node, + getLastBrowserslistKnownNodeVersion(bundlerName), + ); + + return [`node ${nodeTarget}`]; } const queries = browserslist.loadConfig({path: process.cwd()}) ?? [ ...browserslist.defaults, ]; + return queries; } diff --git a/packages/docusaurus-logger/package.json b/packages/docusaurus-logger/package.json index 14a58f1009..5f4690b97f 100644 --- a/packages/docusaurus-logger/package.json +++ b/packages/docusaurus-logger/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/logger", - "version": "3.8.1", + "version": "3.9.2", "description": "An encapsulated logger for semantically formatting console messages.", "main": "./lib/index.js", "repository": { @@ -24,7 +24,7 @@ "tslib": "^2.6.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" }, "devDependencies": { "@types/supports-color": "^8.1.1" diff --git a/packages/docusaurus-mdx-loader/package.json b/packages/docusaurus-mdx-loader/package.json index 46ba90b8bc..14bc8a52dc 100644 --- a/packages/docusaurus-mdx-loader/package.json +++ b/packages/docusaurus-mdx-loader/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/mdx-loader", - "version": "3.8.1", + "version": "3.9.2", "description": "Docusaurus Loader for MDX", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,9 +18,9 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/logger": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "@mdx-js/mdx": "^3.0.0", "@slorber/remark-comment": "^1.0.0", "escape-html": "^1.0.3", @@ -44,7 +44,7 @@ "webpack": "^5.88.1" }, "devDependencies": { - "@docusaurus/types": "3.8.1", + "@docusaurus/types": "3.9.2", "@types/escape-html": "^1.0.2", "@types/mdast": "^4.0.2", "@types/stringify-object": "^3.3.1", @@ -62,6 +62,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-mdx-loader/src/remark/transformImage/index.ts b/packages/docusaurus-mdx-loader/src/remark/transformImage/index.ts index 1dc00aa894..ff88403eef 100644 --- a/packages/docusaurus-mdx-loader/src/remark/transformImage/index.ts +++ b/packages/docusaurus-mdx-loader/src/remark/transformImage/index.ts @@ -6,7 +6,6 @@ */ import path from 'path'; -import url from 'url'; import fs from 'fs-extra'; import { toMessageRelativeFilePath, @@ -15,6 +14,7 @@ import { findAsyncSequential, getFileLoaderUtils, parseURLOrPath, + parseLocalURLPath, } from '@docusaurus/utils'; import escapeHtml from 'escape-html'; import {imageSizeFromFile} from 'image-size/fromFile'; @@ -207,11 +207,11 @@ async function processImageNode(target: Target, context: Context) { return; } - const parsedUrl = url.parse(node.url); - if (parsedUrl.protocol || !parsedUrl.pathname) { - // pathname:// is an escape hatch, in case user does not want her images to + const localUrlPath = parseLocalURLPath(node.url); + if (!localUrlPath) { + // pathname:// is an escape hatch, in case the user does not want images to // be converted to require calls going through webpack loader - if (parsedUrl.protocol === 'pathname:') { + if (parseURLOrPath(node.url).protocol === 'pathname:') { node.url = node.url.replace('pathname://', ''); } return; @@ -220,7 +220,7 @@ async function processImageNode(target: Target, context: Context) { // We decode it first because Node Url.pathname is always encoded // while the image file-system path are not. // See https://github.com/facebook/docusaurus/discussions/10720 - const decodedPathname = decodeURIComponent(parsedUrl.pathname); + const decodedPathname = decodeURIComponent(localUrlPath.pathname); // We try to convert image urls without protocol to images with require calls // going through webpack ensures that image assets exist at build time diff --git a/packages/docusaurus-mdx-loader/src/remark/transformLinks/index.ts b/packages/docusaurus-mdx-loader/src/remark/transformLinks/index.ts index 5d2d2d2d95..192c1e9f8c 100644 --- a/packages/docusaurus-mdx-loader/src/remark/transformLinks/index.ts +++ b/packages/docusaurus-mdx-loader/src/remark/transformLinks/index.ts @@ -6,7 +6,6 @@ */ import path from 'path'; -import url from 'url'; import fs from 'fs-extra'; import { toMessageRelativeFilePath, @@ -15,6 +14,7 @@ import { findAsyncSequential, getFileLoaderUtils, parseURLOrPath, + parseLocalURLPath, } from '@docusaurus/utils'; import escapeHtml from 'escape-html'; import logger from '@docusaurus/logger'; @@ -209,21 +209,22 @@ async function processLinkNode(target: Target, context: Context) { return; } - const parsedUrl = url.parse(node.url); - if (parsedUrl.protocol || !parsedUrl.pathname) { + const localUrlPath = parseLocalURLPath(node.url); + if (!localUrlPath) { // Don't process pathname:// here, it's used by the component return; } - const hasSiteAlias = parsedUrl.pathname.startsWith('@site/'); + + const hasSiteAlias = localUrlPath.pathname.startsWith('@site/'); const hasAssetLikeExtension = - path.extname(parsedUrl.pathname) && - !parsedUrl.pathname.match(/\.(?:mdx?|html)(?:#|$)/); + path.extname(localUrlPath.pathname) && + !localUrlPath.pathname.match(/\.(?:mdx?|html)(?:#|$)/); if (!hasSiteAlias && !hasAssetLikeExtension) { return; } const localFilePath = await getLocalFileAbsolutePath( - decodeURIComponent(parsedUrl.pathname), + decodeURIComponent(localUrlPath.pathname), context, ); diff --git a/packages/docusaurus-module-type-aliases/package.json b/packages/docusaurus-module-type-aliases/package.json index 7ea74490b1..3ae5315760 100644 --- a/packages/docusaurus-module-type-aliases/package.json +++ b/packages/docusaurus-module-type-aliases/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/module-type-aliases", - "version": "3.8.1", + "version": "3.9.2", "description": "Docusaurus module type aliases.", "types": "./src/index.d.ts", "publishConfig": { @@ -12,7 +12,7 @@ "directory": "packages/docusaurus-module-type-aliases" }, "dependencies": { - "@docusaurus/types": "3.8.1", + "@docusaurus/types": "3.9.2", "@types/history": "^4.7.11", "@types/react": "*", "@types/react-router-config": "*", diff --git a/packages/docusaurus-plugin-client-redirects/package.json b/packages/docusaurus-plugin-client-redirects/package.json index 7dcee5be1f..754f8a050a 100644 --- a/packages/docusaurus-plugin-client-redirects/package.json +++ b/packages/docusaurus-plugin-client-redirects/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-client-redirects", - "version": "3.8.1", + "version": "3.9.2", "description": "Client redirects plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,24 +18,24 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/logger": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-common": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "eta": "^2.2.0", "fs-extra": "^11.1.1", "lodash": "^4.17.21", "tslib": "^2.6.0" }, "devDependencies": { - "@docusaurus/types": "3.8.1" + "@docusaurus/types": "3.9.2" }, "peerDependencies": { "react": "^18.0.0 || ^19.0.0", "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-plugin-content-blog/package.json b/packages/docusaurus-plugin-content-blog/package.json index 615ce75013..b3443bb34b 100644 --- a/packages/docusaurus-plugin-content-blog/package.json +++ b/packages/docusaurus-plugin-content-blog/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-content-blog", - "version": "3.8.1", + "version": "3.9.2", "description": "Blog plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-content-blog.d.ts", @@ -31,14 +31,14 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/logger": "3.8.1", - "@docusaurus/mdx-loader": "3.8.1", - "@docusaurus/theme-common": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-common": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "cheerio": "1.0.0-rc.12", "feed": "^4.2.2", "fs-extra": "^11.1.1", @@ -56,7 +56,7 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" }, "devDependencies": { "@total-typescript/shoehorn": "^0.1.2", diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/routes.test.ts.snap b/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/routes.test.ts.snap new file mode 100644 index 0000000000..d7a20602dd --- /dev/null +++ b/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/routes.test.ts.snap @@ -0,0 +1,637 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`buildAllRoutes works for realistic blog post 2`] = ` +[ + { + "component": "@theme/BlogPostPage", + "context": { + "blogMetadata": "@aliased/data/blogMetadata-default.json", + }, + "exact": true, + "metadata": { + "lastUpdatedAt": undefined, + "sourceFilePath": "blog/post1.md", + }, + "modules": { + "content": "@site/blog/post1.md", + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog/post1", + }, + { + "component": "@theme/BlogPostPage", + "context": { + "blogMetadata": "@aliased/data/blogMetadata-default.json", + }, + "exact": true, + "metadata": { + "lastUpdatedAt": undefined, + "sourceFilePath": "blog/post2.md", + }, + "modules": { + "content": "@site/blog/post2.md", + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog/post2", + }, + { + "component": "@theme/BlogPostPage", + "context": { + "blogMetadata": "@aliased/data/blogMetadata-default.json", + }, + "exact": true, + "metadata": { + "lastUpdatedAt": undefined, + "sourceFilePath": "blog/post3.md", + }, + "modules": { + "content": "@site/blog/post3.md", + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog/post3", + }, + { + "component": "@theme/BlogPostPage", + "context": { + "blogMetadata": "@aliased/data/blogMetadata-default.json", + }, + "exact": true, + "metadata": { + "lastUpdatedAt": undefined, + "sourceFilePath": "blog/post4.md", + }, + "modules": { + "content": "@site/blog/post4.md", + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog/post4", + }, + { + "component": "@theme/BlogPostPage", + "context": { + "blogMetadata": "@aliased/data/blogMetadata-default.json", + }, + "exact": true, + "metadata": { + "lastUpdatedAt": undefined, + "sourceFilePath": "blog/post5.md", + }, + "modules": { + "content": "@site/blog/post5.md", + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog/post5", + }, + { + "component": "@theme/BlogPostPage", + "context": { + "blogMetadata": "@aliased/data/blogMetadata-default.json", + }, + "exact": true, + "metadata": { + "lastUpdatedAt": undefined, + "sourceFilePath": "blog/post6.md", + }, + "modules": { + "content": "@site/blog/post6.md", + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog/post6", + }, + { + "component": "@theme/BlogListPage", + "exact": true, + "modules": { + "items": [ + { + "content": { + "__import": true, + "path": "@site/blog/post1.md", + "query": { + "truncated": true, + }, + }, + }, + { + "content": { + "__import": true, + "path": "@site/blog/post2.md", + "query": { + "truncated": true, + }, + }, + }, + ], + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog", + "props": { + "metadata": { + "blogDescription": "Custom blog description", + "blogTitle": "Custom blog title", + "nextPage": "/blog/page/2", + "page": 1, + "permalink": "/blog", + "postsPerPage": 2, + "previousPage": undefined, + "totalCount": 5, + "totalPages": 3, + }, + }, + }, + { + "component": "@theme/BlogListPage", + "exact": true, + "modules": { + "items": [ + { + "content": { + "__import": true, + "path": "@site/blog/post4.md", + "query": { + "truncated": true, + }, + }, + }, + { + "content": { + "__import": true, + "path": "@site/blog/post5.md", + "query": { + "truncated": true, + }, + }, + }, + ], + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog/page/2", + "props": { + "metadata": { + "blogDescription": "Custom blog description", + "blogTitle": "Custom blog title", + "nextPage": "/blog/page/3", + "page": 2, + "permalink": "/blog/page/2", + "postsPerPage": 2, + "previousPage": "/blog", + "totalCount": 5, + "totalPages": 3, + }, + }, + }, + { + "component": "@theme/BlogListPage", + "exact": true, + "modules": { + "items": [ + { + "content": { + "__import": true, + "path": "@site/blog/post6.md", + "query": { + "truncated": true, + }, + }, + }, + ], + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog/page/3", + "props": { + "metadata": { + "blogDescription": "Custom blog description", + "blogTitle": "Custom blog title", + "nextPage": undefined, + "page": 3, + "permalink": "/blog/page/3", + "postsPerPage": 2, + "previousPage": "/blog/page/2", + "totalCount": 5, + "totalPages": 3, + }, + }, + }, + { + "component": "@theme/BlogArchivePage", + "exact": true, + "path": "/blog/archive", + "props": { + "archive": { + "blogPosts": [ + { + "content": "Content for post1", + "id": "post1", + "metadata": { + "authors": [ + { + "key": "author1", + }, + ], + "date": 2020-01-01T00:00:00.000Z, + "description": "Description for post1", + "frontMatter": {}, + "permalink": "/blog/post1", + "readingTime": 2, + "source": "@site/blog/post1.md", + "tags": [], + "title": "Title for post1", + }, + }, + { + "content": "Content for post2", + "id": "post2", + "metadata": { + "authors": [ + { + "key": "author1", + }, + ], + "date": 2020-01-01T00:00:00.000Z, + "description": "Description for post2", + "frontMatter": {}, + "permalink": "/blog/post2", + "readingTime": 2, + "source": "@site/blog/post2.md", + "tags": [], + "title": "Title for post2", + }, + }, + { + "content": "Content for post4", + "id": "post4", + "metadata": { + "authors": [ + { + "key": "author1", + }, + { + "key": "author2", + }, + ], + "date": 2020-01-01T00:00:00.000Z, + "description": "Description for post4", + "frontMatter": {}, + "permalink": "/blog/post4", + "readingTime": 2, + "source": "@site/blog/post4.md", + "tags": [], + "title": "Title for post4", + }, + }, + { + "content": "Content for post5", + "id": "post5", + "metadata": { + "authors": [ + { + "key": "author2", + }, + { + "key": "author3", + }, + ], + "date": 2020-01-01T00:00:00.000Z, + "description": "Description for post5", + "frontMatter": {}, + "permalink": "/blog/post5", + "readingTime": 2, + "source": "@site/blog/post5.md", + "tags": [], + "title": "Title for post5", + }, + }, + { + "content": "Content for post6", + "id": "post6", + "metadata": { + "authors": [], + "date": 2020-01-01T00:00:00.000Z, + "description": "Description for post6", + "frontMatter": {}, + "permalink": "/blog/post6", + "readingTime": 2, + "source": "@site/blog/post6.md", + "tags": [], + "title": "Title for post6", + }, + }, + ], + }, + }, + }, + { + "component": "@theme/Blog/Pages/BlogAuthorsListPage", + "context": { + "blogMetadata": "@aliased/data/blogMetadata-default.json", + }, + "exact": true, + "modules": { + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog/authors", + "props": { + "authors": [ + { + "count": 3, + "key": "author1", + "name": "Author 1", + "page": { + "permalink": "/blog/authors/author1", + }, + }, + { + "count": 2, + "key": "author2", + "name": "Author 2", + "page": null, + }, + { + "count": 1, + "key": "author3", + "name": "Author 3", + "page": { + "permalink": "/blog/authors/author3", + }, + }, + ], + }, + }, + { + "component": "@theme/Blog/Pages/BlogAuthorsPostsPage", + "context": { + "blogMetadata": "@aliased/data/blogMetadata-default.json", + }, + "exact": true, + "modules": { + "items": [ + { + "content": { + "__import": true, + "path": "@site/blog/post1.md", + "query": { + "truncated": true, + }, + }, + }, + { + "content": { + "__import": true, + "path": "@site/blog/post2.md", + "query": { + "truncated": true, + }, + }, + }, + ], + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog/authors/author1", + "props": { + "author": { + "count": 3, + "key": "author1", + "name": "Author 1", + "page": { + "permalink": "/blog/authors/author1", + }, + }, + "listMetadata": { + "blogDescription": "Custom blog description", + "blogTitle": "Custom blog title", + "nextPage": "/blog/authors/author1/page/2", + "page": 1, + "permalink": "/blog/authors/author1", + "postsPerPage": 2, + "previousPage": undefined, + "totalCount": 3, + "totalPages": 2, + }, + }, + }, + { + "component": "@theme/Blog/Pages/BlogAuthorsPostsPage", + "context": { + "blogMetadata": "@aliased/data/blogMetadata-default.json", + }, + "exact": true, + "modules": { + "items": [ + { + "content": { + "__import": true, + "path": "@site/blog/post4.md", + "query": { + "truncated": true, + }, + }, + }, + ], + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog/authors/author1/page/2", + "props": { + "author": { + "count": 3, + "key": "author1", + "name": "Author 1", + "page": { + "permalink": "/blog/authors/author1", + }, + }, + "listMetadata": { + "blogDescription": "Custom blog description", + "blogTitle": "Custom blog title", + "nextPage": undefined, + "page": 2, + "permalink": "/blog/authors/author1/page/2", + "postsPerPage": 2, + "previousPage": "/blog/authors/author1", + "totalCount": 3, + "totalPages": 2, + }, + }, + }, + { + "component": "@theme/Blog/Pages/BlogAuthorsPostsPage", + "context": { + "blogMetadata": "@aliased/data/blogMetadata-default.json", + }, + "exact": true, + "modules": { + "items": [ + { + "content": { + "__import": true, + "path": "@site/blog/post5.md", + "query": { + "truncated": true, + }, + }, + }, + ], + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog/authors/author3", + "props": { + "author": { + "count": 1, + "key": "author3", + "name": "Author 3", + "page": { + "permalink": "/blog/authors/author3", + }, + }, + "listMetadata": { + "blogDescription": "Custom blog description", + "blogTitle": "Custom blog title", + "nextPage": undefined, + "page": 1, + "permalink": "/blog/authors/author3", + "postsPerPage": 2, + "previousPage": undefined, + "totalCount": 1, + "totalPages": 1, + }, + }, + }, +] +`; + +exports[`buildAllRoutes works for realistic blog post 3`] = ` +{ + "blog-post-list-prop-default.json": { + "items": [ + { + "date": 2020-01-01T00:00:00.000Z, + "permalink": "/blog/post1", + "title": "Title for post1", + "unlisted": undefined, + }, + { + "date": 2020-01-01T00:00:00.000Z, + "permalink": "/blog/post2", + "title": "Title for post2", + "unlisted": undefined, + }, + { + "date": 2020-01-01T00:00:00.000Z, + "permalink": "/blog/post3", + "title": "Title for post3", + "unlisted": true, + }, + { + "date": 2020-01-01T00:00:00.000Z, + "permalink": "/blog/post4", + "title": "Title for post4", + "unlisted": undefined, + }, + { + "date": 2020-01-01T00:00:00.000Z, + "permalink": "/blog/post5", + "title": "Title for post5", + "unlisted": undefined, + }, + ], + "title": "Custom blog sidebar title", + }, + "blogMetadata-default.json": { + "authorsListPath": "/blog/authors", + "blogBasePath": "/blog", + "blogTitle": "Custom blog title", + }, + "site-blog-post-1-md-235.json": { + "authors": [ + { + "key": "author1", + }, + ], + "date": 2020-01-01T00:00:00.000Z, + "description": "Description for post1", + "frontMatter": {}, + "permalink": "/blog/post1", + "readingTime": 2, + "source": "@site/blog/post1.md", + "tags": [], + "title": "Title for post1", + }, + "site-blog-post-2-md-b42.json": { + "authors": [ + { + "key": "author1", + }, + ], + "date": 2020-01-01T00:00:00.000Z, + "description": "Description for post2", + "frontMatter": {}, + "permalink": "/blog/post2", + "readingTime": 2, + "source": "@site/blog/post2.md", + "tags": [], + "title": "Title for post2", + }, + "site-blog-post-3-md-3b7.json": { + "authors": [ + { + "key": "author3", + }, + ], + "date": 2020-01-01T00:00:00.000Z, + "description": "Description for post3", + "frontMatter": {}, + "permalink": "/blog/post3", + "readingTime": 2, + "source": "@site/blog/post3.md", + "tags": [], + "title": "Title for post3", + "unlisted": true, + }, + "site-blog-post-4-md-15a.json": { + "authors": [ + { + "key": "author1", + }, + { + "key": "author2", + }, + ], + "date": 2020-01-01T00:00:00.000Z, + "description": "Description for post4", + "frontMatter": {}, + "permalink": "/blog/post4", + "readingTime": 2, + "source": "@site/blog/post4.md", + "tags": [], + "title": "Title for post4", + }, + "site-blog-post-5-md-274.json": { + "authors": [ + { + "key": "author2", + }, + { + "key": "author3", + }, + ], + "date": 2020-01-01T00:00:00.000Z, + "description": "Description for post5", + "frontMatter": {}, + "permalink": "/blog/post5", + "readingTime": 2, + "source": "@site/blog/post5.md", + "tags": [], + "title": "Title for post5", + }, + "site-blog-post-6-md-3ca.json": { + "authors": [], + "date": 2020-01-01T00:00:00.000Z, + "description": "Description for post6", + "frontMatter": {}, + "permalink": "/blog/post6", + "readingTime": 2, + "source": "@site/blog/post6.md", + "tags": [], + "title": "Title for post6", + }, +} +`; diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/translations.test.ts.snap b/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/translations.test.ts.snap index ecb579574d..f2eccf4d82 100644 --- a/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/translations.test.ts.snap +++ b/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/translations.test.ts.snap @@ -24,24 +24,7 @@ exports[`getContentTranslationFiles returns translation files matching snapshot exports[`translateContent falls back when translation is incomplete 1`] = ` { - "blogListPaginated": [ - { - "items": [ - "hello", - ], - "metadata": { - "blogDescription": "Someone's random blog", - "blogTitle": "My blog", - "nextPage": undefined, - "page": 1, - "permalink": "/", - "postsPerPage": 10, - "previousPage": undefined, - "totalCount": 1, - "totalPages": 1, - }, - }, - ], + "blogDescription": "Someone's random blog", "blogPosts": [ { "content": "", @@ -63,29 +46,13 @@ exports[`translateContent falls back when translation is incomplete 1`] = ` "blogSidebarTitle": "All my posts", "blogTags": {}, "blogTagsListPath": "/tags", + "blogTitle": "My blog", } `; exports[`translateContent returns translated loaded 1`] = ` { - "blogListPaginated": [ - { - "items": [ - "hello", - ], - "metadata": { - "blogDescription": "Someone's random blog (translated)", - "blogTitle": "My blog (translated)", - "nextPage": undefined, - "page": 1, - "permalink": "/", - "postsPerPage": 10, - "previousPage": undefined, - "totalCount": 1, - "totalPages": 1, - }, - }, - ], + "blogDescription": "Someone's random blog (translated)", "blogPosts": [ { "content": "", @@ -107,5 +74,6 @@ exports[`translateContent returns translated loaded 1`] = ` "blogSidebarTitle": "All my posts (translated)", "blogTags": {}, "blogTagsListPath": "/tags", + "blogTitle": "My blog (translated)", } `; diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/authorsSocials.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/authorsSocials.test.ts index 9bc8afaf2c..ecbc3ea12a 100644 --- a/packages/docusaurus-plugin-content-blog/src/__tests__/authorsSocials.test.ts +++ b/packages/docusaurus-plugin-content-blog/src/__tests__/authorsSocials.test.ts @@ -21,11 +21,13 @@ describe('normalizeSocials', () => { twitch: 'gingergeek', youtube: 'gingergeekuk', mastodon: 'Mastodon', + email: 'seb@example.com', }; expect(normalizeSocials(socials)).toMatchInlineSnapshot(` { "bluesky": "https://bsky.app/profile/gingergeek.co.uk", + "email": "mailto:seb@example.com", "github": "https://github.com/ozakione", "instagram": "https://www.instagram.com/thisweekinreact", "linkedin": "https://www.linkedin.com/in/ozakione/", @@ -48,11 +50,13 @@ describe('normalizeSocials', () => { instaGRam: 'thisweekinreact', BLUESKY: 'gingergeek.co.uk', tHrEaDs: 'gingergeekuk', + eMAil: 'seb@example.com', }; expect(normalizeSocials(socials)).toMatchInlineSnapshot(` { "bluesky": "https://bsky.app/profile/gingergeek.co.uk", + "email": "mailto:seb@example.com", "github": "https://github.com/ozakione", "instagram": "https://www.instagram.com/thisweekinreact", "linkedin": "https://www.linkedin.com/in/ozakione/", @@ -69,6 +73,7 @@ describe('normalizeSocials', () => { linkedin: 'https://linkedin.com/ozakione', github: 'https://github.com/ozakione', stackoverflow: 'https://stackoverflow.com/ozakione', + email: 'mailto:seb@example.com', }; expect(normalizeSocials(socials)).toEqual(socials); @@ -81,10 +86,12 @@ describe('normalizeSocials', () => { github: 'https://github.com/ozakione', stackoverflow: 'https://stackoverflow.com/ozakione', mastodon: 'https://hachyderm.io/@hachyderm', + email: 'mailto:seb@example.com', }; expect(normalizeSocials(socials)).toMatchInlineSnapshot(` { + "email": "mailto:seb@example.com", "github": "https://github.com/ozakione", "linkedin": "https://www.linkedin.com/in/ozakione/", "mastodon": "https://hachyderm.io/@hachyderm", diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/feed.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/feed.test.ts index 7241282e1d..b4f26041b3 100644 --- a/packages/docusaurus-plugin-content-blog/src/__tests__/feed.test.ts +++ b/packages/docusaurus-plugin-content-blog/src/__tests__/feed.test.ts @@ -8,7 +8,10 @@ import {jest} from '@jest/globals'; import path from 'path'; import fs from 'fs-extra'; -import {DEFAULT_PARSE_FRONT_MATTER} from '@docusaurus/utils'; +import { + DEFAULT_PARSE_FRONT_MATTER, + DEFAULT_VCS_CONFIG, +} from '@docusaurus/utils'; import {fromPartial} from '@total-typescript/shoehorn'; import {normalizePluginOptions} from '@docusaurus/utils-validation'; import tree from 'tree-node-cli'; @@ -51,7 +54,7 @@ function getBlogContentPaths(siteDir: string): BlogContentPaths { } async function testGenerateFeeds( - context: LoadContext, + contextInput: LoadContext, optionsInput: Options, ): Promise { const options = validateOptions({ @@ -62,6 +65,17 @@ async function testGenerateFeeds( options: optionsInput, }); + const context: LoadContext = { + ...contextInput, + siteConfig: { + ...contextInput.siteConfig, + future: { + ...contextInput.siteConfig?.future, + experimental_vcs: DEFAULT_VCS_CONFIG, + }, + }, + }; + const contentPaths = getBlogContentPaths(context.siteDir); const authorsMap = await getAuthorsMap({ contentPaths, diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts index cfa1b0c9b5..92a83d5781 100644 --- a/packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts +++ b/packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts @@ -8,12 +8,7 @@ import {jest} from '@jest/globals'; import * as path from 'path'; import {normalizePluginOptions} from '@docusaurus/utils-validation'; -import { - posixPath, - getFileCommitDate, - LAST_UPDATE_FALLBACK, - getLocaleConfig, -} from '@docusaurus/utils'; +import {posixPath, getLocaleConfig, TEST_VCS} from '@docusaurus/utils'; import {DEFAULT_FUTURE_CONFIG} from '@docusaurus/core/src/server/configValidation'; import pluginContentBlog from '../index'; import {validateOptions} from '../options'; @@ -32,6 +27,10 @@ import type { EditUrlFunction, } from '@docusaurus/plugin-content-blog'; +async function getFileCreationDate(filePath: string): Promise { + return new Date((await TEST_VCS.getFileCreationInfo(filePath)).timestamp); +} + const markdown: MarkdownConfig = { format: 'mdx', mermaid: true, @@ -561,9 +560,7 @@ describe('blog plugin', () => { const blogPosts = await getBlogPosts(siteDir); const noDateSource = path.posix.join('@site', PluginPath, 'no date.md'); const noDateSourceFile = path.posix.join(siteDir, PluginPath, 'no date.md'); - // We know the file exists and we know we have git - const result = await getFileCommitDate(noDateSourceFile, {age: 'oldest'}); - const noDateSourceTime = result.date; + const noDateSourceTime = await getFileCreationDate(noDateSourceFile); expect({ ...getByTitle(blogPosts, 'no date').metadata, @@ -641,10 +638,7 @@ describe('blog plugin', () => { }, DefaultI18N, ); - const {blogPosts, blogTags, blogListPaginated} = - (await plugin.loadContent!())!; - - expect(blogListPaginated).toHaveLength(3); + const {blogPosts, blogTags} = (await plugin.loadContent!())!; expect(Object.keys(blogTags)).toHaveLength(2); expect(blogTags).toMatchSnapshot(); @@ -674,29 +668,23 @@ describe('last update', () => { ); const {blogPosts} = (await plugin.loadContent!())!; + const TestLastUpdate = await TEST_VCS.getFileLastUpdateInfo('any path'); + expect(blogPosts[0]?.metadata.lastUpdatedBy).toBe('seb'); expect(blogPosts[0]?.metadata.lastUpdatedAt).toBe( - LAST_UPDATE_FALLBACK.lastUpdatedAt, + lastUpdateFor('2021-01-01'), ); - expect(blogPosts[1]?.metadata.lastUpdatedBy).toBe( - LAST_UPDATE_FALLBACK.lastUpdatedBy, - ); + expect(blogPosts[1]?.metadata.lastUpdatedBy).toBe(TestLastUpdate.author); expect(blogPosts[1]?.metadata.lastUpdatedAt).toBe( - LAST_UPDATE_FALLBACK.lastUpdatedAt, + lastUpdateFor('2021-01-01'), ); expect(blogPosts[2]?.metadata.lastUpdatedBy).toBe('seb'); - expect(blogPosts[2]?.metadata.lastUpdatedAt).toBe( - lastUpdateFor('2021-01-01'), - ); + expect(blogPosts[2]?.metadata.lastUpdatedAt).toBe(TestLastUpdate.timestamp); - expect(blogPosts[3]?.metadata.lastUpdatedBy).toBe( - LAST_UPDATE_FALLBACK.lastUpdatedBy, - ); - expect(blogPosts[3]?.metadata.lastUpdatedAt).toBe( - lastUpdateFor('2021-01-01'), - ); + expect(blogPosts[3]?.metadata.lastUpdatedBy).toBe(TestLastUpdate.author); + expect(blogPosts[3]?.metadata.lastUpdatedAt).toBe(TestLastUpdate.timestamp); }); it('time only', async () => { @@ -710,29 +698,27 @@ describe('last update', () => { ); const {blogPosts} = (await plugin.loadContent!())!; - expect(blogPosts[0]?.metadata.title).toBe('Author'); + const TestLastUpdate = await TEST_VCS.getFileLastUpdateInfo('any path'); + + expect(blogPosts[0]?.metadata.title).toBe('Both'); expect(blogPosts[0]?.metadata.lastUpdatedBy).toBeUndefined(); expect(blogPosts[0]?.metadata.lastUpdatedAt).toBe( - LAST_UPDATE_FALLBACK.lastUpdatedAt, + lastUpdateFor('2021-01-01'), ); - expect(blogPosts[1]?.metadata.title).toBe('Nothing'); + expect(blogPosts[1]?.metadata.title).toBe('Last update date'); expect(blogPosts[1]?.metadata.lastUpdatedBy).toBeUndefined(); expect(blogPosts[1]?.metadata.lastUpdatedAt).toBe( - LAST_UPDATE_FALLBACK.lastUpdatedAt, + lastUpdateFor('2021-01-01'), ); - expect(blogPosts[2]?.metadata.title).toBe('Both'); + expect(blogPosts[2]?.metadata.title).toBe('Author'); expect(blogPosts[2]?.metadata.lastUpdatedBy).toBeUndefined(); - expect(blogPosts[2]?.metadata.lastUpdatedAt).toBe( - lastUpdateFor('2021-01-01'), - ); + expect(blogPosts[2]?.metadata.lastUpdatedAt).toBe(TestLastUpdate.timestamp); - expect(blogPosts[3]?.metadata.title).toBe('Last update date'); + expect(blogPosts[3]?.metadata.title).toBe('Nothing'); expect(blogPosts[3]?.metadata.lastUpdatedBy).toBeUndefined(); - expect(blogPosts[3]?.metadata.lastUpdatedAt).toBe( - lastUpdateFor('2021-01-01'), - ); + expect(blogPosts[3]?.metadata.lastUpdatedAt).toBe(TestLastUpdate.timestamp); }); it('author only', async () => { @@ -746,20 +732,18 @@ describe('last update', () => { ); const {blogPosts} = (await plugin.loadContent!())!; + const TestLastUpdate = await TEST_VCS.getFileLastUpdateInfo('any path'); + expect(blogPosts[0]?.metadata.lastUpdatedBy).toBe('seb'); expect(blogPosts[0]?.metadata.lastUpdatedAt).toBeUndefined(); - expect(blogPosts[1]?.metadata.lastUpdatedBy).toBe( - LAST_UPDATE_FALLBACK.lastUpdatedBy, - ); + expect(blogPosts[1]?.metadata.lastUpdatedBy).toBe(TestLastUpdate.author); expect(blogPosts[1]?.metadata.lastUpdatedAt).toBeUndefined(); expect(blogPosts[2]?.metadata.lastUpdatedBy).toBe('seb'); expect(blogPosts[2]?.metadata.lastUpdatedAt).toBeUndefined(); - expect(blogPosts[3]?.metadata.lastUpdatedBy).toBe( - LAST_UPDATE_FALLBACK.lastUpdatedBy, - ); + expect(blogPosts[3]?.metadata.lastUpdatedBy).toBe(TestLastUpdate.author); expect(blogPosts[3]?.metadata.lastUpdatedAt).toBeUndefined(); }); diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/routes.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/routes.test.ts new file mode 100644 index 0000000000..d2baaf270a --- /dev/null +++ b/packages/docusaurus-plugin-content-blog/src/__tests__/routes.test.ts @@ -0,0 +1,324 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import * as _ from 'lodash'; +import {fromPartial} from '@total-typescript/shoehorn'; +import {buildAllRoutes} from '../routes'; +import {DEFAULT_OPTIONS} from '../options'; +import type {PartialDeep} from '@total-typescript/shoehorn'; +import type {BlogPost, BlogPostMetadata} from '@docusaurus/plugin-content-blog'; + +type Params = Parameters[0]; + +async function testBuildAllRoutes(overrides: PartialDeep = {}) { + const createData = jest.fn( + async (name: string, _data: unknown) => `/data/${name}`, + ); + + const params: Params = fromPartial({ + baseUrl: '/', + aliasedSource: (str: string) => `@aliased${str}`, + ...overrides, + + content: { + blogTitle: 'Blog Title', + blogDescription: 'Blog Description', + blogSidebarTitle: 'Blog Sidebar Title', + authorsMap: {}, + blogTagsListPath: '', + blogTags: {}, + blogPosts: [], + ...overrides?.content, + }, + options: { + ...DEFAULT_OPTIONS, + ...overrides?.options, + }, + actions: { + createData, + ...overrides?.actions, + }, + }); + + const routes = await buildAllRoutes(params); + + const data = Object.fromEntries( + createData.mock.calls.map((call) => [call[0], call[1]]), + ); + + function getRouteByPath(path: string) { + const route = routes.find((r) => r.path === path); + if (!route) { + throw new Error(`Route not found for path: ${path}`); + } + return route; + } + + function getRoutesByComponent(component: string) { + return routes.filter((r) => r.component === component); + } + + return {routes, data, utils: {getRouteByPath, getRoutesByComponent}}; +} + +function blogPost(overrides: PartialDeep = {}): BlogPost { + const id = overrides.id ?? 'blog-post'; + return fromPartial({ + id, + content: `Content for ${id}`, + ...overrides, + metadata: fromPartial({ + title: `Title for ${id}`, + description: `Description for ${id}`, + permalink: `/blog/${id}`, + source: `@site/blog/${id}.md`, + date: new Date('2020-01-01'), + tags: [], + readingTime: 2, + authors: [], + frontMatter: { + ...overrides?.metadata?.frontMatter, + }, + ...overrides?.metadata, + }), + }); +} + +describe('buildAllRoutes', () => { + it('works for empty blog', async () => { + const {routes, data} = await testBuildAllRoutes({ + content: { + blogPosts: [], + }, + }); + + expect(routes).toMatchInlineSnapshot(` + [ + { + "component": "@theme/BlogListPage", + "exact": true, + "modules": { + "items": [], + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog", + "props": { + "metadata": { + "blogDescription": "Blog Description", + "blogTitle": "Blog Title", + "nextPage": undefined, + "page": 1, + "permalink": "/blog", + "postsPerPage": 10, + "previousPage": undefined, + "totalCount": 0, + "totalPages": 1, + }, + }, + }, + ] + `); + expect(data).toMatchInlineSnapshot(` + { + "blog-post-list-prop-default.json": { + "items": [], + "title": "Blog Sidebar Title", + }, + "blogMetadata-default.json": { + "authorsListPath": "/blog/authors", + "blogBasePath": "/blog", + "blogTitle": "Blog Title", + }, + } + `); + }); + + it('works for single blog post', async () => { + const {routes, data} = await testBuildAllRoutes({ + content: { + blogPosts: [blogPost()], + }, + }); + + expect(routes).toMatchInlineSnapshot(` + [ + { + "component": "@theme/BlogPostPage", + "context": { + "blogMetadata": "@aliased/data/blogMetadata-default.json", + }, + "exact": true, + "metadata": { + "lastUpdatedAt": undefined, + "sourceFilePath": "blog/blog-post.md", + }, + "modules": { + "content": "@site/blog/blog-post.md", + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog/blog-post", + }, + { + "component": "@theme/BlogListPage", + "exact": true, + "modules": { + "items": [ + { + "content": { + "__import": true, + "path": "@site/blog/blog-post.md", + "query": { + "truncated": true, + }, + }, + }, + ], + "sidebar": "@aliased/data/blog-post-list-prop-default.json", + }, + "path": "/blog", + "props": { + "metadata": { + "blogDescription": "Blog Description", + "blogTitle": "Blog Title", + "nextPage": undefined, + "page": 1, + "permalink": "/blog", + "postsPerPage": 10, + "previousPage": undefined, + "totalCount": 1, + "totalPages": 1, + }, + }, + }, + { + "component": "@theme/BlogArchivePage", + "exact": true, + "path": "/blog/archive", + "props": { + "archive": { + "blogPosts": [ + { + "content": "Content for blog-post", + "id": "blog-post", + "metadata": { + "authors": [], + "date": 2020-01-01T00:00:00.000Z, + "description": "Description for blog-post", + "frontMatter": {}, + "permalink": "/blog/blog-post", + "readingTime": 2, + "source": "@site/blog/blog-post.md", + "tags": [], + "title": "Title for blog-post", + }, + }, + ], + }, + }, + }, + ] + `); + expect(data).toMatchInlineSnapshot(` + { + "blog-post-list-prop-default.json": { + "items": [ + { + "date": 2020-01-01T00:00:00.000Z, + "permalink": "/blog/blog-post", + "title": "Title for blog-post", + "unlisted": undefined, + }, + ], + "title": "Blog Sidebar Title", + }, + "blogMetadata-default.json": { + "authorsListPath": "/blog/authors", + "blogBasePath": "/blog", + "blogTitle": "Blog Title", + }, + "site-blog-blog-post-md-0d7.json": { + "authors": [], + "date": 2020-01-01T00:00:00.000Z, + "description": "Description for blog-post", + "frontMatter": {}, + "permalink": "/blog/blog-post", + "readingTime": 2, + "source": "@site/blog/blog-post.md", + "tags": [], + "title": "Title for blog-post", + }, + } + `); + }); + + it('works for realistic blog post', async () => { + const {routes, data} = await testBuildAllRoutes({ + options: { + postsPerPage: 2, + }, + content: { + blogTitle: 'Custom blog title', + blogDescription: 'Custom blog description', + blogSidebarTitle: 'Custom blog sidebar title', + + blogPosts: [ + blogPost({id: 'post1', metadata: {authors: [{key: 'author1'}]}}), + blogPost({id: 'post2', metadata: {authors: [{key: 'author1'}]}}), + blogPost({ + id: 'post3', + metadata: { + authors: [{key: 'author3'}], + unlisted: true, + }, + }), + blogPost({ + id: 'post4', + metadata: { + authors: [{key: 'author1'}, {key: 'author2'}], + }, + }), + blogPost({ + id: 'post5', + metadata: {authors: [{key: 'author2'}, {key: 'author3'}]}, + }), + blogPost({id: 'post6'}), + ], + + authorsMap: { + author1: { + key: 'author1', + name: 'Author 1', + page: {permalink: '/blog/authors/author1'}, + }, + author2: { + key: 'author2', + name: 'Author 2', + page: null, + }, + author3: { + key: 'author3', + name: 'Author 3', + page: {permalink: '/blog/authors/author3'}, + }, + }, + }, + }); + + expect(_.countBy(routes, 'component')).toMatchInlineSnapshot(` + { + "@theme/Blog/Pages/BlogAuthorsListPage": 1, + "@theme/Blog/Pages/BlogAuthorsPostsPage": 3, + "@theme/BlogArchivePage": 1, + "@theme/BlogListPage": 3, + "@theme/BlogPostPage": 6, + } + `); + + expect(routes).toMatchSnapshot(); + expect(data).toMatchSnapshot(); + }); +}); diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/translations.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/translations.test.ts index 97db9eac87..2f7663b4d9 100644 --- a/packages/docusaurus-plugin-content-blog/src/__tests__/translations.test.ts +++ b/packages/docusaurus-plugin-content-blog/src/__tests__/translations.test.ts @@ -6,6 +6,7 @@ */ import {updateTranslationFileMessages} from '@docusaurus/utils'; +import {fromPartial} from '@total-typescript/shoehorn'; import {getTranslationFiles, translateContent} from '../translations'; import {DEFAULT_OPTIONS} from '../options'; import type { @@ -16,13 +17,13 @@ import type { const sampleBlogOptions: PluginOptions = { ...DEFAULT_OPTIONS, - blogSidebarTitle: 'All my posts', blogTitle: 'My blog', blogDescription: "Someone's random blog", + blogSidebarTitle: 'All my posts', }; const sampleBlogPosts: BlogPost[] = [ - { + fromPartial({ id: 'hello', metadata: { permalink: '/blog/2021/06/19/hello', @@ -37,27 +38,13 @@ const sampleBlogPosts: BlogPost[] = [ unlisted: false, }, content: '', - }, + }), ]; const sampleBlogContent: BlogContent = { + blogTitle: sampleBlogOptions.blogTitle, + blogDescription: sampleBlogOptions.blogDescription, blogSidebarTitle: sampleBlogOptions.blogSidebarTitle, - blogListPaginated: [ - { - items: ['hello'], - metadata: { - permalink: '/', - page: 1, - postsPerPage: 10, - totalPages: 1, - totalCount: 1, - previousPage: undefined, - nextPage: undefined, - blogTitle: sampleBlogOptions.blogTitle, - blogDescription: sampleBlogOptions.blogDescription, - }, - }, - ], blogPosts: sampleBlogPosts, blogTags: {}, blogTagsListPath: '/tags', diff --git a/packages/docusaurus-plugin-content-blog/src/authorsSocials.ts b/packages/docusaurus-plugin-content-blog/src/authorsSocials.ts index 80bb3c5864..1517381e06 100644 --- a/packages/docusaurus-plugin-content-blog/src/authorsSocials.ts +++ b/packages/docusaurus-plugin-content-blog/src/authorsSocials.ts @@ -27,6 +27,7 @@ export const AuthorSocialsSchema = Joi.object({ mastodon: Joi.string(), twitch: Joi.string(), youtube: Joi.string(), + email: Joi.string(), }).unknown(); type PredefinedPlatformNormalizer = (value: string) => string; @@ -47,12 +48,12 @@ const PredefinedPlatformNormalizers: Record< mastodon: (handle: string) => `https://mastodon.social/@${handle}`, // can be in format user@other.server and it will redirect if needed twitch: (handle: string) => `https://twitch.tv/${handle}`, youtube: (handle: string) => `https://youtube.com/@${handle}`, // https://support.google.com/youtube/answer/6180214?hl=en + email: (email: string) => `mailto:${email}`, }; type SocialEntry = [string, string]; function normalizeSocialEntry([platform, value]: SocialEntry): SocialEntry { - const normalizer = PredefinedPlatformNormalizers[platform.toLowerCase()]; if (typeof value !== 'string') { throw new Error( `Author socials should be usernames/userIds/handles, or fully qualified HTTP(s) absolute URLs. @@ -60,7 +61,9 @@ Social platform '${platform}' has illegal value '${value}'`, ); } const isAbsoluteUrl = - value.startsWith('http://') || value.startsWith('https://'); + value.startsWith('http://') || + value.startsWith('https://') || + value.startsWith('mailto:'); if (isAbsoluteUrl) { return [platform, value]; } else if (value.includes('/')) { @@ -69,6 +72,7 @@ Social platform '${platform}' has illegal value '${value}'`, Social platform '${platform}' has illegal value '${value}'`, ); } + const normalizer = PredefinedPlatformNormalizers[platform.toLowerCase()]; if (normalizer && !isAbsoluteUrl) { const normalizedPlatform = platform.toLowerCase(); const normalizedValue = normalizer(value); diff --git a/packages/docusaurus-plugin-content-blog/src/blogUtils.ts b/packages/docusaurus-plugin-content-blog/src/blogUtils.ts index 3647a34550..8ebb7b9288 100644 --- a/packages/docusaurus-plugin-content-blog/src/blogUtils.ts +++ b/packages/docusaurus-plugin-content-blog/src/blogUtils.ts @@ -19,7 +19,6 @@ import { Globby, groupTaggedItems, getTagVisibility, - getFileCommitDate, getContentPathList, isUnlisted, isDraft, @@ -225,6 +224,7 @@ async function processBlogSourceFile( siteConfig: { baseUrl, markdown: {parseFrontMatter}, + future: {experimental_vcs: vcs}, }, siteDir, i18n, @@ -257,6 +257,7 @@ async function processBlogSourceFile( blogSourceAbsolute, options, frontMatter.last_update, + vcs, ); const draft = isDraft({frontMatter}); @@ -285,17 +286,11 @@ async function processBlogSourceFile( return parsedBlogFileName.date; } - try { - const result = await getFileCommitDate(blogSourceAbsolute, { - age: 'oldest', - includeAuthor: false, - }); - - return result.date; - } catch (err) { - logger.warn(err); + const result = await vcs.getFileCreationInfo(blogSourceAbsolute); + if (result == null) { return (await fs.stat(blogSourceAbsolute)).birthtime; } + return new Date(result.timestamp); } const date = await getDate(); @@ -406,6 +401,8 @@ export async function generateBlogPosts( ignore: exclude, }); + // TODO this should be done outside of this function + // directly in plugin loadContent() const tagsFile = await getTagsFile({contentPaths, tags: options.tags}); async function doProcessBlogSourceFile(blogSourceFile: string) { diff --git a/packages/docusaurus-plugin-content-blog/src/index.ts b/packages/docusaurus-plugin-content-blog/src/index.ts index e19969ab22..7037731add 100644 --- a/packages/docusaurus-plugin-content-blog/src/index.ts +++ b/packages/docusaurus-plugin-content-blog/src/index.ts @@ -17,7 +17,6 @@ import { createAbsoluteFilePathMatcher, getContentPathList, getDataFilePath, - DEFAULT_PLUGIN_ID, resolveMarkdownLinkPathname, getLocaleConfig, } from '@docusaurus/utils'; @@ -25,7 +24,6 @@ import {getTagsFilePathsToWatch} from '@docusaurus/utils-validation'; import {createMDXLoaderItem} from '@docusaurus/mdx-loader'; import { getBlogTags, - paginateBlogPosts, shouldBeListed, applyProcessBlogPosts, generateBlogPosts, @@ -45,7 +43,6 @@ import type { Assets, BlogTags, BlogContent, - BlogPaginated, } from '@docusaurus/plugin-content-blog'; import type {RuleSetRule, RuleSetUseItem} from 'webpack'; @@ -85,7 +82,7 @@ export default async function pluginContentBlog( }) : undefined, }; - const pluginId = options.id ?? DEFAULT_PLUGIN_ID; + const pluginId = options.id; const pluginDataDirRoot = path.join(generatedFilesDir, PluginName); const dataDir = path.join(pluginDataDirRoot, pluginId); @@ -260,9 +257,10 @@ export default async function pluginContentBlog( if (!blogPosts.length) { return { + blogTitle, + blogDescription, blogSidebarTitle, blogPosts: [], - blogListPaginated: [], blogTags: {}, blogTagsListPath, authorsMap, @@ -291,15 +289,9 @@ export default async function pluginContentBlog( } }); - const blogListPaginated: BlogPaginated[] = paginateBlogPosts({ - blogPosts: listedBlogPosts, - blogTitle, - blogDescription, - postsPerPageOption, - basePageUrl: baseBlogUrl, - pageBasePath, - }); - + // TODO this is not the correct place to aggregate and paginate tags + // for reasons similar to https://github.com/facebook/docusaurus/pull/11562 + // What we should do here is only read the tags file (similar to authors) const blogTags: BlogTags = getBlogTags({ blogPosts, postsPerPageOption, @@ -309,9 +301,10 @@ export default async function pluginContentBlog( }); return { + blogTitle, + blogDescription, blogSidebarTitle, blogPosts, - blogListPaginated, blogTags, blogTagsListPath, authorsMap, diff --git a/packages/docusaurus-plugin-content-blog/src/options.ts b/packages/docusaurus-plugin-content-blog/src/options.ts index fe2d64e664..b808e144c8 100644 --- a/packages/docusaurus-plugin-content-blog/src/options.ts +++ b/packages/docusaurus-plugin-content-blog/src/options.ts @@ -15,7 +15,7 @@ import { RouteBasePathSchema, URISchema, } from '@docusaurus/utils-validation'; -import {GlobExcludeDefault} from '@docusaurus/utils'; +import {DEFAULT_PLUGIN_ID, GlobExcludeDefault} from '@docusaurus/utils'; import type { PluginOptions, Options, @@ -25,6 +25,7 @@ import type { import type {OptionValidationContext} from '@docusaurus/types'; export const DEFAULT_OPTIONS: PluginOptions = { + id: DEFAULT_PLUGIN_ID, feedOptions: { type: ['rss', 'atom'], copyright: '', diff --git a/packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts b/packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts index 625aaf94df..944a113c0a 100644 --- a/packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts +++ b/packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts @@ -431,7 +431,7 @@ declare module '@docusaurus/plugin-content-blog' { export type PluginOptions = MDXOptions & TagsPluginOptions & { /** Plugin ID. */ - id?: string; + id: string; /** * Path to the blog content directory on the file system, relative to site * directory. @@ -583,9 +583,10 @@ declare module '@docusaurus/plugin-content-blog' { export type AuthorsMap = {[authorKey: string]: AuthorWithKey}; export type BlogContent = { - blogSidebarTitle: string; + blogTitle: string; // for translation purposes + blogDescription: string; // for translation purposes + blogSidebarTitle: string; // for translation purposes blogPosts: BlogPost[]; - blogListPaginated: BlogPaginated[]; blogTags: BlogTags; blogTagsListPath: string; authorsMap?: AuthorsMap; diff --git a/packages/docusaurus-plugin-content-blog/src/routes.ts b/packages/docusaurus-plugin-content-blog/src/routes.ts index ced92dc0fd..b8667d3dd2 100644 --- a/packages/docusaurus-plugin-content-blog/src/routes.ts +++ b/packages/docusaurus-plugin-content-blog/src/routes.ts @@ -67,27 +67,24 @@ export async function buildAllRoutes({ blogArchiveComponent, routeBasePath, archiveBasePath, - blogTitle, authorsBasePath, postsPerPage, - blogDescription, + pageBasePath, } = options; - const pluginId = options.id!; + const pluginId = options.id; const {createData} = actions; const { + blogTitle, + blogDescription, blogSidebarTitle, blogPosts, - blogListPaginated, blogTags, blogTagsListPath, authorsMap, } = content; - const authorsListPath = normalizeUrl([ - baseUrl, - routeBasePath, - authorsBasePath, - ]); + const blogBasePath = normalizeUrl([baseUrl, routeBasePath]); + const authorsListPath = normalizeUrl([blogBasePath, authorsBasePath]); const listedBlogPosts = blogPosts.filter(shouldBeListed); @@ -119,7 +116,7 @@ export async function buildAllRoutes({ async function createBlogMetadataModule() { const blogMetadata: BlogMetadata = { - blogBasePath: normalizeUrl([baseUrl, routeBasePath]), + blogBasePath, blogTitle, authorsListPath, }; @@ -156,7 +153,7 @@ export async function buildAllRoutes({ if (archiveBasePath && listedBlogPosts.length) { return [ { - path: normalizeUrl([baseUrl, routeBasePath, archiveBasePath]), + path: normalizeUrl([blogBasePath, archiveBasePath]), component: blogArchiveComponent, exact: true, props: { @@ -210,6 +207,15 @@ export async function buildAllRoutes({ } function createBlogPostsPaginatedRoutes(): RouteConfig[] { + const blogListPaginated = paginateBlogPosts({ + blogPosts: listedBlogPosts, + blogTitle, + blogDescription, + postsPerPageOption: postsPerPage, + basePageUrl: blogBasePath, + pageBasePath, + }); + return blogListPaginated.map((paginated) => { return { path: paginated.metadata.permalink, @@ -294,12 +300,14 @@ export async function buildAllRoutes({ sidebar: sidebarModulePath, }, props: { - authors: authors.map((author) => - toAuthorItemProp({ + authors: authors.map((author) => { + const authorPosts = blogPostsByAuthorKey[author.key] ?? []; + const listedAuthorPosts = authorPosts.filter(shouldBeListed); + return toAuthorItemProp({ author, - count: blogPostsByAuthorKey[author.key]?.length ?? 0, - }), - ), + count: listedAuthorPosts.length, + }); + }), }, context: { blogMetadata: blogMetadataModulePath, @@ -309,16 +317,17 @@ export async function buildAllRoutes({ function createAuthorPaginatedRoute(author: AuthorWithKey): RouteConfig[] { const authorBlogPosts = blogPostsByAuthorKey[author.key] ?? []; + const listedAuthorBlogPosts = authorBlogPosts.filter(shouldBeListed); if (!author.page) { return []; } const pages = paginateBlogPosts({ - blogPosts: authorBlogPosts, + blogPosts: listedAuthorBlogPosts, basePageUrl: author.page.permalink, blogDescription, blogTitle, - pageBasePath: authorsBasePath, + pageBasePath, postsPerPageOption: postsPerPage, }); @@ -332,7 +341,10 @@ export async function buildAllRoutes({ sidebar: sidebarModulePath, }, props: { - author: toAuthorItemProp({author, count: authorBlogPosts.length}), + author: toAuthorItemProp({ + author, + count: listedAuthorBlogPosts.length, + }), listMetadata: metadata, }, context: { diff --git a/packages/docusaurus-plugin-content-blog/src/translations.ts b/packages/docusaurus-plugin-content-blog/src/translations.ts index 9cf763de3b..4e256ac5ad 100644 --- a/packages/docusaurus-plugin-content-blog/src/translations.ts +++ b/packages/docusaurus-plugin-content-blog/src/translations.ts @@ -5,30 +5,8 @@ * LICENSE file in the root directory of this source tree. */ -import type {TranslationFileContent, TranslationFile} from '@docusaurus/types'; -import type { - PluginOptions, - BlogContent, - BlogPaginated, -} from '@docusaurus/plugin-content-blog'; - -function translateListPage( - blogListPaginated: BlogPaginated[], - translations: TranslationFileContent, -) { - return blogListPaginated.map((page) => { - const {items, metadata} = page; - return { - items, - metadata: { - ...metadata, - blogTitle: translations.title?.message ?? page.metadata.blogTitle, - blogDescription: - translations.description?.message ?? page.metadata.blogDescription, - }, - }; - }); -} +import type {TranslationFile} from '@docusaurus/types'; +import type {PluginOptions, BlogContent} from '@docusaurus/plugin-content-blog'; export function getTranslationFiles(options: PluginOptions): TranslationFile[] { return [ @@ -56,14 +34,13 @@ export function translateContent( content: BlogContent, translationFiles: TranslationFile[], ): BlogContent { - const {content: optionsTranslations} = translationFiles[0]!; + const {content: translations} = translationFiles[0]!; return { ...content, + blogTitle: translations.title?.message ?? content.blogTitle, + blogDescription: + translations.description?.message ?? content.blogDescription, blogSidebarTitle: - optionsTranslations['sidebar.title']?.message ?? content.blogSidebarTitle, - blogListPaginated: translateListPage( - content.blogListPaginated, - optionsTranslations, - ), + translations['sidebar.title']?.message ?? content.blogSidebarTitle, }; } diff --git a/packages/docusaurus-plugin-content-docs/package.json b/packages/docusaurus-plugin-content-docs/package.json index 7ac48ffa89..94658e4d55 100644 --- a/packages/docusaurus-plugin-content-docs/package.json +++ b/packages/docusaurus-plugin-content-docs/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-content-docs", - "version": "3.8.1", + "version": "3.9.2", "description": "Docs plugin for Docusaurus.", "main": "lib/index.js", "sideEffects": false, @@ -35,15 +35,15 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/logger": "3.8.1", - "@docusaurus/mdx-loader": "3.8.1", - "@docusaurus/module-type-aliases": "3.8.1", - "@docusaurus/theme-common": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-common": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "@types/react-router-config": "^5.0.7", "combine-promises": "^1.1.0", "fs-extra": "^11.1.1", @@ -65,6 +65,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/translations.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/translations.test.ts.snap index 7498d1ba22..1c0b64d149 100644 --- a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/translations.test.ts.snap +++ b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/translations.test.ts.snap @@ -5,27 +5,27 @@ exports[`getLoadedContentTranslationFiles returns translation files 1`] = ` { "content": { "sidebar.docs.category.Getting started": { - "description": "The label for category Getting started in sidebar docs", + "description": "The label for category 'Getting started' in sidebar 'docs'", "message": "Getting started", }, "sidebar.docs.category.Getting started.link.generated-index.description": { - "description": "The generated-index page description for category Getting started in sidebar docs", + "description": "The generated-index page description for category 'Getting started' in sidebar 'docs'", "message": "Getting started index description", }, "sidebar.docs.category.Getting started.link.generated-index.title": { - "description": "The generated-index page title for category Getting started in sidebar docs", + "description": "The generated-index page title for category 'Getting started' in sidebar 'docs'", "message": "Getting started index title", }, "sidebar.docs.doc.Second doc translatable": { - "description": "The label for the doc item Second doc translatable in sidebar docs, linking to the doc doc2", + "description": "The label for the doc item 'Second doc translatable' in sidebar 'docs', linking to the doc doc2", "message": "Second doc translatable", }, "sidebar.docs.link.Link label": { - "description": "The label for link Link label in sidebar docs, linking to https://facebook.com", + "description": "The label for link 'Link label' in sidebar 'docs', linking to 'https://facebook.com'", "message": "Link label", }, "sidebar.otherSidebar.doc.Fifth doc translatable": { - "description": "The label for the doc item Fifth doc translatable in sidebar otherSidebar, linking to the doc doc5", + "description": "The label for the doc item 'Fifth doc translatable' in sidebar 'otherSidebar', linking to the doc doc5", "message": "Fifth doc translatable", }, "version.label": { @@ -38,27 +38,27 @@ exports[`getLoadedContentTranslationFiles returns translation files 1`] = ` { "content": { "sidebar.docs.category.Getting started": { - "description": "The label for category Getting started in sidebar docs", + "description": "The label for category 'Getting started' in sidebar 'docs'", "message": "Getting started", }, "sidebar.docs.category.Getting started.link.generated-index.description": { - "description": "The generated-index page description for category Getting started in sidebar docs", + "description": "The generated-index page description for category 'Getting started' in sidebar 'docs'", "message": "Getting started index description", }, "sidebar.docs.category.Getting started.link.generated-index.title": { - "description": "The generated-index page title for category Getting started in sidebar docs", + "description": "The generated-index page title for category 'Getting started' in sidebar 'docs'", "message": "Getting started index title", }, "sidebar.docs.doc.Second doc translatable": { - "description": "The label for the doc item Second doc translatable in sidebar docs, linking to the doc doc2", + "description": "The label for the doc item 'Second doc translatable' in sidebar 'docs', linking to the doc doc2", "message": "Second doc translatable", }, "sidebar.docs.link.Link label": { - "description": "The label for link Link label in sidebar docs, linking to https://facebook.com", + "description": "The label for link 'Link label' in sidebar 'docs', linking to 'https://facebook.com'", "message": "Link label", }, "sidebar.otherSidebar.doc.Fifth doc translatable": { - "description": "The label for the doc item Fifth doc translatable in sidebar otherSidebar, linking to the doc doc5", + "description": "The label for the doc item 'Fifth doc translatable' in sidebar 'otherSidebar', linking to the doc doc5", "message": "Fifth doc translatable", }, "version.label": { @@ -71,27 +71,27 @@ exports[`getLoadedContentTranslationFiles returns translation files 1`] = ` { "content": { "sidebar.docs.category.Getting started": { - "description": "The label for category Getting started in sidebar docs", + "description": "The label for category 'Getting started' in sidebar 'docs'", "message": "Getting started", }, "sidebar.docs.category.Getting started.link.generated-index.description": { - "description": "The generated-index page description for category Getting started in sidebar docs", + "description": "The generated-index page description for category 'Getting started' in sidebar 'docs'", "message": "Getting started index description", }, "sidebar.docs.category.Getting started.link.generated-index.title": { - "description": "The generated-index page title for category Getting started in sidebar docs", + "description": "The generated-index page title for category 'Getting started' in sidebar 'docs'", "message": "Getting started index title", }, "sidebar.docs.doc.Second doc translatable": { - "description": "The label for the doc item Second doc translatable in sidebar docs, linking to the doc doc2", + "description": "The label for the doc item 'Second doc translatable' in sidebar 'docs', linking to the doc doc2", "message": "Second doc translatable", }, "sidebar.docs.link.Link label": { - "description": "The label for link Link label in sidebar docs, linking to https://facebook.com", + "description": "The label for link 'Link label' in sidebar 'docs', linking to 'https://facebook.com'", "message": "Link label", }, "sidebar.otherSidebar.doc.Fifth doc translatable": { - "description": "The label for the doc item Fifth doc translatable in sidebar otherSidebar, linking to the doc doc5", + "description": "The label for the doc item 'Fifth doc translatable' in sidebar 'otherSidebar', linking to the doc doc5", "message": "Fifth doc translatable", }, "version.label": { diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts index 56422102c8..e0e3b13770 100644 --- a/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts +++ b/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts @@ -12,8 +12,8 @@ import { createSlugger, posixPath, DEFAULT_PLUGIN_ID, - LAST_UPDATE_FALLBACK, getLocaleConfig, + TEST_VCS, } from '@docusaurus/utils'; import {getTagsFile} from '@docusaurus/utils-validation'; import {createSidebarsUtils} from '../sidebars/utils'; @@ -529,8 +529,8 @@ describe('simple site', () => { custom_edit_url: 'https://github.com/customUrl/docs/lorem.md', unrelated_front_matter: "won't be part of metadata", }, - lastUpdatedAt: LAST_UPDATE_FALLBACK.lastUpdatedAt, - lastUpdatedBy: LAST_UPDATE_FALLBACK.lastUpdatedBy, + lastUpdatedAt: TEST_VCS.LAST_UPDATE_INFO.timestamp, + lastUpdatedBy: TEST_VCS.LAST_UPDATE_INFO.author, tags: [], unlisted: false, }); @@ -664,7 +664,7 @@ describe('simple site', () => { }, title: 'Last Update Author Only', }, - lastUpdatedAt: LAST_UPDATE_FALLBACK.lastUpdatedAt, + lastUpdatedAt: TEST_VCS.LAST_UPDATE_INFO.timestamp, lastUpdatedBy: 'Custom Author (processed by parseFrontMatter)', sidebarPosition: undefined, tags: [], diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/frontMatter.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/frontMatter.test.ts index 2219ad86af..238cd71390 100644 --- a/packages/docusaurus-plugin-content-docs/src/__tests__/frontMatter.test.ts +++ b/packages/docusaurus-plugin-content-docs/src/__tests__/frontMatter.test.ts @@ -186,10 +186,24 @@ describe('validateDocFrontMatter slug', () => { }); }); +describe('validateDocFrontMatter sidebar_key', () => { + testField({ + prefix: 'sidebar_key', + validFrontMatters: [ + {sidebar_key: undefined}, + {sidebar_key: 'Awesome docs'}, + ], + invalidFrontMatters: [[{sidebar_key: ''}, 'is not allowed to be empty']], + }); +}); + describe('validateDocFrontMatter sidebar_label', () => { testField({ prefix: 'sidebar_label', - validFrontMatters: [{sidebar_label: 'Awesome docs'}], + validFrontMatters: [ + {sidebar_label: undefined}, + {sidebar_label: 'Awesome docs'}, + ], invalidFrontMatters: [[{sidebar_label: ''}, 'is not allowed to be empty']], }); }); diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/translations.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/translations.test.ts index 45a06c114d..26666037c5 100644 --- a/packages/docusaurus-plugin-content-docs/src/__tests__/translations.test.ts +++ b/packages/docusaurus-plugin-content-docs/src/__tests__/translations.test.ts @@ -232,35 +232,35 @@ describe('getLoadedContentTranslationFiles', () => { { "content": { "sidebar.sidebarWithConflicts.category.key-cat1": { - "description": "The label for category COMMON LABEL in sidebar sidebarWithConflicts", + "description": "The label for category 'COMMON LABEL' in sidebar 'sidebarWithConflicts'", "message": "COMMON LABEL", }, "sidebar.sidebarWithConflicts.category.key-cat2": { - "description": "The label for category COMMON LABEL in sidebar sidebarWithConflicts", + "description": "The label for category 'COMMON LABEL' in sidebar 'sidebarWithConflicts'", "message": "COMMON LABEL", }, "sidebar.sidebarWithConflicts.doc.key-doc4": { - "description": "The label for the doc item COMMON LABEL in sidebar sidebarWithConflicts, linking to the doc doc4", + "description": "The label for the doc item 'COMMON LABEL' in sidebar 'sidebarWithConflicts', linking to the doc doc4", "message": "COMMON LABEL", }, "sidebar.sidebarWithConflicts.doc.key-doc5": { - "description": "The label for the doc item COMMON LABEL in sidebar sidebarWithConflicts, linking to the doc doc5", + "description": "The label for the doc item 'COMMON LABEL' in sidebar 'sidebarWithConflicts', linking to the doc doc5", "message": "COMMON LABEL", }, "sidebar.sidebarWithConflicts.doc.key-ref4": { - "description": "The label for the doc item COMMON LABEL in sidebar sidebarWithConflicts, linking to the doc doc4", + "description": "The label for the doc item 'COMMON LABEL' in sidebar 'sidebarWithConflicts', linking to the doc doc4", "message": "COMMON LABEL", }, "sidebar.sidebarWithConflicts.doc.key-ref5": { - "description": "The label for the doc item COMMON LABEL in sidebar sidebarWithConflicts, linking to the doc doc5", + "description": "The label for the doc item 'COMMON LABEL' in sidebar 'sidebarWithConflicts', linking to the doc doc5", "message": "COMMON LABEL", }, "sidebar.sidebarWithConflicts.link.key-link1": { - "description": "The label for link COMMON LABEL in sidebar sidebarWithConflicts, linking to https://example.com", + "description": "The label for link 'COMMON LABEL' in sidebar 'sidebarWithConflicts', linking to 'https://example.com'", "message": "COMMON LABEL", }, "sidebar.sidebarWithConflicts.link.key-link2": { - "description": "The label for link COMMON LABEL in sidebar sidebarWithConflicts, linking to https://example.com", + "description": "The label for link 'COMMON LABEL' in sidebar 'sidebarWithConflicts', linking to 'https://example.com'", "message": "COMMON LABEL", }, "version.label": { @@ -279,21 +279,24 @@ describe('getLoadedContentTranslationFiles', () => { .toThrowErrorMatchingInlineSnapshot(` "Multiple docs sidebar items produce the same translation key. - \`sidebar.sidebarWithConflicts.category.COMMON LABEL\`: 2 duplicates found: - - COMMON LABEL (The label for category COMMON LABEL in sidebar sidebarWithConflicts) - - COMMON LABEL (The label for category COMMON LABEL in sidebar sidebarWithConflicts) + - COMMON LABEL (The label for category 'COMMON LABEL' in sidebar 'sidebarWithConflicts') + - COMMON LABEL (The label for category 'COMMON LABEL' in sidebar 'sidebarWithConflicts') - \`sidebar.sidebarWithConflicts.link.COMMON LABEL\`: 2 duplicates found: - - COMMON LABEL (The label for link COMMON LABEL in sidebar sidebarWithConflicts, linking to https://example.com) - - COMMON LABEL (The label for link COMMON LABEL in sidebar sidebarWithConflicts, linking to https://example.com) + - COMMON LABEL (The label for link 'COMMON LABEL' in sidebar 'sidebarWithConflicts', linking to 'https://example.com') + - COMMON LABEL (The label for link 'COMMON LABEL' in sidebar 'sidebarWithConflicts', linking to 'https://example.com') - \`sidebar.sidebarWithConflicts.doc.COMMON LABEL\`: 4 duplicates found: - - COMMON LABEL (The label for the doc item COMMON LABEL in sidebar sidebarWithConflicts, linking to the doc doc4) - - COMMON LABEL (The label for the doc item COMMON LABEL in sidebar sidebarWithConflicts, linking to the doc doc5) - - COMMON LABEL (The label for the doc item COMMON LABEL in sidebar sidebarWithConflicts, linking to the doc doc4) - - COMMON LABEL (The label for the doc item COMMON LABEL in sidebar sidebarWithConflicts, linking to the doc doc5) + - COMMON LABEL (The label for the doc item 'COMMON LABEL' in sidebar 'sidebarWithConflicts', linking to the doc doc4) + - COMMON LABEL (The label for the doc item 'COMMON LABEL' in sidebar 'sidebarWithConflicts', linking to the doc doc5) + - COMMON LABEL (The label for the doc item 'COMMON LABEL' in sidebar 'sidebarWithConflicts', linking to the doc doc4) + - COMMON LABEL (The label for the doc item 'COMMON LABEL' in sidebar 'sidebarWithConflicts', linking to the doc doc5) To avoid translation key conflicts, use the \`key\` attribute on the sidebar items above to uniquely identify them. - " + + When using autogenerated sidebars, you can provide a unique translation key by adding: + - the \`key\` attribute to category item metadata (\`_category_.json\` / \`_category_.yml\`) + - the \`sidebar_key\` attribute to doc item metadata (front matter in \`Category/index.mdx\`)" `); }); }); diff --git a/packages/docusaurus-plugin-content-docs/src/docs.ts b/packages/docusaurus-plugin-content-docs/src/docs.ts index 352ccb3adb..b8f02ba5b0 100644 --- a/packages/docusaurus-plugin-content-docs/src/docs.ts +++ b/packages/docusaurus-plugin-content-docs/src/docs.ts @@ -97,6 +97,7 @@ async function doProcessDocMetadata({ siteDir, siteConfig: { markdown: {parseFrontMatter}, + future: {experimental_vcs: vcs}, }, } = context; @@ -125,6 +126,7 @@ async function doProcessDocMetadata({ filePath, options, lastUpdateFrontMatter, + vcs, ); // E.g. api/plugins/myDoc -> myDoc; myDoc -> myDoc diff --git a/packages/docusaurus-plugin-content-docs/src/frontMatter.ts b/packages/docusaurus-plugin-content-docs/src/frontMatter.ts index de315cddab..0526a5f6b5 100644 --- a/packages/docusaurus-plugin-content-docs/src/frontMatter.ts +++ b/packages/docusaurus-plugin-content-docs/src/frontMatter.ts @@ -30,6 +30,7 @@ export const DocFrontMatterSchema = Joi.object({ // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398 description: Joi.string().allow(''), slug: Joi.string(), + sidebar_key: Joi.string(), sidebar_label: Joi.string(), sidebar_position: Joi.number(), sidebar_class_name: Joi.string(), diff --git a/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts b/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts index 10f4a84a3b..f89b3f6316 100644 --- a/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts +++ b/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts @@ -339,7 +339,15 @@ declare module '@docusaurus/plugin-content-docs' { * @see {@link DocMetadata.slug} */ slug?: string; - /** Customizes the sidebar label for this doc. Will default to its title. */ + /** + * Customizes the sidebar key for this doc, + * to uniquely identify it in translations. + */ + sidebar_key?: string; + /** + * Customizes the sidebar label for this doc. + * Will default to its title. + */ sidebar_label?: string; /** * Controls the position of a doc inside the generated sidebar slice when diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap index e4d7132e65..da31fd8a63 100644 --- a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap +++ b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap @@ -91,6 +91,7 @@ exports[`DefaultSidebarItemsGenerator generates simple flat sidebar 1`] = ` "custom": "prop", }, "id": "doc1", + "key": "doc1-sidebar-key", "label": "doc1 sidebar label", "type": "doc", }, @@ -120,6 +121,7 @@ exports[`DefaultSidebarItemsGenerator generates subfolder sidebar 1`] = ` "type": "doc", }, ], + "key": "doc1-sidebar-key", "label": "Subsubsubfolder category label", "link": { "id": "doc1", @@ -142,6 +144,7 @@ exports[`DefaultSidebarItemsGenerator generates subfolder sidebar 1`] = ` }, { "id": "doc1", + "key": "doc1-sidebar-key", "type": "doc", }, { diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts index 5072fd80d7..83904dd9eb 100644 --- a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts +++ b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts @@ -63,6 +63,7 @@ describe('DefaultSidebarItemsGenerator', () => { sourceDirName: '.', sidebarPosition: 2, frontMatter: { + sidebar_key: 'doc1-sidebar-key', sidebar_label: 'doc1 sidebar label', sidebar_custom_props: {custom: 'prop'}, }, @@ -254,7 +255,9 @@ describe('DefaultSidebarItemsGenerator', () => { sourceDirName: 'subfolder/subsubfolder', title: 'Subsubsubfolder category label', sidebarPosition: undefined, - frontMatter: {}, + frontMatter: { + sidebar_key: 'doc1-sidebar-key', + }, }, { id: 'doc2', diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts index cbd58d7b5b..b37536c7e3 100644 --- a/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts +++ b/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts @@ -139,6 +139,7 @@ Available doc IDs: const { sidebarPosition: position, frontMatter: { + sidebar_key: key, sidebar_label: label, sidebar_class_name: className, sidebar_custom_props: customProps, @@ -151,6 +152,7 @@ Available doc IDs: source: fileName, // We don't want these fields to magically appear in the generated // sidebar + ...(key !== undefined && {key}), ...(label !== undefined && {label}), ...(className !== undefined && {className}), ...(customProps !== undefined && {customProps}), @@ -191,6 +193,7 @@ Available doc IDs: function getCategoryLinkedDocMetadata(): | { id: string; + key?: string; position?: number; label?: string; customProps?: {[key: string]: unknown}; @@ -212,6 +215,7 @@ Available doc IDs: return { id, position: doc.sidebarPosition, + key: doc.frontMatter.sidebar_key, label: doc.frontMatter.sidebar_label ?? doc.title, customProps: doc.frontMatter.sidebar_custom_props, className: doc.frontMatter.sidebar_class_name, @@ -236,6 +240,8 @@ Available doc IDs: categoryMetadata?.customProps ?? categoryLinkedDoc?.customProps; const {filename, numberPrefix} = numberPrefixParser(folderName); + const key = categoryMetadata?.key ?? categoryLinkedDoc?.key; + return { type: 'category', label: categoryMetadata?.label ?? categoryLinkedDoc?.label ?? filename, @@ -252,7 +258,7 @@ Available doc IDs: ...(categoryMetadata?.description && { description: categoryMetadata?.description, }), - ...(categoryMetadata?.key && {key: categoryMetadata?.key}), + ...(key && {key}), ...(link && {link}), }; } diff --git a/packages/docusaurus-plugin-content-docs/src/translations.ts b/packages/docusaurus-plugin-content-docs/src/translations.ts index ec35afbe4b..9ad1a148b0 100644 --- a/packages/docusaurus-plugin-content-docs/src/translations.ts +++ b/packages/docusaurus-plugin-content-docs/src/translations.ts @@ -71,7 +71,16 @@ function ensureNoSidebarDuplicateEntries( To avoid translation key conflicts, use the ${logger.code( 'key', )} attribute on the sidebar items above to uniquely identify them. - `); + +When using autogenerated sidebars, you can provide a unique translation key by adding: +- the ${logger.code('key')} attribute to category item metadata (${logger.code( + '_category_.json', + )} / ${logger.code('_category_.yml')}) +- the ${logger.code( + 'sidebar_key', + )} attribute to doc item metadata (front matter in ${logger.code( + 'Category/index.mdx', + )})`); } } @@ -90,7 +99,7 @@ function getSidebarTranslationFileContent( `sidebar.${sidebarName}.category.${categoryKey}`, { message: category.label, - description: `The label for category ${category.label} in sidebar ${sidebarName}`, + description: `The label for category '${category.label}' in sidebar '${sidebarName}'`, }, ]); @@ -100,7 +109,7 @@ function getSidebarTranslationFileContent( `sidebar.${sidebarName}.category.${categoryKey}.link.generated-index.title`, { message: category.link.title, - description: `The generated-index page title for category ${category.label} in sidebar ${sidebarName}`, + description: `The generated-index page title for category '${category.label}' in sidebar '${sidebarName}'`, }, ]); } @@ -109,7 +118,7 @@ function getSidebarTranslationFileContent( `sidebar.${sidebarName}.category.${categoryKey}.link.generated-index.description`, { message: category.link.description, - description: `The generated-index page description for category ${category.label} in sidebar ${sidebarName}`, + description: `The generated-index page description for category '${category.label}' in sidebar '${sidebarName}'`, }, ]); } @@ -126,7 +135,7 @@ function getSidebarTranslationFileContent( `sidebar.${sidebarName}.link.${linkKey}`, { message: link.label, - description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`, + description: `The label for link '${link.label}' in sidebar '${sidebarName}', linking to '${link.href}'`, }, ]; }); @@ -140,7 +149,7 @@ function getSidebarTranslationFileContent( `sidebar.${sidebarName}.doc.${docKey}`, { message: doc.label!, - description: `The label for the doc item ${doc.label!} in sidebar ${sidebarName}, linking to the doc ${ + description: `The label for the doc item '${doc.label!}' in sidebar '${sidebarName}', linking to the doc ${ doc.id }`, }, diff --git a/packages/docusaurus-plugin-content-docs/src/versions/__tests__/loadVersion.test.ts b/packages/docusaurus-plugin-content-docs/src/versions/__tests__/loadVersion.test.ts index 442e4a43a5..57d20695f1 100644 --- a/packages/docusaurus-plugin-content-docs/src/versions/__tests__/loadVersion.test.ts +++ b/packages/docusaurus-plugin-content-docs/src/versions/__tests__/loadVersion.test.ts @@ -8,6 +8,7 @@ import * as path from 'path'; import {fromPartial} from '@total-typescript/shoehorn'; import {DEFAULT_PARSE_FRONT_MATTER} from '@docusaurus/utils/src'; +import {DEFAULT_VCS_CONFIG} from '@docusaurus/utils'; import {readVersionsMetadata} from '../version'; import {DEFAULT_OPTIONS} from '../../options'; import {loadVersion} from '../loadVersion'; @@ -37,6 +38,9 @@ async function siteFixture(fixture: string) { markdown: { parseFrontMatter: DEFAULT_PARSE_FRONT_MATTER, }, + future: { + experimental_vcs: DEFAULT_VCS_CONFIG, + }, }, }); diff --git a/packages/docusaurus-plugin-content-pages/package.json b/packages/docusaurus-plugin-content-pages/package.json index 16d3d9ed16..4fe81bf764 100644 --- a/packages/docusaurus-plugin-content-pages/package.json +++ b/packages/docusaurus-plugin-content-pages/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-content-pages", - "version": "3.8.1", + "version": "3.9.2", "description": "Pages plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-content-pages.d.ts", @@ -18,11 +18,11 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/mdx-loader": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "fs-extra": "^11.1.1", "tslib": "^2.6.0", "webpack": "^5.88.1" @@ -32,6 +32,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-plugin-content-pages/src/content.ts b/packages/docusaurus-plugin-content-pages/src/content.ts index 65f1d9b420..c3ae1b18e8 100644 --- a/packages/docusaurus-plugin-content-pages/src/content.ts +++ b/packages/docusaurus-plugin-content-pages/src/content.ts @@ -98,6 +98,7 @@ async function processPageSourceFile( ): Promise { const {context, options, contentPaths} = params; const {siteConfig, baseUrl, siteDir, i18n} = context; + const vcs = siteConfig.future.experimental_vcs; const {editUrl} = options; // Lookup in localized folder in priority @@ -180,6 +181,7 @@ async function processPageSourceFile( source, options, frontMatter.last_update, + vcs, ); if (isDraft({frontMatter})) { diff --git a/packages/docusaurus-plugin-content-pages/src/index.ts b/packages/docusaurus-plugin-content-pages/src/index.ts index aea10501f2..cb2a647b00 100644 --- a/packages/docusaurus-plugin-content-pages/src/index.ts +++ b/packages/docusaurus-plugin-content-pages/src/index.ts @@ -13,7 +13,6 @@ import { addTrailingPathSeparator, createAbsoluteFilePathMatcher, getContentPathList, - DEFAULT_PLUGIN_ID, } from '@docusaurus/utils'; import {createMDXLoaderRule} from '@docusaurus/mdx-loader'; import {createAllRoutes} from './routes'; @@ -38,7 +37,7 @@ export default async function pluginContentPages( generatedFilesDir, 'docusaurus-plugin-content-pages', ); - const dataDir = path.join(pluginDataDirRoot, options.id ?? DEFAULT_PLUGIN_ID); + const dataDir = path.join(pluginDataDirRoot, options.id); async function createPagesMDXLoaderRule(): Promise { const { diff --git a/packages/docusaurus-plugin-content-pages/src/options.ts b/packages/docusaurus-plugin-content-pages/src/options.ts index 2ffda3e7c2..8d6383c7ae 100644 --- a/packages/docusaurus-plugin-content-pages/src/options.ts +++ b/packages/docusaurus-plugin-content-pages/src/options.ts @@ -14,11 +14,12 @@ import { RouteBasePathSchema, URISchema, } from '@docusaurus/utils-validation'; -import {GlobExcludeDefault} from '@docusaurus/utils'; +import {DEFAULT_PLUGIN_ID, GlobExcludeDefault} from '@docusaurus/utils'; import type {OptionValidationContext} from '@docusaurus/types'; import type {PluginOptions, Options} from '@docusaurus/plugin-content-pages'; export const DEFAULT_OPTIONS: PluginOptions = { + id: DEFAULT_PLUGIN_ID, path: 'src/pages', // Path to data on filesystem, relative to site dir. routeBasePath: '/', // URL Route. include: ['**/*.{js,jsx,ts,tsx,md,mdx}'], // Extensions to include. diff --git a/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts b/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts index c0e02f40ae..ca5bd518f3 100644 --- a/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts +++ b/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts @@ -19,7 +19,7 @@ declare module '@docusaurus/plugin-content-pages' { }; export type PluginOptions = MDXOptions & { - id?: string; + id: string; path: string; routeBasePath: string; include: string[]; diff --git a/packages/docusaurus-plugin-css-cascade-layers/package.json b/packages/docusaurus-plugin-css-cascade-layers/package.json index 56c9bc6b34..ec6370df77 100644 --- a/packages/docusaurus-plugin-css-cascade-layers/package.json +++ b/packages/docusaurus-plugin-css-cascade-layers/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-css-cascade-layers", - "version": "3.8.1", + "version": "3.9.2", "description": "CSS Cascade Layer plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,13 +18,13 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "tslib": "^2.6.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-plugin-debug/package.json b/packages/docusaurus-plugin-debug/package.json index 6c7987ea9d..cd94433590 100644 --- a/packages/docusaurus-plugin-debug/package.json +++ b/packages/docusaurus-plugin-debug/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-debug", - "version": "3.8.1", + "version": "3.9.2", "description": "Debug plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-debug.d.ts", @@ -20,9 +20,9 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", "fs-extra": "^11.1.1", "react-json-view-lite": "^2.3.0", "tslib": "^2.6.0" @@ -32,6 +32,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-plugin-google-analytics/package.json b/packages/docusaurus-plugin-google-analytics/package.json index 1bba44dfff..633913ea64 100644 --- a/packages/docusaurus-plugin-google-analytics/package.json +++ b/packages/docusaurus-plugin-google-analytics/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-google-analytics", - "version": "3.8.1", + "version": "3.9.2", "description": "Global analytics (analytics.js) plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,9 +18,9 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "tslib": "^2.6.0" }, "peerDependencies": { @@ -28,6 +28,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-plugin-google-gtag/package.json b/packages/docusaurus-plugin-google-gtag/package.json index 477dafd9b7..ce102e4ce9 100644 --- a/packages/docusaurus-plugin-google-gtag/package.json +++ b/packages/docusaurus-plugin-google-gtag/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-google-gtag", - "version": "3.8.1", + "version": "3.9.2", "description": "Global Site Tag (gtag.js) plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,9 +18,9 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "@types/gtag.js": "^0.0.12", "tslib": "^2.6.0" }, @@ -29,6 +29,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-plugin-google-tag-manager/package.json b/packages/docusaurus-plugin-google-tag-manager/package.json index 47444e2590..ec598ad64c 100644 --- a/packages/docusaurus-plugin-google-tag-manager/package.json +++ b/packages/docusaurus-plugin-google-tag-manager/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-google-tag-manager", - "version": "3.8.1", + "version": "3.9.2", "description": "Google Tag Manager (gtm.js) plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,9 +18,9 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "tslib": "^2.6.0" }, "peerDependencies": { @@ -28,6 +28,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-plugin-ideal-image/package.json b/packages/docusaurus-plugin-ideal-image/package.json index 80244aa619..2bff7b3ef9 100644 --- a/packages/docusaurus-plugin-ideal-image/package.json +++ b/packages/docusaurus-plugin-ideal-image/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-ideal-image", - "version": "3.8.1", + "version": "3.9.2", "description": "Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder).", "main": "lib/index.js", "types": "src/plugin-ideal-image.d.ts", @@ -20,18 +20,18 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/lqip-loader": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/lqip-loader": "3.9.2", "@docusaurus/responsive-loader": "^1.7.0", - "@docusaurus/theme-translations": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/theme-translations": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "sharp": "^0.32.3", "tslib": "^2.6.0", "webpack": "^5.88.1" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.8.1", + "@docusaurus/module-type-aliases": "3.9.2", "fs-extra": "^11.1.0" }, "peerDependencies": { @@ -45,6 +45,6 @@ } }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-plugin-pwa/package.json b/packages/docusaurus-plugin-pwa/package.json index 824070ac91..0e9b4a2a97 100644 --- a/packages/docusaurus-plugin-pwa/package.json +++ b/packages/docusaurus-plugin-pwa/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-pwa", - "version": "3.8.1", + "version": "3.9.2", "description": "Docusaurus Plugin to add PWA support.", "main": "lib/index.js", "types": "src/plugin-pwa.d.ts", @@ -22,14 +22,14 @@ "dependencies": { "@babel/core": "^7.25.9", "@babel/preset-env": "^7.25.9", - "@docusaurus/bundler": "3.8.1", - "@docusaurus/core": "3.8.1", - "@docusaurus/logger": "3.8.1", - "@docusaurus/theme-common": "3.8.1", - "@docusaurus/theme-translations": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/bundler": "3.9.2", + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/theme-translations": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "babel-loader": "^9.2.1", "clsx": "^2.0.0", "core-js": "^3.31.1", @@ -41,7 +41,7 @@ "workbox-window": "^7.0.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.8.1", + "@docusaurus/module-type-aliases": "3.9.2", "fs-extra": "^11.1.0" }, "peerDependencies": { @@ -49,6 +49,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-plugin-pwa/src/registerSw.ts b/packages/docusaurus-plugin-pwa/src/registerSw.ts index d367df63a3..69a6cf3d82 100644 --- a/packages/docusaurus-plugin-pwa/src/registerSw.ts +++ b/packages/docusaurus-plugin-pwa/src/registerSw.ts @@ -9,12 +9,11 @@ import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment'; import {createStorageSlot} from '@docusaurus/theme-common'; // First: read the env variables (provided by Webpack) -/* eslint-disable prefer-destructuring */ + const PWA_SERVICE_WORKER_URL = process.env.PWA_SERVICE_WORKER_URL!; const PWA_OFFLINE_MODE_ACTIVATION_STRATEGIES = process.env .PWA_OFFLINE_MODE_ACTIVATION_STRATEGIES as unknown as (keyof typeof OfflineModeActivationStrategiesImplementations)[]; const PWA_DEBUG = process.env.PWA_DEBUG; -/* eslint-enable prefer-destructuring */ const MAX_MOBILE_WIDTH = 996; diff --git a/packages/docusaurus-plugin-rsdoctor/package.json b/packages/docusaurus-plugin-rsdoctor/package.json index 49bb6ed894..d55f6723df 100644 --- a/packages/docusaurus-plugin-rsdoctor/package.json +++ b/packages/docusaurus-plugin-rsdoctor/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-rsdoctor", - "version": "3.8.1", + "version": "3.9.2", "description": "Rsdoctor plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,9 +18,9 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "@rsdoctor/rspack-plugin": "^0.4.6", "@rsdoctor/webpack-plugin": "^0.4.6", "tslib": "^2.6.0" @@ -30,6 +30,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-plugin-sitemap/package.json b/packages/docusaurus-plugin-sitemap/package.json index 62cd1ceb1c..59eb05243f 100644 --- a/packages/docusaurus-plugin-sitemap/package.json +++ b/packages/docusaurus-plugin-sitemap/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-sitemap", - "version": "3.8.1", + "version": "3.9.2", "description": "Simple sitemap generation plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,12 +18,12 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/logger": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-common": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "fs-extra": "^11.1.1", "sitemap": "^7.1.1", "tslib": "^2.6.0" @@ -36,6 +36,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-plugin-sitemap/src/__tests__/createSitemap.test.ts b/packages/docusaurus-plugin-sitemap/src/__tests__/createSitemap.test.ts index 8bece909f3..0e88a757bc 100644 --- a/packages/docusaurus-plugin-sitemap/src/__tests__/createSitemap.test.ts +++ b/packages/docusaurus-plugin-sitemap/src/__tests__/createSitemap.test.ts @@ -6,12 +6,14 @@ */ import {fromPartial} from '@total-typescript/shoehorn'; +import {DEFAULT_VCS_CONFIG} from '@docusaurus/utils'; import createSitemap from '../createSitemap'; import type {PluginOptions} from '../options'; import type {DocusaurusConfig, RouteConfig} from '@docusaurus/types'; const siteConfig: DocusaurusConfig = fromPartial({ url: 'https://example.com', + future: {experimental_vcs: DEFAULT_VCS_CONFIG}, }); const options: PluginOptions = { diff --git a/packages/docusaurus-plugin-sitemap/src/__tests__/createSitemapItem.test.ts b/packages/docusaurus-plugin-sitemap/src/__tests__/createSitemapItem.test.ts index 4aa4df3a8f..39e123c3cc 100644 --- a/packages/docusaurus-plugin-sitemap/src/__tests__/createSitemapItem.test.ts +++ b/packages/docusaurus-plugin-sitemap/src/__tests__/createSitemapItem.test.ts @@ -6,6 +6,7 @@ */ import {fromPartial} from '@total-typescript/shoehorn'; +import {TEST_VCS} from '@docusaurus/utils'; import {createSitemapItem} from '../createSitemapItem'; import {DEFAULT_OPTIONS} from '../options'; import type {PluginOptions} from '../options'; @@ -13,6 +14,7 @@ import type {DocusaurusConfig, RouteConfig} from '@docusaurus/types'; const siteConfig: DocusaurusConfig = fromPartial({ url: 'https://example.com', + future: {experimental_vcs: TEST_VCS}, }); function test(params: { diff --git a/packages/docusaurus-plugin-sitemap/src/createSitemapItem.ts b/packages/docusaurus-plugin-sitemap/src/createSitemapItem.ts index ebd6bba44c..065306e3f4 100644 --- a/packages/docusaurus-plugin-sitemap/src/createSitemapItem.ts +++ b/packages/docusaurus-plugin-sitemap/src/createSitemapItem.ts @@ -6,16 +6,17 @@ */ import {applyTrailingSlash} from '@docusaurus/utils-common'; -import {getLastUpdate, normalizeUrl} from '@docusaurus/utils'; +import {normalizeUrl} from '@docusaurus/utils'; import type {LastModOption, SitemapItem} from './types'; -import type {DocusaurusConfig, RouteConfig} from '@docusaurus/types'; +import type {DocusaurusConfig, RouteConfig, VcsConfig} from '@docusaurus/types'; import type {PluginOptions} from './options'; async function getRouteLastUpdatedAt( route: RouteConfig, + vcs: Pick, ): Promise { // Important to bail-out early here - // This can lead to duplicated getLastUpdate() calls and performance problems + // This can lead to duplicated VCS calls and performance problems // See https://github.com/facebook/docusaurus/pull/11211 if (route.metadata?.lastUpdatedAt === null) { return null; @@ -24,8 +25,10 @@ async function getRouteLastUpdatedAt( return route.metadata?.lastUpdatedAt; } if (route.metadata?.sourceFilePath) { - const lastUpdate = await getLastUpdate(route.metadata?.sourceFilePath); - return lastUpdate?.lastUpdatedAt ?? null; + const lastUpdateInfo = await vcs.getFileLastUpdateInfo( + route.metadata?.sourceFilePath, + ); + return lastUpdateInfo?.timestamp ?? null; } return undefined; @@ -46,14 +49,16 @@ function formatLastmod(timestamp: number, lastmodOption: LastModOption) { async function getRouteLastmod({ route, lastmod, + vcs, }: { route: RouteConfig; lastmod: LastModOption | null; + vcs: Pick; }): Promise { if (lastmod === null) { return null; } - const lastUpdatedAt = (await getRouteLastUpdatedAt(route)) ?? null; + const lastUpdatedAt = (await getRouteLastUpdatedAt(route, vcs)) ?? null; return lastUpdatedAt ? formatLastmod(lastUpdatedAt, lastmod) : null; } @@ -77,6 +82,10 @@ export async function createSitemapItem({ ]), changefreq, priority, - lastmod: await getRouteLastmod({route, lastmod}), + lastmod: await getRouteLastmod({ + route, + lastmod, + vcs: siteConfig.future.experimental_vcs, + }), }; } diff --git a/packages/docusaurus-plugin-svgr/package.json b/packages/docusaurus-plugin-svgr/package.json index a395bbfc46..10f120aa54 100644 --- a/packages/docusaurus-plugin-svgr/package.json +++ b/packages/docusaurus-plugin-svgr/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-svgr", - "version": "3.8.1", + "version": "3.9.2", "description": "SVGR plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,10 +18,10 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "@svgr/core": "8.1.0", "@svgr/webpack": "^8.1.0", "tslib": "^2.6.0", @@ -32,6 +32,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-plugin-vercel-analytics/package.json b/packages/docusaurus-plugin-vercel-analytics/package.json index 3cd3a72593..c5758d03b1 100644 --- a/packages/docusaurus-plugin-vercel-analytics/package.json +++ b/packages/docusaurus-plugin-vercel-analytics/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-vercel-analytics", - "version": "3.8.1", + "version": "3.9.2", "description": "Global vercel analytics plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,11 +18,11 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/logger": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "@vercel/analytics": "^1.1.1", "tslib": "^2.6.0" }, @@ -31,6 +31,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-preset-classic/package.json b/packages/docusaurus-preset-classic/package.json index 0ce142ee55..976140532a 100644 --- a/packages/docusaurus-preset-classic/package.json +++ b/packages/docusaurus-preset-classic/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/preset-classic", - "version": "3.8.1", + "version": "3.9.2", "description": "Classic preset for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,27 +18,27 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/plugin-content-blog": "3.8.1", - "@docusaurus/plugin-content-docs": "3.8.1", - "@docusaurus/plugin-content-pages": "3.8.1", - "@docusaurus/plugin-css-cascade-layers": "3.8.1", - "@docusaurus/plugin-debug": "3.8.1", - "@docusaurus/plugin-google-analytics": "3.8.1", - "@docusaurus/plugin-google-gtag": "3.8.1", - "@docusaurus/plugin-google-tag-manager": "3.8.1", - "@docusaurus/plugin-sitemap": "3.8.1", - "@docusaurus/plugin-svgr": "3.8.1", - "@docusaurus/theme-classic": "3.8.1", - "@docusaurus/theme-common": "3.8.1", - "@docusaurus/theme-search-algolia": "3.8.1", - "@docusaurus/types": "3.8.1" + "@docusaurus/core": "3.9.2", + "@docusaurus/plugin-content-blog": "3.9.2", + "@docusaurus/plugin-content-docs": "3.9.2", + "@docusaurus/plugin-content-pages": "3.9.2", + "@docusaurus/plugin-css-cascade-layers": "3.9.2", + "@docusaurus/plugin-debug": "3.9.2", + "@docusaurus/plugin-google-analytics": "3.9.2", + "@docusaurus/plugin-google-gtag": "3.9.2", + "@docusaurus/plugin-google-tag-manager": "3.9.2", + "@docusaurus/plugin-sitemap": "3.9.2", + "@docusaurus/plugin-svgr": "3.9.2", + "@docusaurus/theme-classic": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/theme-search-algolia": "3.9.2", + "@docusaurus/types": "3.9.2" }, "peerDependencies": { "react": "^18.0.0 || ^19.0.0", "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-remark-plugin-npm2yarn/package.json b/packages/docusaurus-remark-plugin-npm2yarn/package.json index c8c62b2c2f..b110de66f9 100644 --- a/packages/docusaurus-remark-plugin-npm2yarn/package.json +++ b/packages/docusaurus-remark-plugin-npm2yarn/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/remark-plugin-npm2yarn", - "version": "3.8.1", + "version": "3.9.2", "description": "Remark plugin for converting npm commands to Yarn commands as tabs.", "main": "lib/index.js", "publishConfig": { @@ -30,6 +30,6 @@ "to-vfile": "^6.1.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-theme-classic/package.json b/packages/docusaurus-theme-classic/package.json index 1b76c00b8a..2fe48d0c5a 100644 --- a/packages/docusaurus-theme-classic/package.json +++ b/packages/docusaurus-theme-classic/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-classic", - "version": "3.8.1", + "version": "3.9.2", "description": "Classic theme for Docusaurus", "main": "lib/index.js", "types": "src/theme-classic.d.ts", @@ -20,22 +20,21 @@ "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch" }, "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/logger": "3.8.1", - "@docusaurus/mdx-loader": "3.8.1", - "@docusaurus/module-type-aliases": "3.8.1", - "@docusaurus/plugin-content-blog": "3.8.1", - "@docusaurus/plugin-content-docs": "3.8.1", - "@docusaurus/plugin-content-pages": "3.8.1", - "@docusaurus/theme-common": "3.8.1", - "@docusaurus/theme-translations": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-common": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/plugin-content-blog": "3.9.2", + "@docusaurus/plugin-content-docs": "3.9.2", + "@docusaurus/plugin-content-pages": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/theme-translations": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "@mdx-js/react": "^3.0.0", "clsx": "^2.0.0", - "copy-text-to-clipboard": "^3.2.0", "infima": "0.2.0-alpha.45", "lodash": "^4.17.21", "nprogress": "^0.2.0", @@ -60,6 +59,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-theme-classic/src/__tests__/__snapshots__/inlineScripts.test.ts.snap b/packages/docusaurus-theme-classic/src/__tests__/__snapshots__/inlineScripts.test.ts.snap new file mode 100644 index 0000000000..acad179bbe --- /dev/null +++ b/packages/docusaurus-theme-classic/src/__tests__/__snapshots__/inlineScripts.test.ts.snap @@ -0,0 +1,33 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`inlineScripts inline javascript for default options 1`] = ` +"(function() { + function getSystemColorMode() { + return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'; + } + function getQueryStringTheme() { + try { + return new URLSearchParams(window.location.search).get('docusaurus-theme') + } catch (e) {} + } + function getStoredTheme() { + try { + return window['localStorage'].getItem('theme'); + } catch (err) {} + } + var initialTheme = getQueryStringTheme() || getStoredTheme(); + document.documentElement.setAttribute('data-theme', initialTheme || 'light'); + document.documentElement.setAttribute('data-theme-choice', initialTheme || 'light'); +})();" +`; + +exports[`inlineScripts inline javascript for prefers color scheme and no switch 1`] = ` +"(function() { + function getSystemColorMode() { + return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'; + } + var initialTheme; + document.documentElement.setAttribute('data-theme', initialTheme || getSystemColorMode()); + document.documentElement.setAttribute('data-theme-choice', initialTheme || 'system'); +})();" +`; diff --git a/packages/docusaurus-theme-classic/src/__tests__/inlineScripts.test.ts b/packages/docusaurus-theme-classic/src/__tests__/inlineScripts.test.ts new file mode 100644 index 0000000000..5671d77d3c --- /dev/null +++ b/packages/docusaurus-theme-classic/src/__tests__/inlineScripts.test.ts @@ -0,0 +1,42 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import {getThemeInlineScript} from '../inlineScripts'; + +describe('inlineScripts', () => { + it('inline javascript for default options', () => { + expect( + getThemeInlineScript({ + colorMode: { + disableSwitch: false, + defaultMode: 'light', + respectPrefersColorScheme: false, + }, + siteStorage: { + type: 'localStorage', + namespace: '', + }, + }), + ).toMatchSnapshot(); + }); + + it('inline javascript for prefers color scheme and no switch', () => { + expect( + getThemeInlineScript({ + colorMode: { + disableSwitch: true, + defaultMode: 'light', + respectPrefersColorScheme: true, + }, + siteStorage: { + type: 'localStorage', + namespace: '', + }, + }), + ).toMatchSnapshot(); + }); +}); diff --git a/packages/docusaurus-theme-classic/src/index.ts b/packages/docusaurus-theme-classic/src/index.ts index ac2ea69a4c..f219d9039b 100644 --- a/packages/docusaurus-theme-classic/src/index.ts +++ b/packages/docusaurus-theme-classic/src/index.ts @@ -125,7 +125,6 @@ export default function themeClassic( { tagName: 'svg', attributes: { - xmlns: 'http://www.w3.org/2000/svg', style: 'display: none;', }, innerHTML: SvgSpriteDefs, diff --git a/packages/docusaurus-theme-classic/src/inlineScripts.ts b/packages/docusaurus-theme-classic/src/inlineScripts.ts index 4a2e4694b6..fe49094a52 100644 --- a/packages/docusaurus-theme-classic/src/inlineScripts.ts +++ b/packages/docusaurus-theme-classic/src/inlineScripts.ts @@ -15,7 +15,7 @@ const ThemeQueryStringKey = 'docusaurus-theme'; const DataQueryStringPrefixKey = 'docusaurus-data-'; export function getThemeInlineScript({ - colorMode: {defaultMode, respectPrefersColorScheme}, + colorMode: {disableSwitch, defaultMode, respectPrefersColorScheme}, siteStorage, }: { colorMode: ThemeConfig['colorMode']; @@ -25,28 +25,35 @@ export function getThemeInlineScript({ // Make sure the key is the same as the one in the color mode React context // Currently defined in: `docusaurus-theme-common/src/contexts/colorMode.tsx` const themeStorageKey = `theme${siteStorage.namespace}`; + const isThemeUserConfigurable = !disableSwitch; /* language=js */ return `(function() { - var defaultMode = '${defaultMode}'; - var respectPrefersColorScheme = ${respectPrefersColorScheme}; - function getSystemColorMode() { - return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'; - } - function getQueryStringTheme() { - try { - return new URLSearchParams(window.location.search).get('${ThemeQueryStringKey}') - } catch (e) {} - } - function getStoredTheme() { - try { - return window['${siteStorage.type}'].getItem('${themeStorageKey}'); - } catch (err) {} - } - var initialTheme = getQueryStringTheme() || getStoredTheme(); - document.documentElement.setAttribute('data-theme', initialTheme || (respectPrefersColorScheme ? getSystemColorMode() : defaultMode)); - document.documentElement.setAttribute('data-theme-choice', initialTheme || (respectPrefersColorScheme ? 'system' : defaultMode)); - })();`; + function getSystemColorMode() { + return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'; + } +${ + isThemeUserConfigurable + ? ` function getQueryStringTheme() { + try { + return new URLSearchParams(window.location.search).get('${ThemeQueryStringKey}') + } catch (e) {} + } + function getStoredTheme() { + try { + return window['${siteStorage.type}'].getItem('${themeStorageKey}'); + } catch (err) {} + } + var initialTheme = getQueryStringTheme() || getStoredTheme();` + : ' var initialTheme;' +} + document.documentElement.setAttribute('data-theme', initialTheme || ${ + respectPrefersColorScheme ? 'getSystemColorMode()' : `'${defaultMode}'` + }); + document.documentElement.setAttribute('data-theme-choice', initialTheme || ${ + respectPrefersColorScheme ? `'system'` : `'${defaultMode}'` + }); +})();`; } /* language=js */ diff --git a/packages/docusaurus-theme-classic/src/theme-classic.d.ts b/packages/docusaurus-theme-classic/src/theme-classic.d.ts index c801c97e79..c38431f8b7 100644 --- a/packages/docusaurus-theme-classic/src/theme-classic.d.ts +++ b/packages/docusaurus-theme-classic/src/theme-classic.d.ts @@ -1894,6 +1894,14 @@ declare module '@theme/Icon/Socials/Twitch' { export default function Twitch(props: Props): ReactNode; } +declare module '@theme/Icon/Socials/Email' { + import type {ComponentProps, ReactNode} from 'react'; + + export interface Props extends ComponentProps<'svg'> {} + + export default function Email(props: Props): ReactNode; +} + declare module '@theme/Icon/Socials/Mastodon' { import type {ComponentProps, ReactNode} from 'react'; diff --git a/packages/docusaurus-theme-classic/src/theme/Blog/Components/Author/Socials/index.tsx b/packages/docusaurus-theme-classic/src/theme/Blog/Components/Author/Socials/index.tsx index 1ba60c5ae7..e163a603de 100644 --- a/packages/docusaurus-theme-classic/src/theme/Blog/Components/Author/Socials/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/Blog/Components/Author/Socials/index.tsx @@ -23,6 +23,7 @@ import Threads from '@theme/Icon/Socials/Threads'; import Youtube from '@theme/Icon/Socials/YouTube'; import Mastodon from '@theme/Icon/Socials/Mastodon'; import Twitch from '@theme/Icon/Socials/Twitch'; +import Email from '@theme/Icon/Socials/Email'; import styles from './styles.module.css'; @@ -42,6 +43,7 @@ const SocialPlatformConfigs: Record = { mastodon: {Icon: Mastodon, label: 'Mastodon'}, youtube: {Icon: Youtube, label: 'YouTube'}, twitch: {Icon: Twitch, label: 'Twitch'}, + email: {Icon: Email, label: 'Email'}, }; function getSocialPlatformConfig(platformKey: string): SocialPlatformConfig { @@ -57,7 +59,7 @@ function SocialLink({platform, link}: {platform: string; link: string}) { const {Icon, label} = getSocialPlatformConfig(platform); return ( - + ); } diff --git a/packages/docusaurus-theme-classic/src/theme/Blog/Components/Author/index.tsx b/packages/docusaurus-theme-classic/src/theme/Blog/Components/Author/index.tsx index 6742eabe2b..54b7160c44 100644 --- a/packages/docusaurus-theme-classic/src/theme/Blog/Components/Author/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/Blog/Components/Author/index.tsx @@ -30,10 +30,14 @@ function AuthorTitle({title}: {title: string}) { function AuthorName({name, as}: {name: string; as: Props['as']}) { if (!as) { - return {name}; + return ( + + {name} + + ); } else { return ( - + {name} ); diff --git a/packages/docusaurus-theme-classic/src/theme/CodeBlock/Buttons/CopyButton/index.tsx b/packages/docusaurus-theme-classic/src/theme/CodeBlock/Buttons/CopyButton/index.tsx index 0bc1001ff5..a094000298 100644 --- a/packages/docusaurus-theme-classic/src/theme/CodeBlock/Buttons/CopyButton/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/CodeBlock/Buttons/CopyButton/index.tsx @@ -13,7 +13,6 @@ import React, { type ReactNode, } from 'react'; import clsx from 'clsx'; -import copy from 'copy-text-to-clipboard'; import {translate} from '@docusaurus/Translate'; import {useCodeBlockContext} from '@docusaurus/theme-common/internal'; import Button from '@theme/CodeBlock/Buttons/Button'; @@ -53,11 +52,12 @@ function useCopyButton() { const copyTimeout = useRef(undefined); const copyCode = useCallback(() => { - copy(code); - setIsCopied(true); - copyTimeout.current = window.setTimeout(() => { - setIsCopied(false); - }, 1000); + navigator.clipboard.writeText(code).then(() => { + setIsCopied(true); + copyTimeout.current = window.setTimeout(() => { + setIsCopied(false); + }, 1000); + }); }, [code]); useEffect(() => () => window.clearTimeout(copyTimeout.current), []); diff --git a/packages/docusaurus-theme-classic/src/theme/CodeBlock/Line/index.tsx b/packages/docusaurus-theme-classic/src/theme/CodeBlock/Line/index.tsx index 80000b80d3..803c06466e 100644 --- a/packages/docusaurus-theme-classic/src/theme/CodeBlock/Line/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/CodeBlock/Line/index.tsx @@ -14,16 +14,23 @@ import styles from './styles.module.css'; type Token = Props['line'][number]; -// Replaces '\n' by '' -// Historical code, not sure why we even need this :/ +// This
; +} + +// Replaces single lines with '\n' by '' so that we don't end up with +// duplicate line breaks (the '\n' + the artificial
above) +// see also https://github.com/facebook/docusaurus/pull/11565 function fixLineBreak(line: Token[]) { const singleLineBreakToken = line.length === 1 && line[0]!.content === '\n' ? line[0] : undefined; - if (singleLineBreakToken) { return [{...singleLineBreakToken, content: ''}]; } - return line; } @@ -35,7 +42,6 @@ export default function CodeBlockLine({ getTokenProps, }: Props): ReactNode { const line = fixLineBreak(lineProp); - const lineProps = getLineProps({ line, className: clsx(classNames, showLineNumbers && styles.codeLine), @@ -51,7 +57,7 @@ export default function CodeBlockLine({ }); return ( - +
{showLineNumbers ? ( <> @@ -60,7 +66,7 @@ export default function CodeBlockLine({ ) : ( lineTokens )} -
-
+ +
); } diff --git a/packages/docusaurus-theme-classic/src/theme/DocSidebarItem/Category/index.tsx b/packages/docusaurus-theme-classic/src/theme/DocSidebarItem/Category/index.tsx index cf29059928..8f6a2a84a7 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocSidebarItem/Category/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/DocSidebarItem/Category/index.tsx @@ -24,31 +24,51 @@ import { isActiveSidebarItem, findFirstSidebarItemLink, useDocSidebarItemsExpandedState, + useVisibleSidebarItems, } from '@docusaurus/plugin-content-docs/client'; import Link from '@docusaurus/Link'; import {translate} from '@docusaurus/Translate'; import useIsBrowser from '@docusaurus/useIsBrowser'; import DocSidebarItems from '@theme/DocSidebarItems'; +import DocSidebarItemLink from '@theme/DocSidebarItem/Link'; import type {Props} from '@theme/DocSidebarItem/Category'; +import type { + PropSidebarItemCategory, + PropSidebarItemLink, +} from '@docusaurus/plugin-content-docs'; +import styles from './styles.module.css'; + // If we navigate to a category and it becomes active, it should automatically // expand itself function useAutoExpandActiveCategory({ isActive, collapsed, updateCollapsed, + activePath, }: { isActive: boolean; collapsed: boolean; updateCollapsed: (b: boolean) => void; + activePath: string; }) { const wasActive = usePrevious(isActive); + const previousActivePath = usePrevious(activePath); useEffect(() => { const justBecameActive = isActive && !wasActive; - if (justBecameActive && collapsed) { + const stillActiveButPathChanged = + isActive && wasActive && activePath !== previousActivePath; + if ((justBecameActive || stillActiveButPathChanged) && collapsed) { updateCollapsed(false); } - }, [isActive, wasActive, collapsed, updateCollapsed]); + }, [ + isActive, + wasActive, + collapsed, + updateCollapsed, + activePath, + previousActivePath, + ]); } /** @@ -114,7 +134,56 @@ function CollapseButton({ ); } -export default function DocSidebarItemCategory({ +function CategoryLinkLabel({label}: {label: string}) { + return ( + + {label} + + ); +} + +export default function DocSidebarItemCategory(props: Props): ReactNode { + const visibleChildren = useVisibleSidebarItems( + props.item.items, + props.activePath, + ); + if (visibleChildren.length === 0) { + return ; + } else { + return ; + } +} + +function isCategoryWithHref( + category: PropSidebarItemCategory, +): category is PropSidebarItemCategory & {href: string} { + return typeof category.href === 'string'; +} + +// If a category doesn't have any visible children, we render it as a link +function DocSidebarItemCategoryEmpty({item, ...props}: Props): ReactNode { + // If the category has no link, we don't render anything + // It's not super useful to render a category you can't open nor click + if (!isCategoryWithHref(item)) { + return null; + } + // We remove props that don't make sense for a link and forward the rest + const { + type, + collapsed, + collapsible, + items, + linkUnlisted, + ...forwardableProps + } = item; + const linkItem: PropSidebarItemLink = { + type: 'link', + ...forwardableProps, + }; + return ; +} + +function DocSidebarItemCategoryCollapsible({ item, onItemClick, activePath, @@ -150,7 +219,12 @@ export default function DocSidebarItemCategory({ setExpandedItem(toCollapsed ? null : index); setCollapsed(toCollapsed); }; - useAutoExpandActiveCategory({isActive, collapsed, updateCollapsed}); + useAutoExpandActiveCategory({ + isActive, + collapsed, + updateCollapsed, + activePath, + }); useEffect(() => { if ( collapsible && @@ -162,6 +236,29 @@ export default function DocSidebarItemCategory({ } }, [collapsible, expandedItem, index, setCollapsed, autoCollapseCategories]); + const handleItemClick: ComponentProps<'a'>['onClick'] = (e) => { + onItemClick?.(item); + if (collapsible) { + if (href) { + // When already on the category's page, we collapse it + // We don't use "isActive" because it would collapse the + // category even when we browse a children element + // See https://github.com/facebook/docusaurus/issues/11213 + if (isCurrentPage) { + e.preventDefault(); + updateCollapsed(); + } else { + // When navigating to a new category, we always expand + // see https://github.com/facebook/docusaurus/issues/10854#issuecomment-2609616182 + updateCollapsed(false); + } + } else { + e.preventDefault(); + updateCollapsed(); + } + } + }; + return (
  • { - onItemClick?.(item); - if (href) { - // When already on the category's page, we collapse it - // We don't use "isActive" because it would collapse the - // category even when we browse a children element - // See https://github.com/facebook/docusaurus/issues/11213 - if (isCurrentPage) { - e.preventDefault(); - updateCollapsed(); - } else { - // When navigating to a new category, we always expand - // see https://github.com/facebook/docusaurus/issues/10854#issuecomment-2609616182 - updateCollapsed(false); - } - } else { - e.preventDefault(); - updateCollapsed(); - } - } - : () => { - onItemClick?.(item); - } - } + onClick={handleItemClick} aria-current={isCurrentPage ? 'page' : undefined} role={collapsible && !href ? 'button' : undefined} aria-expanded={collapsible && !href ? !collapsed : undefined} href={collapsible ? hrefWithSSRFallback ?? '#' : hrefWithSSRFallback} {...props}> - {label} + {href && collapsible && ( + {label} + + ); +} + export default function DocSidebarItemLink({ item, onItemClick, @@ -51,7 +59,7 @@ export default function DocSidebarItemLink({ onClick: onItemClick ? () => onItemClick(item) : undefined, })} {...props}> - {label} + {!isInternalLink && }
  • diff --git a/packages/docusaurus-theme-classic/src/theme/DocSidebarItem/Link/styles.module.css b/packages/docusaurus-theme-classic/src/theme/DocSidebarItem/Link/styles.module.css index 4abcb56762..a48f210974 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocSidebarItem/Link/styles.module.css +++ b/packages/docusaurus-theme-classic/src/theme/DocSidebarItem/Link/styles.module.css @@ -8,3 +8,11 @@ .menuExternalLink { align-items: center; } + +.linkLabel { + overflow: hidden; + display: -webkit-box; + line-clamp: 2; + -webkit-box-orient: vertical; + -webkit-line-clamp: 2; +} diff --git a/packages/docusaurus-theme-classic/src/theme/EditMetaRow/index.tsx b/packages/docusaurus-theme-classic/src/theme/EditMetaRow/index.tsx index 78d3206c2f..d12ef51abf 100644 --- a/packages/docusaurus-theme-classic/src/theme/EditMetaRow/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/EditMetaRow/index.tsx @@ -20,7 +20,9 @@ export default function EditMetaRow({ }: Props): ReactNode { return (
    -
    {editUrl && }
    +
    + {editUrl && } +
    {(lastUpdatedAt || lastUpdatedBy) && ( ; @@ -41,20 +39,15 @@ export default function Heading({as: As, id, ...props}: Props): ReactNode { return ( {props.children} + title={anchorTitle} + translate="no"> ​ diff --git a/packages/docusaurus-theme-classic/src/theme/Heading/styles.module.css b/packages/docusaurus-theme-classic/src/theme/Heading/styles.module.css index 3fee4392f3..8dd324f54f 100644 --- a/packages/docusaurus-theme-classic/src/theme/Heading/styles.module.css +++ b/packages/docusaurus-theme-classic/src/theme/Heading/styles.module.css @@ -5,19 +5,6 @@ * LICENSE file in the root directory of this source tree. */ -/* -When the navbar is sticky, ensure that on anchor click, -the browser does not scroll that anchor behind the navbar -See https://x.com/JoshWComeau/status/1332015868725891076 - */ -.anchorWithStickyNavbar { - scroll-margin-top: calc(var(--ifm-navbar-height) + 0.5rem); -} - -.anchorWithHideOnScrollNavbar { - scroll-margin-top: 0.5rem; -} - :global(.hash-link) { opacity: 0; padding-left: 0.5rem; diff --git a/packages/docusaurus-theme-classic/src/theme/Icon/ExternalLink/index.tsx b/packages/docusaurus-theme-classic/src/theme/Icon/ExternalLink/index.tsx index 87523b6eec..b899a1fee7 100644 --- a/packages/docusaurus-theme-classic/src/theme/Icon/ExternalLink/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/Icon/ExternalLink/index.tsx @@ -6,6 +6,7 @@ */ import React, {type ReactNode} from 'react'; +import {translate} from '@docusaurus/Translate'; import type {Props} from '@theme/Icon/ExternalLink'; import styles from './styles.module.css'; @@ -22,7 +23,11 @@ export default function IconExternalLink({ diff --git a/packages/docusaurus-theme-classic/src/theme/Icon/Socials/Bluesky/index.tsx b/packages/docusaurus-theme-classic/src/theme/Icon/Socials/Bluesky/index.tsx index 0f0c400bb4..141bb4ed33 100644 --- a/packages/docusaurus-theme-classic/src/theme/Icon/Socials/Bluesky/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/Icon/Socials/Bluesky/index.tsx @@ -5,7 +5,9 @@ * LICENSE file in the root directory of this source tree. */ -import type {SVGProps, ReactNode} from 'react'; +import type {SVGProps, ReactNode, CSSProperties} from 'react'; +import clsx from 'clsx'; +import styles from './styles.module.css'; // SVG Source: https://svgl.app/ function Bluesky(props: SVGProps): ReactNode { @@ -16,11 +18,10 @@ function Bluesky(props: SVGProps): ReactNode { height="1em" preserveAspectRatio="xMidYMid" viewBox="0 0 256 226" - {...props}> - + style={{'--dark': '#0085ff', '--light': '#0085ff'} as CSSProperties} + {...props} + className={clsx(props.className, styles.blueskySvg)}> + ); } diff --git a/packages/docusaurus-theme-classic/src/theme/Icon/Socials/Bluesky/styles.module.css b/packages/docusaurus-theme-classic/src/theme/Icon/Socials/Bluesky/styles.module.css new file mode 100644 index 0000000000..b7ad757675 --- /dev/null +++ b/packages/docusaurus-theme-classic/src/theme/Icon/Socials/Bluesky/styles.module.css @@ -0,0 +1,14 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +[data-theme='dark'] .blueskySvg { + fill: var(--light); +} + +[data-theme='light'] .blueskySvg { + fill: var(--dark); +} diff --git a/packages/docusaurus-theme-classic/src/theme/Icon/Socials/Default/index.tsx b/packages/docusaurus-theme-classic/src/theme/Icon/Socials/Default/index.tsx index 29f676caa9..b66fd118e9 100644 --- a/packages/docusaurus-theme-classic/src/theme/Icon/Socials/Default/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/Icon/Socials/Default/index.tsx @@ -7,7 +7,7 @@ import type {ReactNode, SVGProps} from 'react'; -// SVG Source: https://tabler.io/ +// SVG Source: https://github.com/tabler/tabler-icons function DefaultSocial(props: SVGProps): ReactNode { return ( ): ReactNode { strokeLinejoin="round" {...props}> - - - - - + + + + + ); } diff --git a/packages/docusaurus-theme-classic/src/theme/Icon/Socials/Email/index.tsx b/packages/docusaurus-theme-classic/src/theme/Icon/Socials/Email/index.tsx new file mode 100644 index 0000000000..b44991aa8b --- /dev/null +++ b/packages/docusaurus-theme-classic/src/theme/Icon/Socials/Email/index.tsx @@ -0,0 +1,28 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import type {ReactNode, SVGProps} from 'react'; + +// SVG Source: https://github.com/tabler/tabler-icons +function Email(props: SVGProps): ReactNode { + return ( + + + + + + ); +} +export default Email; diff --git a/packages/docusaurus-theme-classic/src/theme/Icon/Socials/LinkedIn/index.tsx b/packages/docusaurus-theme-classic/src/theme/Icon/Socials/LinkedIn/index.tsx index 1970a5bcd1..ad339a2e98 100644 --- a/packages/docusaurus-theme-classic/src/theme/Icon/Socials/LinkedIn/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/Icon/Socials/LinkedIn/index.tsx @@ -5,7 +5,9 @@ * LICENSE file in the root directory of this source tree. */ -import type {ReactNode, SVGProps} from 'react'; +import type {SVGProps, ReactNode, CSSProperties} from 'react'; +import clsx from 'clsx'; +import styles from './styles.module.css'; // SVG Source: https://svgl.app/ function LinkedIn(props: SVGProps): ReactNode { @@ -16,11 +18,10 @@ function LinkedIn(props: SVGProps): ReactNode { height="1em" preserveAspectRatio="xMidYMid" viewBox="0 0 256 256" - {...props}> - + style={{'--dark': '#0a66c2', '--light': '#ffffffe6'} as CSSProperties} + {...props} + className={clsx(props.className, styles.linkedinSvg)}> + ); } diff --git a/packages/docusaurus-theme-classic/src/theme/Icon/Socials/LinkedIn/styles.module.css b/packages/docusaurus-theme-classic/src/theme/Icon/Socials/LinkedIn/styles.module.css new file mode 100644 index 0000000000..dc1d40dc1e --- /dev/null +++ b/packages/docusaurus-theme-classic/src/theme/Icon/Socials/LinkedIn/styles.module.css @@ -0,0 +1,14 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +[data-theme='dark'] .linkedinSvg { + fill: var(--light); +} + +[data-theme='light'] .linkedinSvg { + fill: var(--dark); +} diff --git a/packages/docusaurus-theme-classic/src/theme/MDXComponents/A/index.tsx b/packages/docusaurus-theme-classic/src/theme/MDXComponents/A/index.tsx index 21e4dac8bd..d794daaeee 100644 --- a/packages/docusaurus-theme-classic/src/theme/MDXComponents/A/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/MDXComponents/A/index.tsx @@ -8,35 +8,14 @@ import React, {type ReactNode} from 'react'; import clsx from 'clsx'; import Link from '@docusaurus/Link'; -import {useThemeConfig} from '@docusaurus/theme-common'; +import {useAnchorTargetClassName} from '@docusaurus/theme-common'; import type {Props} from '@theme/MDXComponents/A'; -import styles from './styles.module.css'; - -function isFootnoteRef(props: Props) { - return props['data-footnote-ref'] === true; -} - -function FootnoteRefLink(props: Props) { - const { - navbar: {hideOnScroll}, - } = useThemeConfig(); - return ( - - ); -} export default function MDXA(props: Props): ReactNode { - if (isFootnoteRef(props)) { - return ; - } - return ; + // MDX Footnotes have ids such as + const anchorTargetClassName = useAnchorTargetClassName(props.id); + + return ( + + ); } diff --git a/packages/docusaurus-theme-classic/src/theme/MDXComponents/A/styles.module.css b/packages/docusaurus-theme-classic/src/theme/MDXComponents/A/styles.module.css deleted file mode 100644 index 295757363a..0000000000 --- a/packages/docusaurus-theme-classic/src/theme/MDXComponents/A/styles.module.css +++ /dev/null @@ -1,20 +0,0 @@ -/** - * Copyright (c) Facebook, Inc. and its affiliates. - * - * This source code is licensed under the MIT license found in the - * LICENSE file in the root directory of this source tree. - */ - -/* -When the navbar is sticky, ensure that on footnote click, -the browser does not scroll to the ref behind the navbar -See https://github.com/facebook/docusaurus/issues/11232 -See also headings case https://x.com/JoshWComeau/status/1332015868725891076 - */ -.footnoteRefStickyNavbar { - scroll-margin-top: calc(var(--ifm-navbar-height) + 0.5rem); -} - -.footnoteRefHideOnScrollNavbar { - scroll-margin-top: 0.5rem; -} diff --git a/packages/docusaurus-theme-classic/src/theme/MDXComponents/Li.tsx b/packages/docusaurus-theme-classic/src/theme/MDXComponents/Li.tsx index 74a8a4add4..bb2a3d6497 100644 --- a/packages/docusaurus-theme-classic/src/theme/MDXComponents/Li.tsx +++ b/packages/docusaurus-theme-classic/src/theme/MDXComponents/Li.tsx @@ -6,12 +6,17 @@ */ import React, {type ReactNode} from 'react'; +import clsx from 'clsx'; import useBrokenLinks from '@docusaurus/useBrokenLinks'; +import {useAnchorTargetClassName} from '@docusaurus/theme-common'; import type {Props} from '@theme/MDXComponents/Li'; export default function MDXLi(props: Props): ReactNode | undefined { // MDX Footnotes have ids such as
  • useBrokenLinks().collectAnchor(props.id); + const anchorTargetClassName = useAnchorTargetClassName(props.id); - return
  • ; + return ( +
  • + ); } diff --git a/packages/docusaurus-theme-classic/src/theme/Navbar/Search/styles.module.css b/packages/docusaurus-theme-classic/src/theme/Navbar/Search/styles.module.css index b59d29e3fc..c58238dcf9 100644 --- a/packages/docusaurus-theme-classic/src/theme/Navbar/Search/styles.module.css +++ b/packages/docusaurus-theme-classic/src/theme/Navbar/Search/styles.module.css @@ -22,7 +22,6 @@ See https://github.com/facebook/docusaurus/pull/9385 @media (min-width: 997px) { .navbarSearchContainer { - padding: var(--ifm-navbar-item-padding-vertical) - var(--ifm-navbar-item-padding-horizontal); + padding: 0 var(--ifm-navbar-item-padding-horizontal); } } diff --git a/packages/docusaurus-theme-classic/src/theme/NavbarItem/DropdownNavbarItem/Desktop/index.tsx b/packages/docusaurus-theme-classic/src/theme/NavbarItem/DropdownNavbarItem/Desktop/index.tsx index 0ecc3b9fc6..4ecf043389 100644 --- a/packages/docusaurus-theme-classic/src/theme/NavbarItem/DropdownNavbarItem/Desktop/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/NavbarItem/DropdownNavbarItem/Desktop/index.tsx @@ -64,7 +64,7 @@ export default function DropdownNavbarItemDesktop({ {...props} onClick={props.to ? undefined : (e) => e.preventDefault()} onKeyDown={(e) => { - if (e.key === 'Enter') { + if (e.key === 'Enter' || e.key === ' ') { e.preventDefault(); setShowDropdown(!showDropdown); } diff --git a/packages/docusaurus-theme-classic/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx b/packages/docusaurus-theme-classic/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx index 21b14d417e..9c16b5387c 100644 --- a/packages/docusaurus-theme-classic/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx @@ -9,7 +9,7 @@ import React, {type ReactNode} from 'react'; import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import {useAlternatePageUtils} from '@docusaurus/theme-common/internal'; import {translate} from '@docusaurus/Translate'; -import {useHistorySelector} from '@docusaurus/theme-common'; +import {mergeSearchStrings, useHistorySelector} from '@docusaurus/theme-common'; import DropdownNavbarItem from '@theme/NavbarItem/DropdownNavbarItem'; import IconLanguage from '@theme/Icon/Language'; import type {LinkLikeNavbarItemProps} from '@theme/NavbarItem'; @@ -17,31 +17,80 @@ import type {Props} from '@theme/NavbarItem/LocaleDropdownNavbarItem'; import styles from './styles.module.css'; -export default function LocaleDropdownNavbarItem({ - mobile, - dropdownItemsBefore, - dropdownItemsAfter, - queryString = '', - ...props -}: Props): ReactNode { +function useLocaleDropdownUtils() { const { - i18n: {currentLocale, locales, localeConfigs}, + siteConfig, + i18n: {localeConfigs}, } = useDocusaurusContext(); const alternatePageUtils = useAlternatePageUtils(); const search = useHistorySelector((history) => history.location.search); const hash = useHistorySelector((history) => history.location.hash); - const localeItems = locales.map((locale): LinkLikeNavbarItemProps => { - const baseTo = `pathname://${alternatePageUtils.createUrl({ + const getLocaleConfig = (locale: string) => { + const localeConfig = localeConfigs[locale]; + if (!localeConfig) { + throw new Error( + `Docusaurus bug, no locale config found for locale=${locale}`, + ); + } + return localeConfig; + }; + + const getBaseURLForLocale = (locale: string) => { + const localeConfig = getLocaleConfig(locale); + const isSameDomain = localeConfig.url === siteConfig.url; + if (isSameDomain) { + // Shorter paths if localized sites are hosted on the same domain + // This reduces HTML size a bit + return `pathname://${alternatePageUtils.createUrl({ + locale, + fullyQualified: false, + })}`; + } + return alternatePageUtils.createUrl({ locale, - fullyQualified: false, - })}`; - // preserve ?search#hash suffix on locale switches - const to = `${baseTo}${search}${hash}${queryString}`; + fullyQualified: true, + }); + }; + + return { + getURL: (locale: string, options: {queryString: string | undefined}) => { + // We have 2 query strings because + // - there's the current one + // - there's one user can provide through navbar config + // see https://github.com/facebook/docusaurus/pull/8915 + const finalSearch = mergeSearchStrings( + [search, options.queryString], + 'append', + ); + return `${getBaseURLForLocale(locale)}${finalSearch}${hash}`; + }, + getLabel: (locale: string) => { + return getLocaleConfig(locale).label; + }, + getLang: (locale: string) => { + return getLocaleConfig(locale).htmlLang; + }, + }; +} + +export default function LocaleDropdownNavbarItem({ + mobile, + dropdownItemsBefore, + dropdownItemsAfter, + queryString, + ...props +}: Props): ReactNode { + const utils = useLocaleDropdownUtils(); + + const { + i18n: {currentLocale, locales}, + } = useDocusaurusContext(); + const localeItems = locales.map((locale): LinkLikeNavbarItemProps => { return { - label: localeConfigs[locale]!.label, - lang: localeConfigs[locale]!.htmlLang, - to, + label: utils.getLabel(locale), + lang: utils.getLang(locale), + to: utils.getURL(locale, {queryString}), target: '_self', autoAddBaseUrl: false, className: @@ -66,7 +115,7 @@ export default function LocaleDropdownNavbarItem({ id: 'theme.navbar.mobileLanguageDropdown.label', description: 'The label for the mobile language switcher dropdown', }) - : localeConfigs[currentLocale]!.label; + : utils.getLabel(currentLocale); return ( +
    diff --git a/packages/docusaurus-theme-common/package.json b/packages/docusaurus-theme-common/package.json index af0017380d..8dce1e00af 100644 --- a/packages/docusaurus-theme-common/package.json +++ b/packages/docusaurus-theme-common/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-common", - "version": "3.8.1", + "version": "3.9.2", "description": "Common code for Docusaurus themes.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -30,10 +30,10 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/mdx-loader": "3.8.1", - "@docusaurus/module-type-aliases": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-common": "3.8.1", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", "@types/history": "^4.7.11", "@types/react": "*", "@types/react-router-config": "*", @@ -44,8 +44,9 @@ "utility-types": "^3.10.0" }, "devDependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/types": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@total-typescript/shoehorn": "^0.1.2", "fs-extra": "^11.1.1", "lodash": "^4.17.21" }, @@ -55,6 +56,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-theme-common/src/contexts/colorMode.tsx b/packages/docusaurus-theme-common/src/contexts/colorMode.tsx index 4a2482f907..6f4def96b9 100644 --- a/packages/docusaurus-theme-common/src/contexts/colorMode.tsx +++ b/packages/docusaurus-theme-common/src/contexts/colorMode.tsx @@ -13,6 +13,7 @@ import React, { useMemo, type ReactNode, } from 'react'; +import useIsBrowser from '@docusaurus/useIsBrowser'; import {ReactContextError} from '../utils/reactUtils'; import {createStorageSlot} from '../utils/storageUtils'; import {useThemeConfig} from '../utils/useThemeConfig'; @@ -124,10 +125,17 @@ function useColorModeState() { const { colorMode: {defaultMode}, } = useThemeConfig(); + const isBrowser = useIsBrowser(); - const [colorMode, setColorModeState] = useState(defaultMode); - const [colorModeChoice, setColorModeChoiceState] = - useState(null); + // Since the provider may unmount/remount on client navigation, we need to + // reinitialize the state with the correct values to avoid visual glitches. + // See also https://github.com/facebook/docusaurus/issues/11399#issuecomment-3279181314 + const [colorMode, setColorModeState] = useState( + isBrowser ? ColorModeAttribute.get() : defaultMode, + ); + const [colorModeChoice, setColorModeChoiceState] = useState( + isBrowser ? ColorModeChoiceAttribute.get() : null, + ); useEffect(() => { setColorModeState(ColorModeAttribute.get()); diff --git a/packages/docusaurus-theme-common/src/index.ts b/packages/docusaurus-theme-common/src/index.ts index e2605ba622..1c9e15f1dc 100644 --- a/packages/docusaurus-theme-common/src/index.ts +++ b/packages/docusaurus-theme-common/src/index.ts @@ -109,6 +109,8 @@ export { useSearchLinkCreator, } from './hooks/useSearchPage'; +export {useAnchorTargetClassName} from './utils/anchorUtils'; + export {isMultiColumnFooterLinks} from './utils/footerUtils'; export {isRegexpStringMatch} from './utils/regexpUtils'; @@ -124,6 +126,8 @@ export { useQueryString, useQueryStringList, useClearQueryString, + mergeSearchParams, + mergeSearchStrings, } from './utils/historyUtils'; export { diff --git a/packages/docusaurus-theme-common/src/utils/ThemeClassNames.ts b/packages/docusaurus-theme-common/src/utils/ThemeClassNames.ts index a0a1834d1c..a414908d88 100644 --- a/packages/docusaurus-theme-common/src/utils/ThemeClassNames.ts +++ b/packages/docusaurus-theme-common/src/utils/ThemeClassNames.ts @@ -55,6 +55,10 @@ export const ThemeClassNames = { container: 'theme-announcement-bar', }, + tabs: { + container: 'theme-tabs-container', + }, + layout: { navbar: { container: 'theme-layout-navbar', diff --git a/packages/docusaurus-theme-common/src/utils/__tests__/historyUtils.test.ts b/packages/docusaurus-theme-common/src/utils/__tests__/historyUtils.test.ts new file mode 100644 index 0000000000..c79629a086 --- /dev/null +++ b/packages/docusaurus-theme-common/src/utils/__tests__/historyUtils.test.ts @@ -0,0 +1,80 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import {mergeSearchParams, mergeSearchStrings} from '../historyUtils'; + +describe('mergeSearchParams', () => { + it('can append search params', () => { + expect( + mergeSearchParams( + [ + new URLSearchParams('?key1=val1&key2=val2'), + new URLSearchParams('key2=val2-bis&key3=val3'), + new URLSearchParams(''), + new URLSearchParams('?key3=val3-bis&key4=val4'), + ], + 'append', + ).toString(), + ).toBe( + 'key1=val1&key2=val2&key2=val2-bis&key3=val3&key3=val3-bis&key4=val4', + ); + }); + + it('can overwrite search params', () => { + expect( + mergeSearchParams( + [ + new URLSearchParams('?key1=val1&key2=val2'), + new URLSearchParams('key2=val2-bis&key3=val3'), + new URLSearchParams(''), + new URLSearchParams('?key3=val3-bis&key4=val4'), + ], + 'set', + ).toString(), + ).toBe('key1=val1&key2=val2-bis&key3=val3-bis&key4=val4'); + }); +}); + +describe('mergeSearchStrings', () => { + it('can append search params', () => { + expect( + mergeSearchStrings( + [ + '?key1=val1&key2=val2', + 'key2=val2-bis&key3=val3', + '', + '?key3=val3-bis&key4=val4', + ], + 'append', + ), + ).toBe( + '?key1=val1&key2=val2&key2=val2-bis&key3=val3&key3=val3-bis&key4=val4', + ); + }); + + it('can overwrite search params', () => { + expect( + mergeSearchStrings( + [ + '?key1=val1&key2=val2', + 'key2=val2-bis&key3=val3', + '', + '?key3=val3-bis&key4=val4', + ], + 'set', + ), + ).toBe('?key1=val1&key2=val2-bis&key3=val3-bis&key4=val4'); + }); + + it('automatically adds ? if there are params', () => { + expect(mergeSearchStrings(['key1=val1'], 'append')).toBe('?key1=val1'); + }); + + it('automatically removes ? if there are no params', () => { + expect(mergeSearchStrings([undefined, ''], 'append')).toBe(''); + }); +}); diff --git a/packages/docusaurus-theme-common/src/utils/__tests__/useAlternatePageUtils.test.tsx b/packages/docusaurus-theme-common/src/utils/__tests__/useAlternatePageUtils.test.tsx index fb964b015f..a16832a648 100644 --- a/packages/docusaurus-theme-common/src/utils/__tests__/useAlternatePageUtils.test.tsx +++ b/packages/docusaurus-theme-common/src/utils/__tests__/useAlternatePageUtils.test.tsx @@ -9,116 +9,185 @@ import React from 'react'; import {renderHook} from '@testing-library/react-hooks'; import {StaticRouter} from 'react-router-dom'; import {Context} from '@docusaurus/core/src/client/docusaurusContext'; +import {fromPartial} from '@total-typescript/shoehorn'; import {useAlternatePageUtils} from '../useAlternatePageUtils'; import type {DocusaurusContext} from '@docusaurus/types'; describe('useAlternatePageUtils', () => { - const createUseAlternatePageUtilsMock = - (context: DocusaurusContext) => (location: string) => - renderHook(() => useAlternatePageUtils(), { - wrapper: ({children}) => ( - - {children} - - ), - }).result.current; - it('works for baseUrl: / and currentLocale = defaultLocale', () => { - const mockUseAlternatePageUtils = createUseAlternatePageUtilsMock({ - siteConfig: {baseUrl: '/', url: 'https://example.com'}, - i18n: {defaultLocale: 'en', currentLocale: 'en'}, - } as DocusaurusContext); + const createTestUtils = (context: DocusaurusContext) => { + return { + forLocation: (location: string) => { + return renderHook(() => useAlternatePageUtils(), { + wrapper: ({children}) => ( + + {children} + + ), + }).result.current; + }, + }; + }; + + it('works for baseUrl: / and currentLocale === defaultLocale', () => { + const testUtils = createTestUtils( + fromPartial({ + siteConfig: { + url: 'https://example.com', + baseUrl: '/', + }, + i18n: { + defaultLocale: 'en', + currentLocale: 'en', + localeConfigs: { + en: { + url: 'https://example.com', + baseUrl: '/', + }, + 'zh-Hans': { + url: 'https://zh.example.com', + baseUrl: '/zh-Hans-baseUrl/', + }, + }, + }, + }), + ); + expect( - mockUseAlternatePageUtils('/').createUrl({ + testUtils.forLocation('/').createUrl({ locale: 'zh-Hans', fullyQualified: false, }), - ).toBe('/zh-Hans/'); + ).toBe('/zh-Hans-baseUrl/'); expect( - mockUseAlternatePageUtils('/foo').createUrl({ + testUtils.forLocation('/foo').createUrl({ locale: 'zh-Hans', fullyQualified: false, }), - ).toBe('/zh-Hans/foo'); + ).toBe('/zh-Hans-baseUrl/foo'); expect( - mockUseAlternatePageUtils('/foo').createUrl({ + testUtils.forLocation('/foo').createUrl({ locale: 'zh-Hans', fullyQualified: true, }), - ).toBe('https://example.com/zh-Hans/foo'); + ).toBe('https://zh.example.com/zh-Hans-baseUrl/foo'); }); - it('works for baseUrl: / and currentLocale /= defaultLocale', () => { - const mockUseAlternatePageUtils = createUseAlternatePageUtilsMock({ - siteConfig: {baseUrl: '/zh-Hans/', url: 'https://example.com'}, - i18n: {defaultLocale: 'en', currentLocale: 'zh-Hans'}, - } as DocusaurusContext); + it('works for baseUrl: / and currentLocale !== defaultLocale', () => { + const testUtils = createTestUtils( + fromPartial({ + siteConfig: { + url: 'https://zh.example.com', + baseUrl: '/zh-Hans-baseUrl/', + }, + i18n: { + defaultLocale: 'en', + currentLocale: 'zh-Hans', + localeConfigs: { + en: {url: 'https://example.com', baseUrl: '/'}, + 'zh-Hans': { + url: 'https://zh.example.com', + baseUrl: '/zh-Hans-baseUrl/', + }, + }, + }, + }), + ); + expect( - mockUseAlternatePageUtils('/zh-Hans/').createUrl({ + testUtils.forLocation('/zh-Hans-baseUrl/').createUrl({ locale: 'en', fullyQualified: false, }), ).toBe('/'); expect( - mockUseAlternatePageUtils('/zh-Hans/foo').createUrl({ + testUtils.forLocation('/zh-Hans-baseUrl/foo').createUrl({ locale: 'en', fullyQualified: false, }), ).toBe('/foo'); expect( - mockUseAlternatePageUtils('/zh-Hans/foo').createUrl({ + testUtils.forLocation('/zh-Hans-baseUrl/foo').createUrl({ locale: 'en', fullyQualified: true, }), ).toBe('https://example.com/foo'); }); - it('works for non-root base URL and currentLocale = defaultLocale', () => { - const mockUseAlternatePageUtils = createUseAlternatePageUtilsMock({ - siteConfig: {baseUrl: '/base/', url: 'https://example.com'}, - i18n: {defaultLocale: 'en', currentLocale: 'en'}, - } as DocusaurusContext); + it('works for non-root base URL and currentLocale === defaultLocale', () => { + const testUtils = createTestUtils( + fromPartial({ + siteConfig: {baseUrl: '/en/', url: 'https://example.com'}, + i18n: { + defaultLocale: 'en', + currentLocale: 'en', + localeConfigs: { + en: {url: 'https://example.com', baseUrl: '/base/'}, + 'zh-Hans': { + url: 'https://zh.example.com', + baseUrl: '/zh-Hans-baseUrl/', + }, + }, + }, + }), + ); expect( - mockUseAlternatePageUtils('/base/').createUrl({ + testUtils.forLocation('/en/').createUrl({ locale: 'zh-Hans', fullyQualified: false, }), - ).toBe('/base/zh-Hans/'); + ).toBe('/zh-Hans-baseUrl/'); expect( - mockUseAlternatePageUtils('/base/foo').createUrl({ + testUtils.forLocation('/en/foo').createUrl({ locale: 'zh-Hans', fullyQualified: false, }), - ).toBe('/base/zh-Hans/foo'); + ).toBe('/zh-Hans-baseUrl/foo'); expect( - mockUseAlternatePageUtils('/base/foo').createUrl({ + testUtils.forLocation('/en/foo').createUrl({ locale: 'zh-Hans', fullyQualified: true, }), - ).toBe('https://example.com/base/zh-Hans/foo'); + ).toBe('https://zh.example.com/zh-Hans-baseUrl/foo'); }); - it('works for non-root base URL and currentLocale /= defaultLocale', () => { - const mockUseAlternatePageUtils = createUseAlternatePageUtilsMock({ - siteConfig: {baseUrl: '/base/zh-Hans/', url: 'https://example.com'}, - i18n: {defaultLocale: 'en', currentLocale: 'zh-Hans'}, - } as DocusaurusContext); + it('works for non-root base URL and currentLocale !== defaultLocale', () => { + const testUtils = createTestUtils( + fromPartial({ + siteConfig: { + baseUrl: '/zh-Hans-baseUrl/', + url: 'https://zh.example.com', + }, + i18n: { + defaultLocale: 'en', + currentLocale: 'zh-Hans', + localeConfigs: { + en: {url: 'https://en.example.com', baseUrl: '/en/'}, + 'zh-Hans': { + url: 'https://zh.example.com', + baseUrl: '/zh-Hans-baseUrl/', + }, + }, + }, + }), + ); + expect( - mockUseAlternatePageUtils('/base/zh-Hans/').createUrl({ + testUtils.forLocation('/zh-Hans-baseUrl/').createUrl({ locale: 'en', fullyQualified: false, }), - ).toBe('/base/'); + ).toBe('/en/'); expect( - mockUseAlternatePageUtils('/base/zh-Hans/foo').createUrl({ + testUtils.forLocation('/zh-Hans-baseUrl/foo').createUrl({ locale: 'en', fullyQualified: false, }), - ).toBe('/base/foo'); + ).toBe('/en/foo'); expect( - mockUseAlternatePageUtils('/base/zh-Hans/foo').createUrl({ + testUtils.forLocation('/zh-Hans-baseUrl/foo').createUrl({ locale: 'en', fullyQualified: true, }), - ).toBe('https://example.com/base/foo'); + ).toBe('https://en.example.com/en/foo'); }); }); diff --git a/packages/docusaurus-theme-common/src/utils/anchorUtils.module.css b/packages/docusaurus-theme-common/src/utils/anchorUtils.module.css new file mode 100644 index 0000000000..1904425c03 --- /dev/null +++ b/packages/docusaurus-theme-common/src/utils/anchorUtils.module.css @@ -0,0 +1,14 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +.anchorTargetStickyNavbar { + scroll-margin-top: calc(var(--ifm-navbar-height) + 0.5rem); +} + +.anchorTargetHideOnScrollNavbar { + scroll-margin-top: 0.5rem; +} diff --git a/packages/docusaurus-theme-common/src/utils/anchorUtils.ts b/packages/docusaurus-theme-common/src/utils/anchorUtils.ts new file mode 100644 index 0000000000..64c2832644 --- /dev/null +++ b/packages/docusaurus-theme-common/src/utils/anchorUtils.ts @@ -0,0 +1,31 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import {useThemeConfig} from './useThemeConfig'; +import styles from './anchorUtils.module.css'; + +/** + * When the navbar is sticky, this ensures that when clicking a hash link, + * we do not navigate to an anchor that will appear below the navbar. + * This happens in particular for MDX headings and footnotes. + * + * See https://github.com/facebook/docusaurus/issues/11232 + * See also headings case https://x.com/JoshWComeau/status/1332015868725891076 + */ +export function useAnchorTargetClassName( + id: string | undefined, +): string | undefined { + const { + navbar: {hideOnScroll}, + } = useThemeConfig(); + if (typeof id === 'undefined') { + return undefined; + } + return hideOnScroll + ? styles.anchorTargetHideOnScrollNavbar + : styles.anchorTargetStickyNavbar; +} diff --git a/packages/docusaurus-theme-common/src/utils/historyUtils.ts b/packages/docusaurus-theme-common/src/utils/historyUtils.ts index eea45351d8..45f9cc22dd 100644 --- a/packages/docusaurus-theme-common/src/utils/historyUtils.ts +++ b/packages/docusaurus-theme-common/src/utils/historyUtils.ts @@ -168,3 +168,32 @@ export function useClearQueryString(): () => void { }); }, [history]); } + +export function mergeSearchParams( + params: URLSearchParams[], + strategy: 'append' | 'set', +): URLSearchParams { + const result = new URLSearchParams(); + for (const item of params) { + for (const [key, value] of item.entries()) { + if (strategy === 'append') { + result.append(key, value); + } else { + result.set(key, value); + } + } + } + return result; +} + +export function mergeSearchStrings( + searchStrings: (string | undefined)[], + strategy: 'append' | 'set', +): string { + const params = mergeSearchParams( + searchStrings.map((s) => new URLSearchParams(s ?? '')), + strategy, + ); + const str = params.toString(); + return str ? `?${str}` : str; +} diff --git a/packages/docusaurus-theme-common/src/utils/useAlternatePageUtils.ts b/packages/docusaurus-theme-common/src/utils/useAlternatePageUtils.ts index 073aa8956f..fd537163f1 100644 --- a/packages/docusaurus-theme-common/src/utils/useAlternatePageUtils.ts +++ b/packages/docusaurus-theme-common/src/utils/useAlternatePageUtils.ts @@ -8,6 +8,7 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import {useLocation} from '@docusaurus/router'; import {applyTrailingSlash} from '@docusaurus/utils-common'; +import type {I18nLocaleConfig} from '@docusaurus/types'; /** * Permits to obtain the url of the current page in another locale, useful to @@ -36,8 +37,8 @@ export function useAlternatePageUtils(): { }) => string; } { const { - siteConfig: {baseUrl, url, trailingSlash}, - i18n: {defaultLocale, currentLocale}, + siteConfig: {baseUrl, trailingSlash}, + i18n: {localeConfigs}, } = useDocusaurusContext(); // TODO using useLocation().pathname is not a super idea @@ -49,21 +50,19 @@ export function useAlternatePageUtils(): { baseUrl, }); - const baseUrlUnlocalized = - currentLocale === defaultLocale - ? baseUrl - : baseUrl.replace(`/${currentLocale}/`, '/'); - + // Canonical pathname, without the baseUrl of the current locale const pathnameSuffix = canonicalPathname.replace(baseUrl, ''); - function getLocalizedBaseUrl(locale: string) { - return locale === defaultLocale - ? `${baseUrlUnlocalized}` - : `${baseUrlUnlocalized}${locale}/`; + function getLocaleConfig(locale: string): I18nLocaleConfig { + const localeConfig = localeConfigs[locale]; + if (!localeConfig) { + throw new Error( + `Unexpected Docusaurus bug, no locale config found for locale=${locale}`, + ); + } + return localeConfig; } - // TODO support correct alternate url when localized site is deployed on - // another domain function createUrl({ locale, fullyQualified, @@ -71,9 +70,10 @@ export function useAlternatePageUtils(): { locale: string; fullyQualified: boolean; }) { - return `${fullyQualified ? url : ''}${getLocalizedBaseUrl( - locale, - )}${pathnameSuffix}`; + const localeConfig = getLocaleConfig(locale); + const newUrl = `${fullyQualified ? localeConfig.url : ''}`; + const newBaseUrl = localeConfig.baseUrl; + return `${newUrl}${newBaseUrl}${pathnameSuffix}`; } return {createUrl}; diff --git a/packages/docusaurus-theme-live-codeblock/package.json b/packages/docusaurus-theme-live-codeblock/package.json index 696adb8180..fdc692f93e 100644 --- a/packages/docusaurus-theme-live-codeblock/package.json +++ b/packages/docusaurus-theme-live-codeblock/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-live-codeblock", - "version": "3.8.1", + "version": "3.9.2", "description": "Docusaurus live code block component.", "main": "lib/index.js", "types": "src/theme-live-codeblock.d.ts", @@ -23,10 +23,10 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/theme-common": "3.8.1", - "@docusaurus/theme-translations": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/theme-translations": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "@philpl/buble": "^0.19.7", "clsx": "^2.0.0", "fs-extra": "^11.1.1", @@ -34,7 +34,7 @@ "tslib": "^2.6.0" }, "devDependencies": { - "@docusaurus/types": "3.8.1", + "@docusaurus/types": "3.9.2", "@types/buble": "^0.20.1" }, "peerDependencies": { @@ -42,6 +42,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-theme-mermaid/package.json b/packages/docusaurus-theme-mermaid/package.json index c97bc97f59..11336abde4 100644 --- a/packages/docusaurus-theme-mermaid/package.json +++ b/packages/docusaurus-theme-mermaid/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-mermaid", - "version": "3.8.1", + "version": "3.9.2", "description": "Mermaid components for Docusaurus.", "main": "lib/index.js", "types": "src/theme-mermaid.d.ts", @@ -33,11 +33,11 @@ "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch" }, "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/module-type-aliases": "3.8.1", - "@docusaurus/theme-common": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "mermaid": ">=11.6.0", "tslib": "^2.6.0" }, @@ -45,10 +45,16 @@ "react-test-renderer": "^18.0.0" }, "peerDependencies": { + "@mermaid-js/layout-elk": "^0.1.9", "react": "^18.0.0 || ^19.0.0", "react-dom": "^18.0.0 || ^19.0.0" }, + "peerDependenciesMeta": { + "@mermaid-js/layout-elk": { + "optional": true + } + }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-theme-mermaid/src/client/index.ts b/packages/docusaurus-theme-mermaid/src/client/index.ts index 5ab3871813..51a143387e 100644 --- a/packages/docusaurus-theme-mermaid/src/client/index.ts +++ b/packages/docusaurus-theme-mermaid/src/client/index.ts @@ -7,7 +7,8 @@ import {useState, useEffect, useMemo} from 'react'; import {useColorMode, useThemeConfig} from '@docusaurus/theme-common'; -import mermaid from 'mermaid'; +import {loadMermaid} from './loadMermaid'; + import type {RenderResult, MermaidConfig} from 'mermaid'; import type {ThemeConfig} from '@docusaurus/theme-mermaid'; @@ -37,7 +38,7 @@ function useMermaidId(): string { Note: Mermaid doesn't like values provided by Rect.useId() and throws */ - // TODO 2025-2026: check if useId() now works + // TODO Docusaurus v4: check if useId() now works // It could work thanks to https://github.com/facebook/react/pull/32001 // return useId(); // tried that, doesn't work ('#d:re:' is not a valid selector.) @@ -53,6 +54,8 @@ async function renderMermaid({ text: string; config: MermaidConfig; }): Promise { + const mermaid = await loadMermaid(); + /* Mermaid API is really weird :s It is a big mutable singleton with multiple config levels @@ -71,7 +74,7 @@ async function renderMermaid({ To use a new mermaid config (on colorMode change for example) we should update siteConfig, and it can only be done with initialize() */ - mermaid.mermaidAPI.initialize(config); + mermaid.initialize(config); try { return await mermaid.render(id, text); diff --git a/packages/docusaurus-theme-mermaid/src/client/loadMermaid.ts b/packages/docusaurus-theme-mermaid/src/client/loadMermaid.ts new file mode 100644 index 0000000000..47a6c7b3e8 --- /dev/null +++ b/packages/docusaurus-theme-mermaid/src/client/loadMermaid.ts @@ -0,0 +1,42 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import type {Mermaid} from 'mermaid'; + +declare global { + // Global variable provided by bundler DefinePlugin + /* eslint-disable-next-line no-underscore-dangle */ + const __DOCUSAURUS_MERMAID_LAYOUT_ELK_ENABLED__: boolean; +} + +async function loadMermaidAndRegisterLayouts(): Promise { + const mermaid = (await import('mermaid')).default; + + // Mermaid does not support ELK layouts by default + // See https://github.com/mermaid-js/mermaid/tree/develop/packages/mermaid-layout-elk + // ELK layouts are heavy, so we made it an optional peer dependency + // See https://github.com/facebook/docusaurus/pull/11357 + if (__DOCUSAURUS_MERMAID_LAYOUT_ELK_ENABLED__) { + const elkLayout = (await import('@mermaid-js/layout-elk')).default; + mermaid.registerLayoutLoaders(elkLayout); + } + + return mermaid; +} + +// Ensure we only try to register layouts once +let MermaidPromise: Promise | null = null; + +// We load Mermaid with a dynamic import to code split / lazy load the library +// It is only called inside a useEffect, so loading can be deferred +// We memoize so that we don't load and register layouts multiple times +export async function loadMermaid(): Promise { + if (!MermaidPromise) { + MermaidPromise = loadMermaidAndRegisterLayouts(); + } + return MermaidPromise; +} diff --git a/packages/docusaurus-theme-mermaid/src/index.ts b/packages/docusaurus-theme-mermaid/src/index.ts index 82b1636c59..622c6b2ef7 100644 --- a/packages/docusaurus-theme-mermaid/src/index.ts +++ b/packages/docusaurus-theme-mermaid/src/index.ts @@ -7,7 +7,26 @@ import type {Plugin} from '@docusaurus/types'; -export default function themeMermaid(): Plugin { +/** + * Check if the optional @mermaid-js/layout-elk package is available. + * It's an optional peer dependency because it's heavy and most Mermaid users + * might not need it. + */ +async function isElkLayoutPackageAvailable() { + try { + await import('@mermaid-js/layout-elk'); + return true; + } catch (e) { + return false; + } +} + +export default async function themeMermaid(): Promise> { + // For now, we infer based on package availability + // In the future, we could make it configurable so that users can disable it + // even if the package is installed? + const elkLayoutEnabled = await isElkLayoutPackageAvailable(); + return { name: 'docusaurus-theme-mermaid', @@ -17,6 +36,21 @@ export default function themeMermaid(): Plugin { getTypeScriptThemePath() { return '../src/theme'; }, + + configureWebpack(config, isServer, utils) { + return { + plugins: [ + new utils.currentBundler.instance.DefinePlugin({ + __DOCUSAURUS_MERMAID_LAYOUT_ELK_ENABLED__: JSON.stringify( + // We only need to include the layout registration code on the + // client side. This also solves a weird Webpack-only bug when + // compiling the server config due to the module being ESM-only. + !isServer && elkLayoutEnabled, + ), + }), + ], + }; + }, }; } diff --git a/packages/docusaurus-theme-search-algolia/package.json b/packages/docusaurus-theme-search-algolia/package.json index cd20a55108..8b78fcbf15 100644 --- a/packages/docusaurus-theme-search-algolia/package.json +++ b/packages/docusaurus-theme-search-algolia/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-search-algolia", - "version": "3.8.1", + "version": "3.9.2", "description": "Algolia search component for Docusaurus.", "main": "lib/index.js", "sideEffects": [ @@ -33,16 +33,16 @@ "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch" }, "dependencies": { - "@docsearch/react": "^3.9.0", - "@docusaurus/core": "3.8.1", - "@docusaurus/logger": "3.8.1", - "@docusaurus/plugin-content-docs": "3.8.1", - "@docusaurus/theme-common": "3.8.1", - "@docusaurus/theme-translations": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", - "algoliasearch": "^5.17.1", - "algoliasearch-helper": "^3.22.6", + "@docsearch/react": "^3.9.0 || ^4.3.2", + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/plugin-content-docs": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/theme-translations": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "algoliasearch": "^5.37.0", + "algoliasearch-helper": "^3.26.0", "clsx": "^2.0.0", "eta": "^2.2.0", "fs-extra": "^11.1.1", @@ -51,13 +51,13 @@ "utility-types": "^3.10.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.8.1" + "@docusaurus/module-type-aliases": "3.9.2" }, "peerDependencies": { "react": "^18.0.0 || ^19.0.0", "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-theme-search-algolia/src/__tests__/utils.test.ts b/packages/docusaurus-theme-search-algolia/src/__tests__/utils.test.ts new file mode 100644 index 0000000000..b3ed86fff0 --- /dev/null +++ b/packages/docusaurus-theme-search-algolia/src/__tests__/utils.test.ts @@ -0,0 +1,47 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import {mergeFacetFilters} from '../client/utils'; + +describe('mergeFacetFilters', () => { + it('merges [string,string]', () => { + expect(mergeFacetFilters('f1', 'f2')).toEqual(['f1', 'f2']); + }); + + it('merges [string,array]', () => { + // TODO this looks wrong to me, should be ['f1', ['f2', 'f3']] ? + expect(mergeFacetFilters('f1', ['f2', 'f3'])).toEqual(['f1', 'f2', 'f3']); + }); + + it('merges [string,undefined]', () => { + expect(mergeFacetFilters('f1', undefined)).toEqual('f1'); + }); + + it('merges [undefined,string]', () => { + expect(mergeFacetFilters(undefined, 'f1')).toEqual('f1'); + }); + + it('merges [array,undefined]', () => { + expect(mergeFacetFilters(['f1', 'f2'], undefined)).toEqual(['f1', 'f2']); + }); + + it('merges [undefined,array]', () => { + expect(mergeFacetFilters(undefined, ['f1', 'f2'])).toEqual(['f1', 'f2']); + }); + + it('merges [array,array]', () => { + expect(mergeFacetFilters(['f1'], ['f2'])).toEqual(['f1', 'f2']); + + // TODO this looks wrong to me, should be [['f1', 'f2'], ['f3', 'f4']] ? + expect(mergeFacetFilters(['f1', 'f2'], ['f3', 'f4'])).toEqual([ + 'f1', + 'f2', + 'f3', + 'f4', + ]); + }); +}); diff --git a/packages/docusaurus-theme-search-algolia/src/__tests__/validateThemeConfig.test.ts b/packages/docusaurus-theme-search-algolia/src/__tests__/validateThemeConfig.test.ts index 7559aef403..d5693b043d 100644 --- a/packages/docusaurus-theme-search-algolia/src/__tests__/validateThemeConfig.test.ts +++ b/packages/docusaurus-theme-search-algolia/src/__tests__/validateThemeConfig.test.ts @@ -7,8 +7,17 @@ import {DEFAULT_CONFIG, validateThemeConfig} from '../validateThemeConfig'; import type {Joi} from '@docusaurus/utils-validation'; +import type { + ThemeConfig, + UserThemeConfig, +} from '@docusaurus/theme-search-algolia'; -function testValidateThemeConfig(themeConfig: {[key: string]: unknown}) { +// mock DocSearch to a v4 version to allow AskAI tests to pass +jest.mock('@docsearch/react', () => ({version: '4.0.0'})); + +type AlgoliaInput = UserThemeConfig['algolia']; + +function testValidateThemeConfig(algolia: AlgoliaInput) { function validate( schema: Joi.ObjectSchema<{[key: string]: unknown}>, cfg: {[key: string]: unknown}, @@ -22,17 +31,20 @@ function testValidateThemeConfig(themeConfig: {[key: string]: unknown}) { return value; } - return validateThemeConfig({themeConfig, validate}); + return validateThemeConfig({ + themeConfig: (algolia ? {algolia} : {}) as ThemeConfig, + validate, + }); } describe('validateThemeConfig', () => { it('minimal config', () => { - const algolia = { + const algolia: AlgoliaInput = { indexName: 'index', apiKey: 'apiKey', appId: 'BH4D9OD16A', }; - expect(testValidateThemeConfig({algolia})).toEqual({ + expect(testValidateThemeConfig(algolia)).toEqual({ algolia: { ...DEFAULT_CONFIG, ...algolia, @@ -41,13 +53,14 @@ describe('validateThemeConfig', () => { }); it('unknown attributes', () => { - const algolia = { + const algolia: AlgoliaInput = { indexName: 'index', apiKey: 'apiKey', + // @ts-expect-error: expected type error! unknownKey: 'unknownKey', appId: 'BH4D9OD16A', }; - expect(testValidateThemeConfig({algolia})).toEqual({ + expect(testValidateThemeConfig(algolia)).toEqual({ algolia: { ...DEFAULT_CONFIG, ...algolia, @@ -58,47 +71,64 @@ describe('validateThemeConfig', () => { it('undefined config', () => { const algolia = undefined; expect(() => - testValidateThemeConfig({algolia}), + testValidateThemeConfig(algolia), ).toThrowErrorMatchingInlineSnapshot(`""themeConfig.algolia" is required"`); }); - it('undefined config 2', () => { + it('empty config', () => { expect(() => - testValidateThemeConfig({}), - ).toThrowErrorMatchingInlineSnapshot(`""themeConfig.algolia" is required"`); + testValidateThemeConfig( + // @ts-expect-error: expected type error! + {}, + ), + ).toThrowErrorMatchingInlineSnapshot( + `""algolia.appId" is required. If you haven't migrated to the new DocSearch infra, please refer to the blog post for instructions: https://docusaurus.io/blog/2021/11/21/algolia-docsearch-migration"`, + ); }); it('missing indexName config', () => { - const algolia = {apiKey: 'apiKey', appId: 'BH4D9OD16A'}; + // @ts-expect-error: expected type error! + const algolia: AlgoliaInput = { + apiKey: 'apiKey', + appId: 'BH4D9OD16A', + }; expect(() => - testValidateThemeConfig({algolia}), + testValidateThemeConfig(algolia), ).toThrowErrorMatchingInlineSnapshot(`""algolia.indexName" is required"`); }); it('missing apiKey config', () => { - const algolia = {indexName: 'indexName', appId: 'BH4D9OD16A'}; + // @ts-expect-error: expected type error! + const algolia: AlgoliaInput = { + indexName: 'indexName', + appId: 'BH4D9OD16A', + }; expect(() => - testValidateThemeConfig({algolia}), + testValidateThemeConfig(algolia), ).toThrowErrorMatchingInlineSnapshot(`""algolia.apiKey" is required"`); }); it('missing appId config', () => { - const algolia = {indexName: 'indexName', apiKey: 'apiKey'}; + // @ts-expect-error: expected type error! + const algolia: AlgoliaInput = { + indexName: 'indexName', + apiKey: 'apiKey', + }; expect(() => - testValidateThemeConfig({algolia}), + testValidateThemeConfig(algolia), ).toThrowErrorMatchingInlineSnapshot( `""algolia.appId" is required. If you haven't migrated to the new DocSearch infra, please refer to the blog post for instructions: https://docusaurus.io/blog/2021/11/21/algolia-docsearch-migration"`, ); }); it('contextualSearch config', () => { - const algolia = { + const algolia: AlgoliaInput = { appId: 'BH4D9OD16A', indexName: 'index', apiKey: 'apiKey', contextualSearch: true, }; - expect(testValidateThemeConfig({algolia})).toEqual({ + expect(testValidateThemeConfig(algolia)).toEqual({ algolia: { ...DEFAULT_CONFIG, ...algolia, @@ -107,13 +137,13 @@ describe('validateThemeConfig', () => { }); it('externalUrlRegex config', () => { - const algolia = { + const algolia: AlgoliaInput = { appId: 'BH4D9OD16A', indexName: 'index', apiKey: 'apiKey', externalUrlRegex: 'http://external-domain.com', }; - expect(testValidateThemeConfig({algolia})).toEqual({ + expect(testValidateThemeConfig(algolia)).toEqual({ algolia: { ...DEFAULT_CONFIG, ...algolia, @@ -123,7 +153,7 @@ describe('validateThemeConfig', () => { describe('replaceSearchResultPathname', () => { it('escapes from string', () => { - const algolia = { + const algolia: AlgoliaInput = { appId: 'BH4D9OD16A', indexName: 'index', apiKey: 'apiKey', @@ -132,7 +162,7 @@ describe('validateThemeConfig', () => { to: '/abc', }, }; - expect(testValidateThemeConfig({algolia})).toEqual({ + expect(testValidateThemeConfig(algolia)).toEqual({ algolia: { ...DEFAULT_CONFIG, ...algolia, @@ -145,17 +175,18 @@ describe('validateThemeConfig', () => { }); it('converts from regexp to string', () => { - const algolia = { + const algolia: AlgoliaInput = { appId: 'BH4D9OD16A', indexName: 'index', apiKey: 'apiKey', replaceSearchResultPathname: { + // @ts-expect-error: test regexp input from: /^\/docs\/(?:1\.0|next)/, to: '/abc', }, }; - expect(testValidateThemeConfig({algolia})).toEqual({ + expect(testValidateThemeConfig(algolia)).toEqual({ algolia: { ...DEFAULT_CONFIG, ...algolia, @@ -169,7 +200,7 @@ describe('validateThemeConfig', () => { }); it('searchParameters.facetFilters search config', () => { - const algolia = { + const algolia: AlgoliaInput = { appId: 'BH4D9OD16A', indexName: 'index', apiKey: 'apiKey', @@ -177,11 +208,323 @@ describe('validateThemeConfig', () => { facetFilters: ['version:1.0'], }, }; - expect(testValidateThemeConfig({algolia})).toEqual({ + expect(testValidateThemeConfig(algolia)).toEqual({ algolia: { ...DEFAULT_CONFIG, ...algolia, }, }); }); + + describe('askAi config validation', () => { + it('accepts string format (assistantId)', () => { + const algolia: AlgoliaInput = { + appId: 'BH4D9OD16A', + indexName: 'index', + apiKey: 'apiKey', + askAi: 'my-assistant-id', + }; + expect(testValidateThemeConfig(algolia)).toEqual({ + algolia: { + ...DEFAULT_CONFIG, + ...algolia, + askAi: { + assistantId: 'my-assistant-id', + indexName: algolia.indexName, + apiKey: algolia.apiKey, + appId: algolia.appId, + }, + }, + }); + }); + + it('accepts minimal object format', () => { + const algolia: AlgoliaInput = { + appId: 'BH4D9OD16A', + indexName: 'index', + apiKey: 'apiKey', + askAi: { + assistantId: 'my-assistant-id', + }, + }; + expect(testValidateThemeConfig(algolia)).toEqual({ + algolia: { + ...DEFAULT_CONFIG, + ...algolia, + askAi: { + assistantId: 'my-assistant-id', + indexName: algolia.indexName, + apiKey: algolia.apiKey, + appId: algolia.appId, + }, + }, + }); + }); + + it('accepts full object format', () => { + const algolia: AlgoliaInput = { + appId: 'BH4D9OD16A', + indexName: 'index', + apiKey: 'apiKey', + askAi: { + indexName: 'ai-index', + apiKey: 'ai-apiKey', + appId: 'ai-appId', + assistantId: 'my-assistant-id', + }, + }; + expect(testValidateThemeConfig(algolia)).toEqual({ + algolia: { + ...DEFAULT_CONFIG, + ...algolia, + }, + }); + }); + + it('rejects invalid type', () => { + const algolia: AlgoliaInput = { + appId: 'BH4D9OD16A', + indexName: 'index', + apiKey: 'apiKey', + // @ts-expect-error: expected type error + askAi: 123, // Invalid: should be string or object + }; + expect(() => + testValidateThemeConfig(algolia), + ).toThrowErrorMatchingInlineSnapshot( + `"askAi must be either a string (assistantId) or an object with indexName, apiKey, appId, and assistantId"`, + ); + }); + + it('rejects empty askAi', () => { + const algolia: AlgoliaInput = { + appId: 'BH4D9OD16A', + indexName: 'index', + apiKey: 'apiKey', + // @ts-expect-error: expected type error: missing mandatory fields + askAi: {}, + }; + expect(() => + testValidateThemeConfig(algolia), + ).toThrowErrorMatchingInlineSnapshot( + `""algolia.askAi.assistantId" is required"`, + ); + }); + + it('accepts undefined askAi', () => { + const algolia: AlgoliaInput = { + appId: 'BH4D9OD16A', + indexName: 'index', + apiKey: 'apiKey', + }; + expect(testValidateThemeConfig(algolia)).toEqual({ + algolia: { + ...DEFAULT_CONFIG, + ...algolia, + }, + }); + }); + + describe('Ask AI search parameters', () => { + it('accepts Ask AI facet filters', () => { + const algolia = { + appId: 'BH4D9OD16A', + indexName: 'index', + apiKey: 'apiKey', + askAi: { + indexName: 'ai-index', + apiKey: 'ai-apiKey', + appId: 'ai-appId', + assistantId: 'my-assistant-id', + searchParameters: { + facetFilters: ['version:1.0'], + }, + }, + } satisfies AlgoliaInput; + + expect(testValidateThemeConfig(algolia)).toEqual({ + algolia: { + ...DEFAULT_CONFIG, + ...algolia, + }, + }); + }); + + it('accepts distinct Ask AI / algolia facet filters', () => { + const algolia = { + appId: 'BH4D9OD16A', + indexName: 'index', + apiKey: 'apiKey', + searchParameters: { + facetFilters: ['version:algolia'], + }, + askAi: { + indexName: 'ai-index', + apiKey: 'ai-apiKey', + appId: 'ai-appId', + assistantId: 'my-assistant-id', + searchParameters: { + facetFilters: ['version:askAi'], + }, + }, + } satisfies AlgoliaInput; + + expect(testValidateThemeConfig(algolia)).toEqual({ + algolia: { + ...DEFAULT_CONFIG, + ...algolia, + }, + }); + }); + + it('falls back to algolia facet filters', () => { + const algolia = { + appId: 'BH4D9OD16A', + indexName: 'index', + apiKey: 'apiKey', + searchParameters: { + facetFilters: ['version:1.0'], + }, + askAi: { + indexName: 'ai-index', + apiKey: 'ai-apiKey', + appId: 'ai-appId', + assistantId: 'my-assistant-id', + searchParameters: {}, + }, + } satisfies AlgoliaInput; + + expect(testValidateThemeConfig(algolia)).toEqual({ + algolia: { + ...DEFAULT_CONFIG, + ...algolia, + askAi: { + ...algolia.askAi, + searchParameters: { + facetFilters: ['version:1.0'], + }, + }, + }, + }); + }); + + it('falls back to algolia facet filters with AskAI string format (assistantId)', () => { + const algolia = { + appId: 'BH4D9OD16A', + indexName: 'index', + apiKey: 'apiKey', + searchParameters: { + facetFilters: ['version:1.0'], + }, + askAi: 'my-assistant-id', + } satisfies AlgoliaInput; + + expect(testValidateThemeConfig(algolia)).toEqual({ + algolia: { + ...DEFAULT_CONFIG, + ...algolia, + askAi: { + indexName: algolia.indexName, + apiKey: algolia.apiKey, + appId: algolia.appId, + assistantId: 'my-assistant-id', + searchParameters: { + facetFilters: ['version:1.0'], + }, + }, + }, + }); + }); + }); + + describe('Ask AI suggestedQuestions', () => { + it('accepts suggestedQuestions as true', () => { + const algolia = { + appId: 'BH4D9OD16A', + indexName: 'index', + apiKey: 'apiKey', + askAi: { + assistantId: 'my-assistant-id', + suggestedQuestions: true, + }, + } satisfies AlgoliaInput; + + expect(testValidateThemeConfig(algolia)).toEqual({ + algolia: { + ...DEFAULT_CONFIG, + ...algolia, + askAi: { + indexName: algolia.indexName, + apiKey: algolia.apiKey, + appId: algolia.appId, + assistantId: 'my-assistant-id', + suggestedQuestions: true, + }, + }, + }); + }); + + it('accepts suggestedQuestions as false', () => { + const algolia = { + appId: 'BH4D9OD16A', + indexName: 'index', + apiKey: 'apiKey', + askAi: { + assistantId: 'my-assistant-id', + suggestedQuestions: false, + }, + } satisfies AlgoliaInput; + + expect(testValidateThemeConfig(algolia)).toEqual({ + algolia: { + ...DEFAULT_CONFIG, + ...algolia, + askAi: { + indexName: algolia.indexName, + apiKey: algolia.apiKey, + appId: algolia.appId, + assistantId: 'my-assistant-id', + suggestedQuestions: false, + }, + }, + }); + }); + + it('rejects invalid suggestedQuestions type', () => { + const algolia: AlgoliaInput = { + appId: 'BH4D9OD16A', + indexName: 'index', + apiKey: 'apiKey', + askAi: { + assistantId: 'my-assistant-id', + // @ts-expect-error: expected type error + suggestedQuestions: 'invalid-string', + }, + }; + expect(() => + testValidateThemeConfig(algolia), + ).toThrowErrorMatchingInlineSnapshot( + `""algolia.askAi.suggestedQuestions" must be a boolean"`, + ); + }); + + it('rejects suggestedQuestions as number', () => { + const algolia: AlgoliaInput = { + appId: 'BH4D9OD16A', + indexName: 'index', + apiKey: 'apiKey', + askAi: { + assistantId: 'my-assistant-id', + // @ts-expect-error: expected type error + suggestedQuestions: 123, + }, + }; + expect(() => + testValidateThemeConfig(algolia), + ).toThrowErrorMatchingInlineSnapshot( + `""algolia.askAi.suggestedQuestions" must be a boolean"`, + ); + }); + }); + }); }); diff --git a/packages/docusaurus-theme-search-algolia/src/client/index.ts b/packages/docusaurus-theme-search-algolia/src/client/index.ts index 5050ce6aa0..c2d61a668d 100644 --- a/packages/docusaurus-theme-search-algolia/src/client/index.ts +++ b/packages/docusaurus-theme-search-algolia/src/client/index.ts @@ -6,5 +6,10 @@ */ export {useAlgoliaThemeConfig} from './useAlgoliaThemeConfig'; -export {useAlgoliaContextualFacetFilters} from './useAlgoliaContextualFacetFilters'; +export { + useAlgoliaContextualFacetFilters, + useAlgoliaContextualFacetFiltersIfEnabled, +} from './useAlgoliaContextualFacetFilters'; export {useSearchResultUrlProcessor} from './useSearchResultUrlProcessor'; +export {useAlgoliaAskAi} from './useAlgoliaAskAi'; +export {mergeFacetFilters} from './utils'; diff --git a/packages/docusaurus-theme-search-algolia/src/client/useAlgoliaAskAi.ts b/packages/docusaurus-theme-search-algolia/src/client/useAlgoliaAskAi.ts new file mode 100644 index 0000000000..62e901d2be --- /dev/null +++ b/packages/docusaurus-theme-search-algolia/src/client/useAlgoliaAskAi.ts @@ -0,0 +1,108 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import {useCallback, useMemo, useState} from 'react'; +import {version as docsearchVersion} from '@docsearch/react/version'; +import translations from '@theme/SearchTranslations'; +import {useAlgoliaContextualFacetFiltersIfEnabled} from './useAlgoliaContextualFacetFilters'; +import {mergeFacetFilters} from './utils'; +import type {AskAiConfig} from '@docusaurus/theme-search-algolia'; +import type { + DocSearchModalProps, + DocSearchTranslations, +} from '@docsearch/react'; +import type {FacetFilters} from 'algoliasearch/lite'; + +// The minimal props the hook needs from DocSearch v4 props +// TODO Docusaurus v4: cleanup after we drop support for DocSearch v3 +interface DocSearchV4PropsLite { + indexName: string; + apiKey: string; + appId: string; + placeholder?: string; + translations?: DocSearchTranslations; + searchParameters?: DocSearchModalProps['searchParameters']; + askAi?: AskAiConfig; +} + +const isV4 = docsearchVersion.startsWith('4.'); + +type UseAskAiResult = { + canHandleAskAi: boolean; + isAskAiActive: boolean; + currentPlaceholder: string | undefined; + onAskAiToggle: (active: boolean) => void; + askAi?: AskAiConfig; + extraAskAiProps: Partial & { + askAi?: AskAiConfig; + canHandleAskAi?: boolean; + isAskAiActive?: boolean; + onAskAiToggle?: (active: boolean) => void; + }; +}; + +// We need to apply contextualSearch facetFilters to AskAI filters +// This can't be done at config normalization time because contextual filters +// can only be determined at runtime +function applyAskAiContextualSearch( + askAi: AskAiConfig | undefined, + contextualSearchFilters: FacetFilters | undefined, +): AskAiConfig | undefined { + if (!askAi) { + return undefined; + } + if (!contextualSearchFilters) { + return askAi; + } + const askAiFacetFilters = askAi.searchParameters?.facetFilters; + return { + ...askAi, + searchParameters: { + ...askAi.searchParameters, + facetFilters: mergeFacetFilters( + askAiFacetFilters, + contextualSearchFilters, + ), + }, + }; +} + +export function useAlgoliaAskAi(props: DocSearchV4PropsLite): UseAskAiResult { + const [isAskAiActive, setIsAskAiActive] = useState(false); + const contextualSearchFilters = useAlgoliaContextualFacetFiltersIfEnabled(); + + const askAi = useMemo(() => { + return applyAskAiContextualSearch(props.askAi, contextualSearchFilters); + }, [props.askAi, contextualSearchFilters]); + + const canHandleAskAi = Boolean(askAi); + + const currentPlaceholder = + isAskAiActive && isV4 + ? translations.modal?.searchBox?.placeholderTextAskAi + : translations.modal?.searchBox?.placeholderText || props?.placeholder; + + const onAskAiToggle = useCallback((askAiToggle: boolean) => { + setIsAskAiActive(askAiToggle); + }, []); + + const extraAskAiProps: UseAskAiResult['extraAskAiProps'] = { + askAi: askAi as any, + canHandleAskAi, + isAskAiActive, + onAskAiToggle, + }; + + return { + canHandleAskAi, + isAskAiActive, + currentPlaceholder, + onAskAiToggle, + askAi, + extraAskAiProps, + }; +} diff --git a/packages/docusaurus-theme-search-algolia/src/client/useAlgoliaContextualFacetFilters.ts b/packages/docusaurus-theme-search-algolia/src/client/useAlgoliaContextualFacetFilters.ts index e12b113088..753ee166bd 100644 --- a/packages/docusaurus-theme-search-algolia/src/client/useAlgoliaContextualFacetFilters.ts +++ b/packages/docusaurus-theme-search-algolia/src/client/useAlgoliaContextualFacetFilters.ts @@ -8,6 +8,8 @@ import {DEFAULT_SEARCH_TAG} from '@docusaurus/theme-common/internal'; import {useDocsContextualSearchTags} from '@docusaurus/plugin-content-docs/client'; import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; +import {useAlgoliaThemeConfig} from './useAlgoliaThemeConfig'; +import type {FacetFilters} from 'algoliasearch/lite'; function useSearchTags() { // only docs have custom search tags per version @@ -16,7 +18,7 @@ function useSearchTags() { } // Translate search-engine agnostic search tags to Algolia search filters -export function useAlgoliaContextualFacetFilters(): [string, string[]] { +export function useAlgoliaContextualFacetFilters(): FacetFilters { const locale = useDocusaurusContext().i18n.currentLocale; const tags = useSearchTags(); @@ -27,3 +29,17 @@ export function useAlgoliaContextualFacetFilters(): [string, string[]] { return [languageFilter, tagsFilter]; } + +export function useAlgoliaContextualFacetFiltersIfEnabled(): + | FacetFilters + | undefined { + const { + algolia: {contextualSearch}, + } = useAlgoliaThemeConfig(); + const facetFilters = useAlgoliaContextualFacetFilters(); + if (contextualSearch) { + return facetFilters; + } else { + return undefined; + } +} diff --git a/packages/docusaurus-theme-search-algolia/src/client/useSearchResultUrlProcessor.ts b/packages/docusaurus-theme-search-algolia/src/client/useSearchResultUrlProcessor.ts index 0414d19f2a..3ec046afb1 100644 --- a/packages/docusaurus-theme-search-algolia/src/client/useSearchResultUrlProcessor.ts +++ b/packages/docusaurus-theme-search-algolia/src/client/useSearchResultUrlProcessor.ts @@ -43,7 +43,7 @@ export function useSearchResultUrlProcessor(): (url: string) => string { } // Otherwise => transform to relative URL for SPA navigation - const relativeUrl = `${parsedURL.pathname + parsedURL.hash}`; + const relativeUrl = `${parsedURL.pathname}${parsedURL.search}${parsedURL.hash}`; return withBaseUrl( replacePathname(relativeUrl, replaceSearchResultPathname), diff --git a/packages/docusaurus-theme-search-algolia/src/client/utils.ts b/packages/docusaurus-theme-search-algolia/src/client/utils.ts new file mode 100644 index 0000000000..3ec1336779 --- /dev/null +++ b/packages/docusaurus-theme-search-algolia/src/client/utils.ts @@ -0,0 +1,40 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import type {FacetFilters} from 'algoliasearch/lite'; + +export function mergeFacetFilters( + f1: FacetFilters, + f2: FacetFilters, +): FacetFilters; + +export function mergeFacetFilters( + f1: FacetFilters | undefined, + f2: FacetFilters | undefined, +): FacetFilters | undefined; + +export function mergeFacetFilters( + f1: FacetFilters | undefined, + f2: FacetFilters | undefined, +): FacetFilters | undefined { + if (f1 === undefined) { + return f2; + } + if (f2 === undefined) { + return f1; + } + + const normalize = (f: FacetFilters): FacetFilters => + typeof f === 'string' ? [f] : f; + + // Historical behavior: we flatten everything + // TODO I'm pretty sure this is incorrect + // see https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/?client=javascript + // Note: Algolia is working to provide a reliable facet merging strategy + // see https://github.com/facebook/docusaurus/pull/11327#issuecomment-3284742923 + return [...normalize(f1), ...normalize(f2)]; +} diff --git a/packages/docusaurus-theme-search-algolia/src/docSearchVersion.ts b/packages/docusaurus-theme-search-algolia/src/docSearchVersion.ts new file mode 100644 index 0000000000..1509af0c5f --- /dev/null +++ b/packages/docusaurus-theme-search-algolia/src/docSearchVersion.ts @@ -0,0 +1,12 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import {version as docSearchVersion} from '@docsearch/react'; + +// TODO Docusaurus v4: upgrade to DocSearch v4 +// drop v3 compat, remove this file? +export const docSearchV3: boolean = docSearchVersion.startsWith('3.'); diff --git a/packages/docusaurus-theme-search-algolia/src/index.ts b/packages/docusaurus-theme-search-algolia/src/index.ts index f7fb8bdc32..1dd935115b 100644 --- a/packages/docusaurus-theme-search-algolia/src/index.ts +++ b/packages/docusaurus-theme-search-algolia/src/index.ts @@ -12,6 +12,7 @@ import { createOpenSearchHeadTags, shouldCreateOpenSearchFile, } from './opensearch'; +import {docSearchV3} from './docSearchVersion'; import type {LoadContext, Plugin} from '@docusaurus/types'; import type {ThemeConfig} from '@docusaurus/theme-search-algolia'; @@ -65,6 +66,26 @@ export default function themeSearchAlgolia(context: LoadContext): Plugin { } return {}; }, + + configureWebpack() { + // TODO Docusaurus v4: remove after dropping DocSearch v3 support + if (docSearchV3) { + // These aliases ensure DocSearch v3 imports are compatible with + // the newly added DocSearch v4 entry points + // See https://github.com/algolia/docsearch/pull/2764 + const docSearchV3Entry = require.resolve('@docsearch/react'); + return { + resolve: { + alias: { + '@docsearch/react/version': docSearchV3Entry, + '@docsearch/react/useDocSearchKeyboardEvents': docSearchV3Entry, + '@docsearch/react/useTheme': docSearchV3Entry, + }, + }, + }; + } + return undefined; + }, }; } diff --git a/packages/docusaurus-theme-search-algolia/src/theme-search-algolia.d.ts b/packages/docusaurus-theme-search-algolia/src/theme-search-algolia.d.ts index 9e12b5e2dd..c9360342fd 100644 --- a/packages/docusaurus-theme-search-algolia/src/theme-search-algolia.d.ts +++ b/packages/docusaurus-theme-search-algolia/src/theme-search-algolia.d.ts @@ -5,9 +5,29 @@ * LICENSE file in the root directory of this source tree. */ +// TODO Docusaurus v4: remove after we drop support for DocSearch v3 +declare module '@docsearch/react/button'; +declare module '@docsearch/react/useDocSearchKeyboardEvents'; +declare module '@docsearch/react/version'; + declare module '@docusaurus/theme-search-algolia' { - import type {DeepPartial} from 'utility-types'; + import type {DeepPartial, Overwrite, Optional} from 'utility-types'; + import type {DocSearchProps} from '@docsearch/react'; + import type {FacetFilters} from 'algoliasearch/lite'; + + // The config after normalization (e.g. AskAI string -> object) + // This matches DocSearch v4.3+ AskAi configuration + export type AskAiConfig = { + indexName: string; + apiKey: string; + appId: string; + assistantId: string; + searchParameters?: { + facetFilters?: FacetFilters; + }; + suggestedQuestions?: boolean; + }; // DocSearch props that Docusaurus exposes directly through props forwarding type DocusaurusDocSearchProps = Pick< @@ -20,9 +40,15 @@ declare module '@docusaurus/theme-search-algolia' { | 'searchParameters' | 'insights' | 'initialQuery' - >; + > & { + // Docusaurus normalizes the AskAI config to an object + askAi?: AskAiConfig; + }; + + export type ThemeConfigAlgolia = DocusaurusDocSearchProps & { + // TODO Docusaurus v4: upgrade to DocSearch v4, migrate indexName to indices + indexName: string; - type ThemeConfigAlgolia = DocusaurusDocSearchProps & { // Docusaurus custom options, not coming from DocSearch contextualSearch: boolean; externalUrlRegex?: string; @@ -33,21 +59,25 @@ declare module '@docusaurus/theme-search-algolia' { }; }; - export type ThemeConfig = DocusaurusDocSearchProps & { + export type ThemeConfig = { algolia: ThemeConfigAlgolia; }; - export type UserThemeConfig = DeepPartial; -} - -declare module '@docusaurus/theme-search-algolia/client' { - import type {ThemeConfig} from '@docusaurus/theme-search-algolia'; - - export function useAlgoliaThemeConfig(): ThemeConfig; - - export function useAlgoliaContextualFacetFilters(): [string, string[]]; - - export function useSearchResultUrlProcessor(): (url: string) => string; + export type UserThemeConfig = { + algolia?: Overwrite< + DeepPartial, + { + // Required fields: + appId: ThemeConfigAlgolia['appId']; + apiKey: ThemeConfigAlgolia['apiKey']; + indexName: ThemeConfigAlgolia['indexName']; + // askAi also accepts a shorter string form + askAi?: + | string + | Optional; + } + >; + }; } declare module '@theme/SearchPage' { @@ -65,6 +95,15 @@ declare module '@theme/SearchBar' { declare module '@theme/SearchTranslations' { import type {DocSearchTranslations} from '@docsearch/react'; - const translations: DocSearchTranslations & {placeholder: string}; + const translations: DocSearchTranslations & { + placeholder: string; + // TODO Docusaurus v4: cleanup after we drop support for DocSearch v3 + modal?: { + searchBox?: { + placeholderText?: string; + placeholderTextAskAi?: string; + }; + }; + }; export default translations; } diff --git a/packages/docusaurus-theme-search-algolia/src/theme/SearchBar/index.tsx b/packages/docusaurus-theme-search-algolia/src/theme/SearchBar/index.tsx index f0dd1189bf..cf681939b1 100644 --- a/packages/docusaurus-theme-search-algolia/src/theme/SearchBar/index.tsx +++ b/packages/docusaurus-theme-search-algolia/src/theme/SearchBar/index.tsx @@ -13,7 +13,8 @@ import React, { type ReactNode, } from 'react'; import {createPortal} from 'react-dom'; -import {DocSearchButton, useDocSearchKeyboardEvents} from '@docsearch/react'; +import {DocSearchButton} from '@docsearch/react/button'; +import {useDocSearchKeyboardEvents} from '@docsearch/react/useDocSearchKeyboardEvents'; import Head from '@docusaurus/Head'; import Link from '@docusaurus/Link'; import {useHistory} from '@docusaurus/router'; @@ -24,6 +25,8 @@ import { import { useAlgoliaContextualFacetFilters, useSearchResultUrlProcessor, + useAlgoliaAskAi, + mergeFacetFilters, } from '@docusaurus/theme-search-algolia/client'; import Translate from '@docusaurus/Translate'; import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; @@ -35,10 +38,13 @@ import type { StoredDocSearchHit, DocSearchTransformClient, DocSearchHit, + DocSearchTranslations, + UseDocSearchKeyboardEventsProps, } from '@docsearch/react'; import type {AutocompleteState} from '@algolia/autocomplete-core'; import type {FacetFilters} from 'algoliasearch/lite'; +import type {ThemeConfigAlgolia} from '@docusaurus/theme-search-algolia'; type DocSearchProps = Omit< DocSearchModalProps, @@ -47,8 +53,20 @@ type DocSearchProps = Omit< contextualSearch?: string; externalUrlRegex?: string; searchPagePath: boolean | string; + askAi?: Exclude< + (DocSearchModalProps & {askAi: unknown})['askAi'], + string | undefined + >; }; +// extend DocSearchProps for v4 features +// TODO Docusaurus v4: cleanup after we drop support for DocSearch v3 +interface DocSearchV4Props extends Omit { + indexName: string; + askAi?: ThemeConfigAlgolia['askAi']; + translations?: DocSearchTranslations; +} + let DocSearchModal: typeof DocSearchModalType | null = null; function importDocSearchModalIfNeeded() { @@ -56,9 +74,7 @@ function importDocSearchModalIfNeeded() { return Promise.resolve(); } return Promise.all([ - import('@docsearch/react/modal') as Promise< - typeof import('@docsearch/react') - >, + import('@docsearch/react/modal'), import('@docsearch/react/style'), import('./styles.css'), ]).then(([{DocSearchModal: Modal}]) => { @@ -135,7 +151,7 @@ function Hit({ children, }: { hit: InternalDocSearchHit | StoredDocSearchHit; - children: React.ReactNode; + children: ReactNode; }) { return {children}; } @@ -163,14 +179,7 @@ function useSearchParameters({ contextualSearch, ...props }: DocSearchProps): DocSearchProps['searchParameters'] { - function mergeFacetFilters(f1: FacetFilters, f2: FacetFilters): FacetFilters { - const normalize = (f: FacetFilters): FacetFilters => - typeof f === 'string' ? [f] : f; - return [...normalize(f1), ...normalize(f2)]; - } - - const contextualSearchFacetFilters = - useAlgoliaContextualFacetFilters() as FacetFilters; + const contextualSearchFacetFilters = useAlgoliaContextualFacetFilters(); const configFacetFilters: FacetFilters = props.searchParameters?.facetFilters ?? []; @@ -188,20 +197,22 @@ function useSearchParameters({ }; } -function DocSearch({externalUrlRegex, ...props}: DocSearchProps) { +function DocSearch({externalUrlRegex, ...props}: DocSearchV4Props) { const navigator = useNavigator({externalUrlRegex}); - const searchParameters = useSearchParameters({...props}); + const searchParameters = useSearchParameters({...props} as DocSearchProps); const transformItems = useTransformItems(props); const transformSearchClient = useTransformSearchClient(); const searchContainer = useRef(null); - // TODO remove "as any" after React 19 upgrade - const searchButtonRef = useRef(null as any); + const searchButtonRef = useRef(null); const [isOpen, setIsOpen] = useState(false); const [initialQuery, setInitialQuery] = useState( undefined, ); + const {isAskAiActive, currentPlaceholder, onAskAiToggle, extraAskAiProps} = + useAlgoliaAskAi(props); + const prepareSearchContainer = useCallback(() => { if (!searchContainer.current) { const divElement = document.createElement('div'); @@ -219,7 +230,8 @@ function DocSearch({externalUrlRegex, ...props}: DocSearchProps) { setIsOpen(false); searchButtonRef.current?.focus(); setInitialQuery(undefined); - }, []); + onAskAiToggle(false); + }, [onAskAiToggle]); const handleInput = useCallback( (event: KeyboardEvent) => { @@ -243,7 +255,13 @@ function DocSearch({externalUrlRegex, ...props}: DocSearchProps) { onClose: closeModal, onInput: handleInput, searchButtonRef, - }); + isAskAiActive: isAskAiActive ?? false, + onAskAiToggle: onAskAiToggle ?? (() => {}), + } satisfies UseDocSearchKeyboardEventsProps & { + // TODO Docusaurus v4: cleanup after we drop support for DocSearch v3 + isAskAiActive: boolean; + onAskAiToggle: (askAiToggle: boolean) => void; + } as UseDocSearchKeyboardEventsProps); return ( <> @@ -269,8 +287,6 @@ function DocSearch({externalUrlRegex, ...props}: DocSearchProps) { {isOpen && DocSearchModal && - // TODO need to fix this React Compiler lint error - // eslint-disable-next-line react-compiler/react-compiler searchContainer.current && createPortal( , - // TODO need to fix this React Compiler lint error - // eslint-disable-next-line react-compiler/react-compiler searchContainer.current, )} ); } -export default function SearchBar(): ReactNode { +export default function SearchBar(props: Partial): ReactNode { const {siteConfig} = useDocusaurusContext(); - return ; + + const docSearchProps: DocSearchV4Props = { + ...(siteConfig.themeConfig.algolia as DocSearchV4Props), + // Let props override theme config + // See https://github.com/facebook/docusaurus/pull/11581 + ...props, + }; + + return ; } diff --git a/packages/docusaurus-theme-search-algolia/src/theme/SearchBar/styles.css b/packages/docusaurus-theme-search-algolia/src/theme/SearchBar/styles.css index c80dd71d37..78689effe4 100644 --- a/packages/docusaurus-theme-search-algolia/src/theme/SearchBar/styles.css +++ b/packages/docusaurus-theme-search-algolia/src/theme/SearchBar/styles.css @@ -19,3 +19,7 @@ .DocSearch-Container { z-index: calc(var(--ifm-z-index-fixed) + 1); } + +.DocSearch-Button-Key { + padding: 0; +} diff --git a/packages/docusaurus-theme-search-algolia/src/theme/SearchPage/index.tsx b/packages/docusaurus-theme-search-algolia/src/theme/SearchPage/index.tsx index 0dd822f6e8..fb275f506b 100644 --- a/packages/docusaurus-theme-search-algolia/src/theme/SearchPage/index.tsx +++ b/packages/docusaurus-theme-search-algolia/src/theme/SearchPage/index.tsx @@ -139,6 +139,65 @@ function SearchVersionSelectList({ ); } +function AlgoliaLogo(): ReactNode { + return ( + + + {/* eslint-disable-next-line @docusaurus/no-untranslated-text */} + + + + + + + + + + + + + ); +} + type ResultDispatcherState = { items: { title: string; @@ -435,36 +494,23 @@ function SearchPageContent(): ReactNode { documentsFoundPlural(searchResultState.totalResults)}
  • -
    +
    + + {translate({ + id: 'theme.SearchPage.algoliaLabel', + message: 'Powered by', + description: + 'The text explain that the search powered by Algolia', + })} + - - - - - - - +
    diff --git a/packages/docusaurus-theme-search-algolia/src/theme/SearchPage/styles.module.css b/packages/docusaurus-theme-search-algolia/src/theme/SearchPage/styles.module.css index d00563767f..29c4389f55 100644 --- a/packages/docusaurus-theme-search-algolia/src/theme/SearchPage/styles.module.css +++ b/packages/docusaurus-theme-search-algolia/src/theme/SearchPage/styles.module.css @@ -33,12 +33,20 @@ font-weight: bold; } -.algoliaLogo { - max-width: 150px; +.searchLogoColumn { + display: flex; + align-items: center; + gap: 0.5rem; + justify-content: flex-end; } -.algoliaLogoPathFill { - fill: var(--ifm-font-color-base); +.searchLogoColumn a { + display: flex; +} + +.searchLogoColumn span { + color: var(--docsearch-muted-color); + font-weight: normal; } .searchResultItem { diff --git a/packages/docusaurus-theme-search-algolia/src/theme/SearchTranslations/index.ts b/packages/docusaurus-theme-search-algolia/src/theme/SearchTranslations/index.ts index 40d0f44ec0..d0bf1b2b8c 100644 --- a/packages/docusaurus-theme-search-algolia/src/theme/SearchTranslations/index.ts +++ b/packages/docusaurus-theme-search-algolia/src/theme/SearchTranslations/index.ts @@ -9,7 +9,62 @@ import {translate} from '@docusaurus/Translate'; import type {DocSearchTranslations} from '@docsearch/react'; -const translations: DocSearchTranslations & {placeholder: string} = { +// TODO Docusaurus v4: require DocSearch v4 +// This needs to be cleaned after the upgrade +// Docusaurus v3 was made compatible with both DocSearch v3 and v4 +// This implies that labels have been kept retro-compatible with v3 +// Once we upgrade, we should be able to rely on v4 types only +// and remove v3 retro-compatibility labels that do not exist anymore in v4 +const translations: DocSearchTranslations & { + placeholder: string; + modal: { + searchBox: { + placeholderText: string; + placeholderTextAskAi: string; + placeholderTextAskAiStreaming: string; + enterKeyHintAskAi: string; + searchInputLabel: string; + backToKeywordSearchButtonText: string; + backToKeywordSearchButtonAriaLabel: string; + enterKeyHint: string; + clearButtonTitle: string; + clearButtonAriaLabel: string; + closeButtonText: string; + resetButtonTitle: string; + resetButtonAriaLabel: string; + cancelButtonText: string; + cancelButtonAriaLabel: string; + closeButtonAriaLabel: string; + }; + startScreen: { + recentConversationsTitle: string; + removeRecentConversationButtonTitle: string; + }; + resultsScreen: { + askAiPlaceholder: string; + }; + askAiScreen: { + disclaimerText: string; + relatedSourcesText: string; + thinkingText: string; + copyButtonText: string; + copyButtonCopiedText: string; + copyButtonTitle: string; + likeButtonTitle: string; + dislikeButtonTitle: string; + thanksForFeedbackText: string; + preToolCallText: string; + duringToolCallText: string; + afterToolCallText: string; + }; + footer: { + submitQuestionText: string; + poweredByText: string; + backToSearchText: string; + searchByText: string; + }; + }; +} = { button: { buttonText: translate({ id: 'theme.SearchBar.label', @@ -44,6 +99,69 @@ const translations: DocSearchTranslations & {placeholder: string} = { message: 'Cancel', description: 'The label and ARIA label for search box cancel button', }), + + // v4 + clearButtonTitle: translate({ + id: 'theme.SearchModal.searchBox.resetButtonTitle', + message: 'Clear the query', + description: 'The label and ARIA label for search box reset button', + }), + clearButtonAriaLabel: translate({ + id: 'theme.SearchModal.searchBox.resetButtonTitle', + message: 'Clear the query', + description: 'The label and ARIA label for search box reset button', + }), + closeButtonText: translate({ + id: 'theme.SearchModal.searchBox.cancelButtonText', + message: 'Cancel', + description: 'The label and ARIA label for search box cancel button', + }), + closeButtonAriaLabel: translate({ + id: 'theme.SearchModal.searchBox.cancelButtonText', + message: 'Cancel', + description: 'The label and ARIA label for search box cancel button', + }), + placeholderText: translate({ + id: 'theme.SearchModal.searchBox.placeholderText', + message: 'Search docs', + description: 'The placeholder text for the main search input field', + }), + placeholderTextAskAi: translate({ + id: 'theme.SearchModal.searchBox.placeholderTextAskAi', + message: 'Ask another question...', + description: 'The placeholder text when in AI question mode', + }), + placeholderTextAskAiStreaming: translate({ + id: 'theme.SearchModal.searchBox.placeholderTextAskAiStreaming', + message: 'Answering...', + description: + 'The placeholder text for search box when AI is streaming an answer', + }), + enterKeyHint: translate({ + id: 'theme.SearchModal.searchBox.enterKeyHint', + message: 'search', + description: 'The hint for the search box enter key text', + }), + enterKeyHintAskAi: translate({ + id: 'theme.SearchModal.searchBox.enterKeyHintAskAi', + message: 'enter', + description: 'The hint for the Ask AI search box enter key text', + }), + searchInputLabel: translate({ + id: 'theme.SearchModal.searchBox.searchInputLabel', + message: 'Search', + description: 'The ARIA label for search input', + }), + backToKeywordSearchButtonText: translate({ + id: 'theme.SearchModal.searchBox.backToKeywordSearchButtonText', + message: 'Back to keyword search', + description: 'The text for back to keyword search button', + }), + backToKeywordSearchButtonAriaLabel: translate({ + id: 'theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel', + message: 'Back to keyword search', + description: 'The ARIA label for back to keyword search button', + }), }, startScreen: { recentSearchesTitle: translate({ @@ -54,17 +172,17 @@ const translations: DocSearchTranslations & {placeholder: string} = { noRecentSearchesText: translate({ id: 'theme.SearchModal.startScreen.noRecentSearchesText', message: 'No recent searches', - description: 'The text when no recent searches', + description: 'The text when there are no recent searches', }), saveRecentSearchButtonTitle: translate({ id: 'theme.SearchModal.startScreen.saveRecentSearchButtonTitle', message: 'Save this search', - description: 'The label for save recent search button', + description: 'The title for save recent search button', }), removeRecentSearchButtonTitle: translate({ id: 'theme.SearchModal.startScreen.removeRecentSearchButtonTitle', message: 'Remove this search from history', - description: 'The label for remove recent search button', + description: 'The title for remove recent search button', }), favoriteSearchesTitle: translate({ id: 'theme.SearchModal.startScreen.favoriteSearchesTitle', @@ -74,91 +192,178 @@ const translations: DocSearchTranslations & {placeholder: string} = { removeFavoriteSearchButtonTitle: translate({ id: 'theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle', message: 'Remove this search from favorites', - description: 'The label for remove favorite search button', + description: 'The title for remove favorite search button', + }), + recentConversationsTitle: translate({ + id: 'theme.SearchModal.startScreen.recentConversationsTitle', + message: 'Recent conversations', + description: 'The title for recent conversations', + }), + removeRecentConversationButtonTitle: translate({ + id: 'theme.SearchModal.startScreen.removeRecentConversationButtonTitle', + message: 'Remove this conversation from history', + description: 'The title for remove recent conversation button', }), }, errorScreen: { titleText: translate({ id: 'theme.SearchModal.errorScreen.titleText', message: 'Unable to fetch results', - description: 'The title for error screen of search modal', + description: 'The title for error screen', }), helpText: translate({ id: 'theme.SearchModal.errorScreen.helpText', message: 'You might want to check your network connection.', - description: 'The help text for error screen of search modal', + description: 'The help text for error screen', + }), + }, + resultsScreen: { + askAiPlaceholder: translate({ + id: 'theme.SearchModal.resultsScreen.askAiPlaceholder', + message: 'Ask AI: ', + description: 'The placeholder text for Ask AI input', + }), + }, + askAiScreen: { + disclaimerText: translate({ + id: 'theme.SearchModal.askAiScreen.disclaimerText', + message: + 'Answers are generated with AI which can make mistakes. Verify responses.', + description: 'The disclaimer text for AI answers', + }), + relatedSourcesText: translate({ + id: 'theme.SearchModal.askAiScreen.relatedSourcesText', + message: 'Related sources', + description: 'The text for related sources', + }), + thinkingText: translate({ + id: 'theme.SearchModal.askAiScreen.thinkingText', + message: 'Thinking...', + description: 'The text when AI is thinking', + }), + copyButtonText: translate({ + id: 'theme.SearchModal.askAiScreen.copyButtonText', + message: 'Copy', + description: 'The text for copy button', + }), + copyButtonCopiedText: translate({ + id: 'theme.SearchModal.askAiScreen.copyButtonCopiedText', + message: 'Copied!', + description: 'The text for copy button when copied', + }), + copyButtonTitle: translate({ + id: 'theme.SearchModal.askAiScreen.copyButtonTitle', + message: 'Copy', + description: 'The title for copy button', + }), + likeButtonTitle: translate({ + id: 'theme.SearchModal.askAiScreen.likeButtonTitle', + message: 'Like', + description: 'The title for like button', + }), + dislikeButtonTitle: translate({ + id: 'theme.SearchModal.askAiScreen.dislikeButtonTitle', + message: 'Dislike', + description: 'The title for dislike button', + }), + thanksForFeedbackText: translate({ + id: 'theme.SearchModal.askAiScreen.thanksForFeedbackText', + message: 'Thanks for your feedback!', + description: 'The text for thanks for feedback', + }), + preToolCallText: translate({ + id: 'theme.SearchModal.askAiScreen.preToolCallText', + message: 'Searching...', + description: 'The text before tool call', + }), + duringToolCallText: translate({ + id: 'theme.SearchModal.askAiScreen.duringToolCallText', + message: 'Searching for ', + description: 'The text during tool call', + }), + afterToolCallText: translate({ + id: 'theme.SearchModal.askAiScreen.afterToolCallText', + message: 'Searched for', + description: 'The text after tool call', }), }, footer: { selectText: translate({ id: 'theme.SearchModal.footer.selectText', - message: 'to select', - description: 'The explanatory text of the action for the enter key', + message: 'Select', + description: 'The select text for footer', + }), + submitQuestionText: translate({ + id: 'theme.SearchModal.footer.submitQuestionText', + message: 'Submit question', + description: 'The submit question text for footer', }), selectKeyAriaLabel: translate({ id: 'theme.SearchModal.footer.selectKeyAriaLabel', message: 'Enter key', - description: - 'The ARIA label for the Enter key button that makes the selection', + description: 'The ARIA label for select key in footer', }), navigateText: translate({ id: 'theme.SearchModal.footer.navigateText', - message: 'to navigate', - description: - 'The explanatory text of the action for the Arrow up and Arrow down key', + message: 'Navigate', + description: 'The navigate text for footer', }), navigateUpKeyAriaLabel: translate({ id: 'theme.SearchModal.footer.navigateUpKeyAriaLabel', message: 'Arrow up', - description: - 'The ARIA label for the Arrow up key button that makes the navigation', + description: 'The ARIA label for navigate up key in footer', }), navigateDownKeyAriaLabel: translate({ id: 'theme.SearchModal.footer.navigateDownKeyAriaLabel', message: 'Arrow down', - description: - 'The ARIA label for the Arrow down key button that makes the navigation', + description: 'The ARIA label for navigate down key in footer', }), closeText: translate({ id: 'theme.SearchModal.footer.closeText', - message: 'to close', - description: 'The explanatory text of the action for Escape key', + message: 'Close', + description: 'The close text for footer', }), closeKeyAriaLabel: translate({ id: 'theme.SearchModal.footer.closeKeyAriaLabel', message: 'Escape key', - description: - 'The ARIA label for the Escape key button that close the modal', + description: 'The ARIA label for close key in footer', + }), + poweredByText: translate({ + id: 'theme.SearchModal.footer.searchByText', + message: 'Powered by', + description: "The 'Powered by' text for footer", }), searchByText: translate({ id: 'theme.SearchModal.footer.searchByText', - message: 'Search by', - description: 'The text explain that the search is making by Algolia', + message: 'Powered by', + description: "The 'Powered by' text for footer", + }), + backToSearchText: translate({ + id: 'theme.SearchModal.footer.backToSearchText', + message: 'Back to search', + description: 'The back to search text for footer', }), }, noResultsScreen: { noResultsText: translate({ id: 'theme.SearchModal.noResultsScreen.noResultsText', - message: 'No results for', - description: - 'The text explains that there are no results for the following search', + message: 'No results found for', + description: 'The text when there are no results', }), suggestedQueryText: translate({ id: 'theme.SearchModal.noResultsScreen.suggestedQueryText', message: 'Try searching for', - description: - 'The text for the suggested query when no results are found for the following search', + description: 'The text for suggested query', }), reportMissingResultsText: translate({ id: 'theme.SearchModal.noResultsScreen.reportMissingResultsText', message: 'Believe this query should return results?', - description: - 'The text for the question where the user thinks there are missing results', + description: 'The text for reporting missing results', }), reportMissingResultsLinkText: translate({ id: 'theme.SearchModal.noResultsScreen.reportMissingResultsLinkText', message: 'Let us know.', - description: 'The text for the link to report missing results', + description: 'The link text for reporting missing results', }), }, }, diff --git a/packages/docusaurus-theme-search-algolia/src/validateThemeConfig.ts b/packages/docusaurus-theme-search-algolia/src/validateThemeConfig.ts index 2e1061d864..2df1266bae 100644 --- a/packages/docusaurus-theme-search-algolia/src/validateThemeConfig.ts +++ b/packages/docusaurus-theme-search-algolia/src/validateThemeConfig.ts @@ -7,22 +7,27 @@ import {escapeRegexp} from '@docusaurus/utils'; import {Joi} from '@docusaurus/utils-validation'; +import {docSearchV3} from './docSearchVersion'; +import type {ThemeConfigValidationContext} from '@docusaurus/types'; import type { ThemeConfig, - ThemeConfigValidationContext, -} from '@docusaurus/types'; + ThemeConfigAlgolia, +} from '@docusaurus/theme-search-algolia'; export const DEFAULT_CONFIG = { // Enabled by default, as it makes sense in most cases // see also https://github.com/facebook/docusaurus/issues/5880 contextualSearch: true, - searchParameters: {}, searchPagePath: 'search', -}; +} satisfies Partial; + +const FacetFiltersSchema = Joi.array().items( + Joi.alternatives().try(Joi.string(), Joi.array().items(Joi.string())), +); export const Schema = Joi.object({ - algolia: Joi.object({ + algolia: Joi.object({ // Docusaurus attributes contextualSearch: Joi.boolean().default(DEFAULT_CONFIG.contextualSearch), externalUrlRegex: Joi.string().optional(), @@ -33,7 +38,9 @@ export const Schema = Joi.object({ }), apiKey: Joi.string().required(), indexName: Joi.string().required(), - searchParameters: Joi.object() + searchParameters: Joi.object({ + facetFilters: FacetFiltersSchema.optional(), + }) .default(DEFAULT_CONFIG.searchParameters) .unknown(), searchPagePath: Joi.alternatives() @@ -53,15 +60,93 @@ export const Schema = Joi.object({ }).required(), to: Joi.string().required(), }).optional(), + // Ask AI configuration (DocSearch v4 only) + askAi: Joi.alternatives() + .try( + // Simple string format (assistantId only) + Joi.string(), + // Full configuration object + Joi.object({ + assistantId: Joi.string().required(), + // Optional Ask AI configuration + indexName: Joi.string().optional(), + apiKey: Joi.string().optional(), + appId: Joi.string().optional(), + searchParameters: Joi.object({ + facetFilters: FacetFiltersSchema.optional(), + }).optional(), + suggestedQuestions: Joi.boolean().optional(), + }), + ) + .custom( + ( + askAiInput: string | ThemeConfigAlgolia['askAi'] | undefined, + helpers, + ) => { + if (!askAiInput) { + return askAiInput; + } + const algolia: ThemeConfigAlgolia = helpers.state.ancestors[0]; + const algoliaFacetFilters = algolia.searchParameters?.facetFilters; + if (typeof askAiInput === 'string') { + return { + assistantId: askAiInput, + indexName: algolia.indexName, + apiKey: algolia.apiKey, + appId: algolia.appId, + ...(algoliaFacetFilters + ? { + searchParameters: { + facetFilters: algoliaFacetFilters, + }, + } + : {}), + } satisfies ThemeConfigAlgolia['askAi']; + } + + // Fill in missing fields with the top-level Algolia config + askAiInput.indexName = askAiInput.indexName ?? algolia.indexName; + askAiInput.apiKey = askAiInput.apiKey ?? algolia.apiKey; + askAiInput.appId = askAiInput.appId ?? algolia.appId; + if ( + askAiInput.searchParameters?.facetFilters === undefined && + algoliaFacetFilters + ) { + askAiInput.searchParameters = askAiInput.searchParameters ?? {}; + askAiInput.searchParameters.facetFilters = algoliaFacetFilters; + } + + return askAiInput; + }, + ) + .optional() + .messages({ + 'alternatives.types': + 'askAi must be either a string (assistantId) or an object with indexName, apiKey, appId, and assistantId', + }), }) .label('themeConfig.algolia') .required() - .unknown(), // DocSearch 3 is still alpha: don't validate the rest for now + .unknown(), }); +// TODO Docusaurus v4: remove this check when we drop DocSearch v3 +function ensureAskAISupported(themeConfig: ThemeConfig) { + // enforce DocsSearch v4 requirement when AskAI is configured + if (themeConfig.algolia.askAi && docSearchV3) { + throw new Error( + 'The askAi feature is only supported in DocSearch v4. ' + + 'Please upgrade to DocSearch v4 by installing "@docsearch/react": "^4.0.0" ' + + 'or remove the askAi configuration from your theme config.', + ); + } +} + export function validateThemeConfig({ validate, - themeConfig, + themeConfig: themeConfigInput, }: ThemeConfigValidationContext): ThemeConfig { - return validate(Schema, themeConfig); + const themeConfig = validate(Schema, themeConfigInput); + ensureAskAISupported(themeConfig); + return themeConfig; } diff --git a/packages/docusaurus-theme-translations/locales/ar/plugin-ideal-image.json b/packages/docusaurus-theme-translations/locales/ar/plugin-ideal-image.json index 7b608bbfc3..50e34409ee 100644 --- a/packages/docusaurus-theme-translations/locales/ar/plugin-ideal-image.json +++ b/packages/docusaurus-theme-translations/locales/ar/plugin-ideal-image.json @@ -1,7 +1,7 @@ { "theme.IdealImageMessage.404error": "404. لم يتم العثور على الصورة", - "theme.IdealImageMessage.error": "خطا. قم بالضغط لاعادة التحميل", - "theme.IdealImageMessage.load": "قم بالضغط للتحميل{sizeMessage}", + "theme.IdealImageMessage.error": "خطأ. قم بالضغط لإعادة التحميل", + "theme.IdealImageMessage.load": "قم بالضغط للتحميل {sizeMessage}", "theme.IdealImageMessage.loading": "جاري التحميل...", - "theme.IdealImageMessage.offline": "متصفحك غير متصل, لم يتم تحميل الصورة" + "theme.IdealImageMessage.offline": "مُتصفحك غير مُتصل, لم يتم تحميل الصورة" } diff --git a/packages/docusaurus-theme-translations/locales/ar/plugin-pwa.json b/packages/docusaurus-theme-translations/locales/ar/plugin-pwa.json index 5876b26ea7..365e7061e6 100644 --- a/packages/docusaurus-theme-translations/locales/ar/plugin-pwa.json +++ b/packages/docusaurus-theme-translations/locales/ar/plugin-pwa.json @@ -1,5 +1,5 @@ { "theme.PwaReloadPopup.closeButtonAriaLabel": "إغلاق", - "theme.PwaReloadPopup.info": "نسخة جديدة متاحة", + "theme.PwaReloadPopup.info": "نُسخة جديـدة مُتـاحة", "theme.PwaReloadPopup.refreshButtonText": "تحديث" } diff --git a/packages/docusaurus-theme-translations/locales/ar/theme-common.json b/packages/docusaurus-theme-translations/locales/ar/theme-common.json index dab32c9c31..e30e940f45 100644 --- a/packages/docusaurus-theme-translations/locales/ar/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/ar/theme-common.json @@ -1,6 +1,6 @@ { "theme.AnnouncementBar.closeButtonAriaLabel": "إغلاق", - "theme.BackToTopButton.buttonAriaLabel": "أنتقل للأعلى", + "theme.BackToTopButton.buttonAriaLabel": "إنتقل للأعلى", "theme.CodeBlock.copied": "تم النسخ", "theme.CodeBlock.copy": "نسخ", "theme.CodeBlock.copyButtonAriaLabel": "نسخ الرمز إلى الحافظة", @@ -8,12 +8,13 @@ "theme.DocSidebarItem.collapseCategoryAriaLabel": "Collapse sidebar category '{label}'", "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", "theme.ErrorPageContent.title": "هذه الصفحة لا تستجيب.", - "theme.ErrorPageContent.tryAgain": "المحاولة مجددا", + "theme.ErrorPageContent.tryAgain": "المُحاولة مجددًا", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Main", "theme.NotFound.p1": "لم نتمكن من العثور على ما كنت تبحث عنه.", - "theme.NotFound.p2": "يرجى الاتصال بمالك الموقع الذي ربطك بعنوان URL الأصلي وإخباره بأن الارتباط الخاص به معطل.", + "theme.NotFound.p2": "يُـرجى الإتصال بمالك الموقع الذي ربطك بعنوان URL الأصلي وإخباره بأن الارتباط الخاص به مُعطل.", "theme.NotFound.title": "الصفحة غير موجودة", - "theme.TOCCollapsible.toggleButtonLabel": "محتويات هذه الصفحة", + "theme.TOCCollapsible.toggleButtonLabel": "مُحتويات هذه الصفحة", "theme.admonition.caution": "حذر", "theme.admonition.danger": "خطر", "theme.admonition.info": "معلومات", @@ -27,24 +28,24 @@ "theme.blog.authorsList.pageTitle": "Authors", "theme.blog.authorsList.viewAll": "View All Authors", "theme.blog.paginator.navAriaLabel": "التنقل في صفحة قائمة المدونة", - "theme.blog.paginator.newerEntries": "إدخالات أحدث", - "theme.blog.paginator.olderEntries": "إدخالات أقدم", + "theme.blog.paginator.newerEntries": "أحدث الإدخالات", + "theme.blog.paginator.olderEntries": "أقدم الإدخالات", "theme.blog.post.paginator.navAriaLabel": "التنقل في صفحة مقالات المدونة", - "theme.blog.post.paginator.newerPost": "مقالات أحدث", - "theme.blog.post.paginator.olderPost": "مقالات أقدم", - "theme.blog.post.plurals": "مقاله واحده|{count} مقالات", + "theme.blog.post.paginator.newerPost": "أحدث المقالات", + "theme.blog.post.paginator.olderPost": "أقدم المقالات", + "theme.blog.post.plurals": "مقالة واحدة|{count} مقالات", "theme.blog.post.readMore": "اقرأ المزيد", - "theme.blog.post.readMoreLabel": "اقراء المزيد {title}", + "theme.blog.post.readMoreLabel": "اقرأ المزيد {title}", "theme.blog.post.readingTime.plurals": "{readingTime} دقائق قراءة|{readingTime} دقائق قراءة", - "theme.blog.sidebar.navAriaLabel": "أحدث مشاركات المدونة", - "theme.blog.tagTitle": "{nPosts} موسومة ب \"{tagName}\"", + "theme.blog.sidebar.navAriaLabel": "أحدث مُشـاركات المدونة", + "theme.blog.tagTitle": "{nPosts} موسومة بـ \"{tagName}\"", "theme.colorToggle.ariaLabel": "التبديل بين الوضع الداكن والفاتح (الحالي {mode})", "theme.colorToggle.ariaLabel.mode.dark": "الوضع الداكن", "theme.colorToggle.ariaLabel.mode.light": "الوضع الفاتح", "theme.colorToggle.ariaLabel.mode.system": "system mode", "theme.common.editThisPage": "تعديل هذه الصفحة", - "theme.common.headingLinkTitle": "ارتباط مباشر بالعنوان {heading}", - "theme.common.skipToMainContent": "انتقل إلى المحتوى الرئيسي", + "theme.common.headingLinkTitle": "إرتباط مُبـاشر بالعنوان {heading}", + "theme.common.skipToMainContent": "إنتقل إلى المحتوى الرئيسي", "theme.contentVisibility.draftBanner.message": "This page is a draft. It will only be visible in dev and be excluded from the production build.", "theme.contentVisibility.draftBanner.title": "Draft page", "theme.contentVisibility.unlistedBanner.message": "This page is unlisted. Search engines will not index it, and only users having a direct link can access it.", @@ -64,19 +65,19 @@ "theme.docs.sidebar.toggleSidebarButtonAriaLabel": "Toggle navigation bar", "theme.docs.tagDocListPageTitle": "{nDocsTagged} مستند موسوم بـ \"{tagName}\"", "theme.docs.tagDocListPageTitle.nDocsTagged": "مستند موسوم واحد|{count} مستندات موسومة", - "theme.docs.versionBadge.label": "الأصدار: {versionLabel}", - "theme.docs.versions.latestVersionLinkLabel": "احدث اصدار", + "theme.docs.versionBadge.label": "الإصدار: {versionLabel}", + "theme.docs.versions.latestVersionLinkLabel": "احدث إصدار", "theme.docs.versions.latestVersionSuggestionLabel": "للحصول على أحدث الوثائق، راجع {latestVersionLink} ({versionLabel}).", "theme.docs.versions.unmaintainedVersionLabel": "هذه هي وثائق {siteTitle} {versionLabel}، التي لم تعد تتم صيانتها بشكل نشط.", - "theme.docs.versions.unreleasedVersionLabel": "هذه وثائق لم يتم طرحها للإصدار {siteTitle} {versionLabel}.", + "theme.docs.versions.unreleasedVersionLabel": "هذه الوثائق لم يتم طرحها بَعـد للإصدار {siteTitle} {versionLabel}.", "theme.lastUpdated.atDate": " في {date}", "theme.lastUpdated.byUser": " بواسطة {user}", - "theme.lastUpdated.lastUpdatedAtBy": "آخر تحديث{atDate}{byUser}", + "theme.lastUpdated.lastUpdatedAtBy": "آخر تحديث {atDate}{byUser}", "theme.navbar.mobileDropdown.collapseButton.collapseAriaLabel": "Collapse the dropdown", "theme.navbar.mobileDropdown.collapseButton.expandAriaLabel": "Expand the dropdown", - "theme.navbar.mobileLanguageDropdown.label": "اللغات", + "theme.navbar.mobileLanguageDropdown.label": "اللُغـات", "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": "→ العودة إلى القائمة الرئيسية", - "theme.navbar.mobileVersionsDropdown.label": "إصدارات", + "theme.navbar.mobileVersionsDropdown.label": "الإصدارات", "theme.tags.tagsListLabel": "الوسوم:", "theme.tags.tagsPageLink": "عرض كل الوسوم", "theme.tags.tagsPageTitle": "الوسوم" diff --git a/packages/docusaurus-theme-translations/locales/ar/theme-live-codeblock.json b/packages/docusaurus-theme-translations/locales/ar/theme-live-codeblock.json index 08e67dd7ce..a63dcf38ac 100644 --- a/packages/docusaurus-theme-translations/locales/ar/theme-live-codeblock.json +++ b/packages/docusaurus-theme-translations/locales/ar/theme-live-codeblock.json @@ -1,4 +1,4 @@ { - "theme.Playground.liveEditor": "محرر مباشر", + "theme.Playground.liveEditor": "مُحـرر مُبـاشر", "theme.Playground.result": "النتيجة" } diff --git a/packages/docusaurus-theme-translations/locales/ar/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/ar/theme-search-algolia.json index 69ce6e9ce6..43bd6253cd 100644 --- a/packages/docusaurus-theme-translations/locales/ar/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/ar/theme-search-algolia.json @@ -1,30 +1,55 @@ { "theme.SearchBar.label": "بحث", "theme.SearchBar.seeAll": "مشاهدة جميع {count} نتائج", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "You might want to check your network connection.", "theme.SearchModal.errorScreen.titleText": "Unable to fetch results", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape key", "theme.SearchModal.footer.closeText": "to close", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Arrow down", "theme.SearchModal.footer.navigateText": "to navigate", "theme.SearchModal.footer.navigateUpKeyAriaLabel": "Arrow up", - "theme.SearchModal.footer.searchByText": "Search by", + "theme.SearchModal.footer.searchByText": "Powered by", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter key", "theme.SearchModal.footer.selectText": "to select", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "No results for", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Let us know.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Believe this query should return results?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Try searching for", "theme.SearchModal.placeholder": "Search docs", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Cancel", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Clear the query", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favorite", "theme.SearchModal.startScreen.noRecentSearchesText": "No recent searches", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Recent", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Remove this search from favorites", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Remove this search from history", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Save this search", - "theme.SearchPage.algoliaLabel": "البحث بواسطه Algolia", + "theme.SearchPage.algoliaLabel": "مدعوم من Algolia", "theme.SearchPage.documentsFound.plurals": "تم العثور على مستند واحد|تم العثور على {count} مستندات", "theme.SearchPage.emptyResultsTitle": "ابحث في الوثائق", "theme.SearchPage.existingResultsTitle": "نتائج البحث عن \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/base/theme-common.json b/packages/docusaurus-theme-translations/locales/base/theme-common.json index b2762a0702..0efe3bd5c1 100644 --- a/packages/docusaurus-theme-translations/locales/base/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/base/theme-common.json @@ -19,6 +19,8 @@ "theme.ErrorPageContent.title___DESCRIPTION": "The title of the fallback page when the page crashed", "theme.ErrorPageContent.tryAgain": "Try again", "theme.ErrorPageContent.tryAgain___DESCRIPTION": "The label of the button to try again rendering when the React error boundary captures an error", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", + "theme.IconExternalLink.ariaLabel___DESCRIPTION": "The ARIA label for the external link icon", "theme.NavBar.navAriaLabel": "Main", "theme.NavBar.navAriaLabel___DESCRIPTION": "The ARIA label for the main navigation", "theme.NotFound.p1": "We could not find what you were looking for.", diff --git a/packages/docusaurus-theme-translations/locales/base/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/base/theme-search-algolia.json index dc394f4d88..afa916b463 100644 --- a/packages/docusaurus-theme-translations/locales/base/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/base/theme-search-algolia.json @@ -2,54 +2,104 @@ "theme.SearchBar.label": "Search", "theme.SearchBar.label___DESCRIPTION": "The ARIA label and placeholder for search button", "theme.SearchBar.seeAll": "See all {count} results", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.afterToolCallText___DESCRIPTION": "The text after tool call", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonCopiedText___DESCRIPTION": "The text for copy button when copied", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonText___DESCRIPTION": "The text for copy button", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle___DESCRIPTION": "The title for copy button", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.disclaimerText___DESCRIPTION": "The disclaimer text for AI answers", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.dislikeButtonTitle___DESCRIPTION": "The title for dislike button", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.duringToolCallText___DESCRIPTION": "The text during tool call", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.likeButtonTitle___DESCRIPTION": "The title for like button", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.preToolCallText___DESCRIPTION": "The text before tool call", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.relatedSourcesText___DESCRIPTION": "The text for related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thanksForFeedbackText___DESCRIPTION": "The text for thanks for feedback", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", + "theme.SearchModal.askAiScreen.thinkingText___DESCRIPTION": "The text when AI is thinking", "theme.SearchModal.errorScreen.helpText": "You might want to check your network connection.", - "theme.SearchModal.errorScreen.helpText___DESCRIPTION": "The help text for error screen of search modal", + "theme.SearchModal.errorScreen.helpText___DESCRIPTION": "The help text for error screen", "theme.SearchModal.errorScreen.titleText": "Unable to fetch results", - "theme.SearchModal.errorScreen.titleText___DESCRIPTION": "The title for error screen of search modal", + "theme.SearchModal.errorScreen.titleText___DESCRIPTION": "The title for error screen", + "theme.SearchModal.footer.backToSearchText": "Back to search", + "theme.SearchModal.footer.backToSearchText___DESCRIPTION": "The back to search text for footer", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape key", - "theme.SearchModal.footer.closeKeyAriaLabel___DESCRIPTION": "The ARIA label for the Escape key button that close the modal", - "theme.SearchModal.footer.closeText": "to close", - "theme.SearchModal.footer.closeText___DESCRIPTION": "The explanatory text of the action for Escape key", + "theme.SearchModal.footer.closeKeyAriaLabel___DESCRIPTION": "The ARIA label for close key in footer", + "theme.SearchModal.footer.closeText": "Close", + "theme.SearchModal.footer.closeText___DESCRIPTION": "The close text for footer", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Arrow down", - "theme.SearchModal.footer.navigateDownKeyAriaLabel___DESCRIPTION": "The ARIA label for the Arrow down key button that makes the navigation", - "theme.SearchModal.footer.navigateText": "to navigate", - "theme.SearchModal.footer.navigateText___DESCRIPTION": "The explanatory text of the action for the Arrow up and Arrow down key", + "theme.SearchModal.footer.navigateDownKeyAriaLabel___DESCRIPTION": "The ARIA label for navigate down key in footer", + "theme.SearchModal.footer.navigateText": "Navigate", + "theme.SearchModal.footer.navigateText___DESCRIPTION": "The navigate text for footer", "theme.SearchModal.footer.navigateUpKeyAriaLabel": "Arrow up", - "theme.SearchModal.footer.navigateUpKeyAriaLabel___DESCRIPTION": "The ARIA label for the Arrow up key button that makes the navigation", - "theme.SearchModal.footer.searchByText": "Search by", - "theme.SearchModal.footer.searchByText___DESCRIPTION": "The text explain that the search is making by Algolia", + "theme.SearchModal.footer.navigateUpKeyAriaLabel___DESCRIPTION": "The ARIA label for navigate up key in footer", + "theme.SearchModal.footer.searchByText": "Powered by", + "theme.SearchModal.footer.searchByText___DESCRIPTION": "The 'Powered by' text for footer", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter key", - "theme.SearchModal.footer.selectKeyAriaLabel___DESCRIPTION": "The ARIA label for the Enter key button that makes the selection", - "theme.SearchModal.footer.selectText": "to select", - "theme.SearchModal.footer.selectText___DESCRIPTION": "The explanatory text of the action for the enter key", - "theme.SearchModal.noResultsScreen.noResultsText": "No results for", - "theme.SearchModal.noResultsScreen.noResultsText___DESCRIPTION": "The text explains that there are no results for the following search", + "theme.SearchModal.footer.selectKeyAriaLabel___DESCRIPTION": "The ARIA label for select key in footer", + "theme.SearchModal.footer.selectText": "Select", + "theme.SearchModal.footer.selectText___DESCRIPTION": "The select text for footer", + "theme.SearchModal.footer.submitQuestionText": "Submit question", + "theme.SearchModal.footer.submitQuestionText___DESCRIPTION": "The submit question text for footer", + "theme.SearchModal.noResultsScreen.noResultsText": "No results found for", + "theme.SearchModal.noResultsScreen.noResultsText___DESCRIPTION": "The text when there are no results", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Let us know.", - "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText___DESCRIPTION": "The text for the link to report missing results", + "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText___DESCRIPTION": "The link text for reporting missing results", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Believe this query should return results?", - "theme.SearchModal.noResultsScreen.reportMissingResultsText___DESCRIPTION": "The text for the question where the user thinks there are missing results", + "theme.SearchModal.noResultsScreen.reportMissingResultsText___DESCRIPTION": "The text for reporting missing results", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Try searching for", - "theme.SearchModal.noResultsScreen.suggestedQueryText___DESCRIPTION": "The text for the suggested query when no results are found for the following search", + "theme.SearchModal.noResultsScreen.suggestedQueryText___DESCRIPTION": "The text for suggested query", "theme.SearchModal.placeholder": "Search docs", "theme.SearchModal.placeholder___DESCRIPTION": "The placeholder of the input of the DocSearch pop-up modal", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.resultsScreen.askAiPlaceholder___DESCRIPTION": "The placeholder text for Ask AI input", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel___DESCRIPTION": "The ARIA label for back to keyword search button", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText___DESCRIPTION": "The text for back to keyword search button", "theme.SearchModal.searchBox.cancelButtonText": "Cancel", "theme.SearchModal.searchBox.cancelButtonText___DESCRIPTION": "The label and ARIA label for search box cancel button", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHint___DESCRIPTION": "The hint for the search box enter key text", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.enterKeyHintAskAi___DESCRIPTION": "The hint for the Ask AI search box enter key text", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderText___DESCRIPTION": "The placeholder text for the main search input field", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAi___DESCRIPTION": "The placeholder text when in AI question mode", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming___DESCRIPTION": "The placeholder text for search box when AI is streaming an answer", "theme.SearchModal.searchBox.resetButtonTitle": "Clear the query", "theme.SearchModal.searchBox.resetButtonTitle___DESCRIPTION": "The label and ARIA label for search box reset button", + "theme.SearchModal.searchBox.searchInputLabel": "Search", + "theme.SearchModal.searchBox.searchInputLabel___DESCRIPTION": "The ARIA label for search input", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favorite", "theme.SearchModal.startScreen.favoriteSearchesTitle___DESCRIPTION": "The title for favorite searches", "theme.SearchModal.startScreen.noRecentSearchesText": "No recent searches", - "theme.SearchModal.startScreen.noRecentSearchesText___DESCRIPTION": "The text when no recent searches", + "theme.SearchModal.startScreen.noRecentSearchesText___DESCRIPTION": "The text when there are no recent searches", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", + "theme.SearchModal.startScreen.recentConversationsTitle___DESCRIPTION": "The title for recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Recent", "theme.SearchModal.startScreen.recentSearchesTitle___DESCRIPTION": "The title for recent searches", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Remove this search from favorites", - "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle___DESCRIPTION": "The label for remove favorite search button", + "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle___DESCRIPTION": "The title for remove favorite search button", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle___DESCRIPTION": "The title for remove recent conversation button", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Remove this search from history", - "theme.SearchModal.startScreen.removeRecentSearchButtonTitle___DESCRIPTION": "The label for remove recent search button", + "theme.SearchModal.startScreen.removeRecentSearchButtonTitle___DESCRIPTION": "The title for remove recent search button", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Save this search", - "theme.SearchModal.startScreen.saveRecentSearchButtonTitle___DESCRIPTION": "The label for save recent search button", - "theme.SearchPage.algoliaLabel": "Search by Algolia", - "theme.SearchPage.algoliaLabel___DESCRIPTION": "The ARIA label for Algolia mention", + "theme.SearchModal.startScreen.saveRecentSearchButtonTitle___DESCRIPTION": "The title for save recent search button", + "theme.SearchPage.algoliaLabel": "Powered by Algolia", + "theme.SearchPage.algoliaLabel___DESCRIPTION": "The description label for Algolia mention", "theme.SearchPage.documentsFound.plurals": "One document found|{count} documents found", "theme.SearchPage.documentsFound.plurals___DESCRIPTION": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)", "theme.SearchPage.emptyResultsTitle": "Search the documentation", diff --git a/packages/docusaurus-theme-translations/locales/bg/theme-common.json b/packages/docusaurus-theme-translations/locales/bg/theme-common.json index 350fd3934c..7461d6ed26 100644 --- a/packages/docusaurus-theme-translations/locales/bg/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/bg/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Разширяване на категорията'{label}'", "theme.ErrorPageContent.title": "Тази страница се срина.", "theme.ErrorPageContent.tryAgain": "Опитайте отново", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Основен", "theme.NotFound.p1": "Не успяхме да намерим това, което търсите.", "theme.NotFound.p2": "Моля, свържете се със собственика на сайта, който ви е свързал с оригиналния URL адрес, и ги уведомете, че връзката им е повредена.", diff --git a/packages/docusaurus-theme-translations/locales/bg/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/bg/theme-search-algolia.json index 100008c134..7442a4697c 100644 --- a/packages/docusaurus-theme-translations/locales/bg/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/bg/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Търсене", "theme.SearchBar.seeAll": "Вижте всички {count} резултата", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Може да проверите вашата мрежова връзка.", "theme.SearchModal.errorScreen.titleText": "Не може да се извлекат резултати", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Клавиш Escape", "theme.SearchModal.footer.closeText": "за затваряне", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Стрелка надолу", @@ -11,25 +24,37 @@ "theme.SearchModal.footer.searchByText": "Търсене от", "theme.SearchModal.footer.selectKeyAriaLabel": "Клавиш Enter ", "theme.SearchModal.footer.selectText": "за избиране", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Няма резултати за", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Информирай ни.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Вярвате, че тази заявка трябва да върне резултати?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Опитайте да потърсите", "theme.SearchModal.placeholder": "Търсене в документацията", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Отказ", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Изчистване на заявката", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Любими", "theme.SearchModal.startScreen.noRecentSearchesText": "Няма скорошни търсения", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Скорошни", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Премахване на това търсене от любимите", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Премахване това търсене от историята", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Запазване това търсене", - "theme.SearchPage.algoliaLabel": "Търсене от Algolia", + "theme.SearchPage.algoliaLabel": "Задвижвано от Algolia", "theme.SearchPage.documentsFound.plurals": "Намерен е един документ|{count} намерени документи", "theme.SearchPage.emptyResultsTitle": "Потърсете в документацията", "theme.SearchPage.existingResultsTitle": "Резултати от търсенето за \"{query}\"", "theme.SearchPage.fetchingNewResults": "звличане на нови резултати...", "theme.SearchPage.inputLabel": "Търсене", - "theme.SearchPage.inputPlaceholder": "Въведете вашето търсене тук", - "theme.SearchPage.noResultsText": "Не бяха намерени резултати" + "theme.SearchPage.inputPlaceholder": "Въведете търсенето си тук", + "theme.SearchPage.noResultsText": "Няма намерени резултати" } diff --git a/packages/docusaurus-theme-translations/locales/bn/theme-common.json b/packages/docusaurus-theme-translations/locales/bn/theme-common.json index 918f8d243e..05b15f26d2 100644 --- a/packages/docusaurus-theme-translations/locales/bn/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/bn/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", "theme.ErrorPageContent.title": "This page crashed.", "theme.ErrorPageContent.tryAgain": "Try again", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Main", "theme.NotFound.p1": "আপনি যা খুঁজছিলেন তা আমরা খুঁজে পাইনি।", "theme.NotFound.p2": "দয়া করে সাইটের মালিকের সাথে যোগাযোগ করুন যা আপনাকে মূল URL এর সাথে যুক্ত করেছে এবং তাদের লিঙ্কটি ভাঙ্গা রয়েছে তা তাদের জানান।", diff --git a/packages/docusaurus-theme-translations/locales/bn/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/bn/theme-search-algolia.json index b6d157a5a5..0987b48e9d 100644 --- a/packages/docusaurus-theme-translations/locales/bn/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/bn/theme-search-algolia.json @@ -1,35 +1,60 @@ { - "theme.SearchBar.label": "সার্চ", - "theme.SearchBar.seeAll": "See all {count} results", - "theme.SearchModal.errorScreen.helpText": "You might want to check your network connection.", - "theme.SearchModal.errorScreen.titleText": "Unable to fetch results", - "theme.SearchModal.footer.closeKeyAriaLabel": "Escape key", - "theme.SearchModal.footer.closeText": "to close", - "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Arrow down", - "theme.SearchModal.footer.navigateText": "to navigate", - "theme.SearchModal.footer.navigateUpKeyAriaLabel": "Arrow up", - "theme.SearchModal.footer.searchByText": "Search by", - "theme.SearchModal.footer.selectKeyAriaLabel": "Enter key", - "theme.SearchModal.footer.selectText": "to select", - "theme.SearchModal.noResultsScreen.noResultsText": "No results for", - "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Let us know.", - "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Believe this query should return results?", - "theme.SearchModal.noResultsScreen.suggestedQueryText": "Try searching for", - "theme.SearchModal.placeholder": "Search docs", - "theme.SearchModal.searchBox.cancelButtonText": "Cancel", - "theme.SearchModal.searchBox.resetButtonTitle": "Clear the query", - "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favorite", - "theme.SearchModal.startScreen.noRecentSearchesText": "No recent searches", - "theme.SearchModal.startScreen.recentSearchesTitle": "Recent", - "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Remove this search from favorites", - "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Remove this search from history", - "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Save this search", - "theme.SearchPage.algoliaLabel": "আলগোলিয়া দ্বারা অনুসন্ধান করুন", - "theme.SearchPage.documentsFound.plurals": "একটি ডকুমেন্ট পাওয়া গেছে|{count} ডকুমেন্টস পাওয়া গেছে", - "theme.SearchPage.emptyResultsTitle": "ডকুমেন্টেশন অনুসন্ধান করুন", + "theme.SearchBar.label": "অনুসন্ধান", + "theme.SearchBar.seeAll": "সমস্ত {count}টি ফলাফল দেখুন", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", + "theme.SearchModal.errorScreen.helpText": "আপনি আপনার নেটওয়ার্ক সংযোগ পরীক্ষা করতে চাইতে পারেন।", + "theme.SearchModal.errorScreen.titleText": "ফলাফল আনতে অক্ষম", + "theme.SearchModal.footer.backToSearchText": "Back to search", + "theme.SearchModal.footer.closeKeyAriaLabel": "Escape কী", + "theme.SearchModal.footer.closeText": "বন্ধ করতে", + "theme.SearchModal.footer.navigateDownKeyAriaLabel": "তীর নিচে", + "theme.SearchModal.footer.navigateText": "নেভিগেট করতে", + "theme.SearchModal.footer.navigateUpKeyAriaLabel": "তীর উপরে", + "theme.SearchModal.footer.searchByText": "অনুসন্ধান দ্বারা", + "theme.SearchModal.footer.selectKeyAriaLabel": "Enter কী", + "theme.SearchModal.footer.selectText": "নির্বাচন করতে", + "theme.SearchModal.footer.submitQuestionText": "Submit question", + "theme.SearchModal.noResultsScreen.noResultsText": "কোনো ফলাফল পাওয়া যায়নি", + "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "আমাদের জানান।", + "theme.SearchModal.noResultsScreen.reportMissingResultsText": "বিশ্বাস করেন এই অনুসন্ধানে ফলাফল থাকা উচিত?", + "theme.SearchModal.noResultsScreen.suggestedQueryText": "অনুসন্ধান করার চেষ্টা করুন", + "theme.SearchModal.placeholder": "ডক্স অনুসন্ধান করুন", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", + "theme.SearchModal.searchBox.cancelButtonText": "বাতিল", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", + "theme.SearchModal.searchBox.resetButtonTitle": "অনুসন্ধান সাফ করুন", + "theme.SearchModal.searchBox.searchInputLabel": "Search", + "theme.SearchModal.startScreen.favoriteSearchesTitle": "প্রিয়", + "theme.SearchModal.startScreen.noRecentSearchesText": "কোনো সাম্প্রতিক অনুসন্ধান নেই", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", + "theme.SearchModal.startScreen.recentSearchesTitle": "সাম্প্রতিক", + "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "প্রিয় থেকে এই অনুসন্ধান সরান", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", + "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "ইতিহাস থেকে এই অনুসন্ধান সরান", + "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "এই অনুসন্ধান সংরক্ষণ করুন", + "theme.SearchPage.algoliaLabel": "Algolia দ্বারা অনুসন্ধান", + "theme.SearchPage.documentsFound.plurals": "{count}টি ডকুমেন্ট পাওয়া গেছে", + "theme.SearchPage.emptyResultsTitle": "ডকুমেন্টেশনে অনুসন্ধান করুন", "theme.SearchPage.existingResultsTitle": "\"{query}\" এর জন্য অনুসন্ধান ফলাফল", "theme.SearchPage.fetchingNewResults": "নতুন ফলাফল আনা হচ্ছে...", - "theme.SearchPage.inputLabel": "সার্চ", - "theme.SearchPage.inputPlaceholder": "আপনার অনুসন্ধান এখানে টাইপ করুন", - "theme.SearchPage.noResultsText": "কোন ফলাফল পাওয়া যায়নি" + "theme.SearchPage.inputLabel": "অনুসন্ধান", + "theme.SearchPage.inputPlaceholder": "এখানে আপনার অনুসন্ধান লিখুন", + "theme.SearchPage.noResultsText": "কোনো ফলাফল পাওয়া যায়নি" } diff --git a/packages/docusaurus-theme-translations/locales/cs/theme-common.json b/packages/docusaurus-theme-translations/locales/cs/theme-common.json index 809330a084..5af85f9b8b 100644 --- a/packages/docusaurus-theme-translations/locales/cs/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/cs/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", "theme.ErrorPageContent.title": "This page crashed.", "theme.ErrorPageContent.tryAgain": "Try again", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Main", "theme.NotFound.p1": "Nepodařilo se nám najít co jste hledal(a).", "theme.NotFound.p2": "Kontaktujte prosím vlastníka webu, který vás odkázal na původní URL a upozorněte ho, že jejich odkaz nefunguje.", diff --git a/packages/docusaurus-theme-translations/locales/cs/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/cs/theme-search-algolia.json index 8c8d092d01..ebcd44bf65 100644 --- a/packages/docusaurus-theme-translations/locales/cs/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/cs/theme-search-algolia.json @@ -1,35 +1,60 @@ { - "theme.SearchBar.label": "Hledat", - "theme.SearchBar.seeAll": "See all {count} results", - "theme.SearchModal.errorScreen.helpText": "You might want to check your network connection.", - "theme.SearchModal.errorScreen.titleText": "Unable to fetch results", - "theme.SearchModal.footer.closeKeyAriaLabel": "Escape key", - "theme.SearchModal.footer.closeText": "to close", - "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Arrow down", - "theme.SearchModal.footer.navigateText": "to navigate", - "theme.SearchModal.footer.navigateUpKeyAriaLabel": "Arrow up", - "theme.SearchModal.footer.searchByText": "Search by", - "theme.SearchModal.footer.selectKeyAriaLabel": "Enter key", - "theme.SearchModal.footer.selectText": "to select", - "theme.SearchModal.noResultsScreen.noResultsText": "No results for", - "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Let us know.", - "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Believe this query should return results?", - "theme.SearchModal.noResultsScreen.suggestedQueryText": "Try searching for", - "theme.SearchModal.placeholder": "Search docs", - "theme.SearchModal.searchBox.cancelButtonText": "Cancel", - "theme.SearchModal.searchBox.resetButtonTitle": "Clear the query", - "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favorite", - "theme.SearchModal.startScreen.noRecentSearchesText": "No recent searches", - "theme.SearchModal.startScreen.recentSearchesTitle": "Recent", - "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Remove this search from favorites", - "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Remove this search from history", - "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Save this search", - "theme.SearchPage.algoliaLabel": "Vyhledávání od Algolia", - "theme.SearchPage.documentsFound.plurals": "Jeden dokument nalezen|{count} dokumenty nalezeny|{count} dokumentů nalezeno", + "theme.SearchBar.label": "Vyhledávání", + "theme.SearchBar.seeAll": "Zobrazit všech {count} výsledků", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", + "theme.SearchModal.errorScreen.helpText": "Možná byste měli zkontrolovat připojení k síti.", + "theme.SearchModal.errorScreen.titleText": "Nelze načíst výsledky", + "theme.SearchModal.footer.backToSearchText": "Back to search", + "theme.SearchModal.footer.closeKeyAriaLabel": "Klávesa Escape", + "theme.SearchModal.footer.closeText": "zavřít", + "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Šipka dolů", + "theme.SearchModal.footer.navigateText": "navigovat", + "theme.SearchModal.footer.navigateUpKeyAriaLabel": "Šipka nahoru", + "theme.SearchModal.footer.searchByText": "Vyhledávání pomocí", + "theme.SearchModal.footer.selectKeyAriaLabel": "Klávesa Enter", + "theme.SearchModal.footer.selectText": "vybrat", + "theme.SearchModal.footer.submitQuestionText": "Submit question", + "theme.SearchModal.noResultsScreen.noResultsText": "Žádné výsledky pro", + "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Dejte nám vědět.", + "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Věříte, že tento dotaz by měl vrátit výsledky?", + "theme.SearchModal.noResultsScreen.suggestedQueryText": "Zkuste vyhledat", + "theme.SearchModal.placeholder": "Prohledat dokumentaci", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", + "theme.SearchModal.searchBox.cancelButtonText": "Zrušit", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", + "theme.SearchModal.searchBox.resetButtonTitle": "Vymazat dotaz", + "theme.SearchModal.searchBox.searchInputLabel": "Search", + "theme.SearchModal.startScreen.favoriteSearchesTitle": "Oblíbené", + "theme.SearchModal.startScreen.noRecentSearchesText": "Žádná nedávná vyhledávání", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", + "theme.SearchModal.startScreen.recentSearchesTitle": "Nedávné", + "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Odebrat toto vyhledávání z oblíbených", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", + "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Odebrat toto vyhledávání z historie", + "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Uložit toto vyhledávání", + "theme.SearchPage.algoliaLabel": "Vyhledávání pomocí Algolia", + "theme.SearchPage.documentsFound.plurals": "Nalezen {count} dokument", "theme.SearchPage.emptyResultsTitle": "Prohledat dokumentaci", "theme.SearchPage.existingResultsTitle": "Výsledky vyhledávání pro \"{query}\"", - "theme.SearchPage.fetchingNewResults": "Stahuji nové výsledky...", - "theme.SearchPage.inputLabel": "Hledat", - "theme.SearchPage.inputPlaceholder": "Zde napište hledaný text", - "theme.SearchPage.noResultsText": "Nic nebylo nalezeno" + "theme.SearchPage.fetchingNewResults": "Načítání nových výsledků...", + "theme.SearchPage.inputLabel": "Vyhledávání", + "theme.SearchPage.inputPlaceholder": "Zadejte hledaný text", + "theme.SearchPage.noResultsText": "Žádné výsledky nenalezeny" } diff --git a/packages/docusaurus-theme-translations/locales/da/theme-common.json b/packages/docusaurus-theme-translations/locales/da/theme-common.json index 29901fd78b..5ccc178a5f 100644 --- a/packages/docusaurus-theme-translations/locales/da/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/da/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", "theme.ErrorPageContent.title": "This page crashed.", "theme.ErrorPageContent.tryAgain": "Try again", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Main", "theme.NotFound.p1": "Vi kunne ikke finde det, du søgte.", "theme.NotFound.p2": "Venligst kontakt ejeren til webstedet, som førte dig frem denne URL, og informer dem om at linket ikke virker.", diff --git a/packages/docusaurus-theme-translations/locales/da/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/da/theme-search-algolia.json index be4f094384..b04cf00c56 100644 --- a/packages/docusaurus-theme-translations/locales/da/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/da/theme-search-algolia.json @@ -1,30 +1,55 @@ { "theme.SearchBar.label": "Søg", "theme.SearchBar.seeAll": "See all {count} results", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "You might want to check your network connection.", "theme.SearchModal.errorScreen.titleText": "Unable to fetch results", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape key", "theme.SearchModal.footer.closeText": "to close", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Arrow down", "theme.SearchModal.footer.navigateText": "to navigate", "theme.SearchModal.footer.navigateUpKeyAriaLabel": "Arrow up", - "theme.SearchModal.footer.searchByText": "Search by", + "theme.SearchModal.footer.searchByText": "Powered by", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter key", "theme.SearchModal.footer.selectText": "to select", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "No results for", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Let us know.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Believe this query should return results?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Try searching for", "theme.SearchModal.placeholder": "Search docs", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Cancel", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Clear the query", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favorite", "theme.SearchModal.startScreen.noRecentSearchesText": "No recent searches", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Recent", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Remove this search from favorites", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Remove this search from history", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Save this search", - "theme.SearchPage.algoliaLabel": "Søg med Algolia", + "theme.SearchPage.algoliaLabel": "Drevet af Algolia", "theme.SearchPage.documentsFound.plurals": "Et dokument fundet|{count} dokumenter fundet", "theme.SearchPage.emptyResultsTitle": "Søg i dokumentationen", "theme.SearchPage.existingResultsTitle": "Søgeresultater for \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/de/theme-common.json b/packages/docusaurus-theme-translations/locales/de/theme-common.json index a4b6cd2290..b0fce33736 100644 --- a/packages/docusaurus-theme-translations/locales/de/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/de/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", "theme.ErrorPageContent.title": "Die Seite ist abgestürzt.", "theme.ErrorPageContent.tryAgain": "Nochmal versuchen", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Main", "theme.NotFound.p1": "Wir konnten nicht finden, wonach Sie gesucht haben.", "theme.NotFound.p2": "Bitte kontaktieren Sie den Besitzer der Seite, die Sie mit der ursprünglichen URL verlinkt hat, und teilen Sie ihm mit, dass der Link nicht mehr funktioniert.", diff --git a/packages/docusaurus-theme-translations/locales/de/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/de/theme-search-algolia.json index 5aa48122ad..b9e69701c5 100644 --- a/packages/docusaurus-theme-translations/locales/de/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/de/theme-search-algolia.json @@ -1,30 +1,55 @@ { "theme.SearchBar.label": "Suche", "theme.SearchBar.seeAll": "Alle {count} Ergebnisse anzeigen", + "theme.SearchModal.askAiScreen.afterToolCallText": "Gesucht nach ", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Kopiert!", + "theme.SearchModal.askAiScreen.copyButtonText": "Kopieren", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Kopieren", + "theme.SearchModal.askAiScreen.disclaimerText": "Antworten werden von KI generiert und können Fehler enthalten. Bitte überprüfen Sie die Antworten.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Gefällt mir nicht", + "theme.SearchModal.askAiScreen.duringToolCallText": "Suche nach ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Gefällt mir", + "theme.SearchModal.askAiScreen.preToolCallText": "Suche...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Verwandte Quellen", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Danke für Ihr Feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Denkt nach...", "theme.SearchModal.errorScreen.helpText": "You might want to check your network connection.", "theme.SearchModal.errorScreen.titleText": "Unable to fetch results", + "theme.SearchModal.footer.backToSearchText": "Zurück zur Suche", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape key", "theme.SearchModal.footer.closeText": "to close", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Arrow down", "theme.SearchModal.footer.navigateText": "to navigate", "theme.SearchModal.footer.navigateUpKeyAriaLabel": "Arrow up", - "theme.SearchModal.footer.searchByText": "Search by", + "theme.SearchModal.footer.searchByText": "Powered by", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter key", "theme.SearchModal.footer.selectText": "to select", + "theme.SearchModal.footer.submitQuestionText": "Frage absenden", "theme.SearchModal.noResultsScreen.noResultsText": "No results for", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Let us know.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Believe this query should return results?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Try searching for", "theme.SearchModal.placeholder": "Search docs", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "KI fragen: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Zurück zur Stichwortsuche", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Zurück zur Stichwortsuche", "theme.SearchModal.searchBox.cancelButtonText": "Cancel", + "theme.SearchModal.searchBox.enterKeyHint": "suchen", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "eingeben", + "theme.SearchModal.searchBox.placeholderText": "Dokumentation durchsuchen", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Weitere Frage stellen...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Antwortet...", "theme.SearchModal.searchBox.resetButtonTitle": "Clear the query", + "theme.SearchModal.searchBox.searchInputLabel": "Suchen", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favorite", "theme.SearchModal.startScreen.noRecentSearchesText": "No recent searches", + "theme.SearchModal.startScreen.recentConversationsTitle": "Letzte Gespräche", "theme.SearchModal.startScreen.recentSearchesTitle": "Recent", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Remove this search from favorites", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Dieses Gespräch aus dem Verlauf entfernen", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Remove this search from history", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Save this search", - "theme.SearchPage.algoliaLabel": "Suche von Algolia", + "theme.SearchPage.algoliaLabel": "Unterstützt von Algolia", "theme.SearchPage.documentsFound.plurals": "Ein Dokument gefunden|{count} Dokumente gefunden", "theme.SearchPage.emptyResultsTitle": "Suche in der Dokumentation", "theme.SearchPage.existingResultsTitle": "Suchergebnisse für \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/es/theme-common.json b/packages/docusaurus-theme-translations/locales/es/theme-common.json index a9c0f5be49..bfaa6b906a 100644 --- a/packages/docusaurus-theme-translations/locales/es/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/es/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Ampliar la categoría '{label}' de la barra lateral", "theme.ErrorPageContent.title": "Esta página ha fallado.", "theme.ErrorPageContent.tryAgain": "Intente de nuevo", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Principal", "theme.NotFound.p1": "No pudimos encontrar lo que buscaba.", "theme.NotFound.p2": "Comuníquese con el dueño del sitio que le proporcionó la URL original y hágale saber que su vínculo está roto.", diff --git a/packages/docusaurus-theme-translations/locales/es/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/es/theme-search-algolia.json index 987ba4194c..159dd5d749 100644 --- a/packages/docusaurus-theme-translations/locales/es/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/es/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Buscar", "theme.SearchBar.seeAll": "Ver todos los {count} resultados", + "theme.SearchModal.askAiScreen.afterToolCallText": "Se buscó ", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "¡Copiado!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copiar", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copiar", + "theme.SearchModal.askAiScreen.disclaimerText": "Las respuestas son generadas por IA y pueden contener errores. Verifique las respuestas.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "No me gusta", + "theme.SearchModal.askAiScreen.duringToolCallText": "Buscando ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Me gusta", + "theme.SearchModal.askAiScreen.preToolCallText": "Buscando...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Fuentes relacionadas", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "¡Gracias por tu opinión!", + "theme.SearchModal.askAiScreen.thinkingText": "Pensando...", "theme.SearchModal.errorScreen.helpText": "Quizás quieras comprobar tu conexión de red.", "theme.SearchModal.errorScreen.titleText": "No se pueden obtener resultados", + "theme.SearchModal.footer.backToSearchText": "Volver a la búsqueda", "theme.SearchModal.footer.closeKeyAriaLabel": "tecla Escape", "theme.SearchModal.footer.closeText": "cerrar", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Flecha abajo", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "Buscar por", "theme.SearchModal.footer.selectKeyAriaLabel": "tecla Enter", "theme.SearchModal.footer.selectText": "seleccionar", + "theme.SearchModal.footer.submitQuestionText": "Enviar pregunta", "theme.SearchModal.noResultsScreen.noResultsText": "Sin resultados para", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Háganos saber.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Crees que esta consulta debería devolver resultados?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Intenta buscando por", "theme.SearchModal.placeholder": "Buscar documentos", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Preguntar a la IA: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Volver a búsqueda por palabras clave", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Volver a búsqueda por palabras clave", "theme.SearchModal.searchBox.cancelButtonText": "Cancelar", + "theme.SearchModal.searchBox.enterKeyHint": "buscar", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enviar", + "theme.SearchModal.searchBox.placeholderText": "Buscar documentos", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Hacer otra pregunta...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Respondiendo...", "theme.SearchModal.searchBox.resetButtonTitle": "Limpiar la búsqueda", + "theme.SearchModal.searchBox.searchInputLabel": "Buscar", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favorito", "theme.SearchModal.startScreen.noRecentSearchesText": "Sin búsquedas recientes", + "theme.SearchModal.startScreen.recentConversationsTitle": "Conversaciones recientes", "theme.SearchModal.startScreen.recentSearchesTitle": "Reciente", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Eliminar esta búsqueda de favoritos", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Eliminar esta conversación del historial", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Eliminar esta búsqueda del historial", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Guardar esta búsqueda", - "theme.SearchPage.algoliaLabel": "Búsqueda por Algolia", + "theme.SearchPage.algoliaLabel": "Con tecnología de Algolia", "theme.SearchPage.documentsFound.plurals": "Un documento encontrado|{count} documentos encontrados", "theme.SearchPage.emptyResultsTitle": "Búsqueda en la documentación", "theme.SearchPage.existingResultsTitle": "Resultados de búsqueda para \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/et/theme-common.json b/packages/docusaurus-theme-translations/locales/et/theme-common.json index adce580ff8..89e1055b67 100644 --- a/packages/docusaurus-theme-translations/locales/et/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/et/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Ava külgrea kategooria '{label}'", "theme.ErrorPageContent.title": "See leht jooksis kokku.", "theme.ErrorPageContent.tryAgain": "Proovi uuesti", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Peamine", "theme.NotFound.p1": "Vabandame, kuid lehte ei leitud.", "theme.NotFound.p2": "Kui arvad, et see on viga, palun võta meiega ühendust.", diff --git a/packages/docusaurus-theme-translations/locales/et/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/et/theme-search-algolia.json index 2d63010512..87f07ec7e2 100644 --- a/packages/docusaurus-theme-translations/locales/et/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/et/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Otsi", "theme.SearchBar.seeAll": "Vaata kõiki {count} tulemust", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Kontrolli interneti ühendust.", "theme.SearchModal.errorScreen.titleText": "Tulemuste pärimine ebaõnnestus", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Paoklahvi nuppu", "theme.SearchModal.footer.closeText": "sulgemiseks", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Alla noolt", @@ -11,25 +24,37 @@ "theme.SearchModal.footer.searchByText": "Otsi", "theme.SearchModal.footer.selectKeyAriaLabel": "Sisestusklahvi nuppu", "theme.SearchModal.footer.selectText": "valimiseks", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Tulemused puuduvad päringule", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Anna meile teada.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Usud, et see päring peaks tulemuse andma?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Proovi otsida", "theme.SearchModal.placeholder": "Otsi dokumente", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Tühista", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Puhasta päring", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Lemmik", "theme.SearchModal.startScreen.noRecentSearchesText": "Hiljutised otsingud puuduvad", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Hiljutised", - "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Kustuta see päring lemmikute seast", - "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Kustuta see päring ajaloost", - "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Salvesta see päring", - "theme.SearchPage.algoliaLabel": "Algolia otsing", - "theme.SearchPage.documentsFound.plurals": "Üks dokument leitud|{count} dokumenti leitud", - "theme.SearchPage.emptyResultsTitle": "Otsi dokumentatsioonist", - "theme.SearchPage.existingResultsTitle": "Otsi tulemust päringule \"{query}\"", - "theme.SearchPage.fetchingNewResults": "Pärib uusi tulemusi...", - "theme.SearchPage.inputLabel": "Otsi", - "theme.SearchPage.inputPlaceholder": "Kirjuta oma päring siia", + "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Eemalda see otsing lemmikutest", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", + "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Eemalda see otsing ajaloost", + "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Salvesta see otsing", + "theme.SearchPage.algoliaLabel": "Otsingu võimaldab Algolia", + "theme.SearchPage.documentsFound.plurals": "Leitud {count} dokument", + "theme.SearchPage.emptyResultsTitle": "Otsi dokumentatsioonis", + "theme.SearchPage.existingResultsTitle": "Otsingutulemused päringule \"{query}\"", + "theme.SearchPage.fetchingNewResults": "Uute tulemuste laadimine...", + "theme.SearchPage.inputLabel": "Otsing", + "theme.SearchPage.inputPlaceholder": "Sisesta oma otsing siia", "theme.SearchPage.noResultsText": "Tulemusi ei leitud" } diff --git a/packages/docusaurus-theme-translations/locales/fa/theme-common.json b/packages/docusaurus-theme-translations/locales/fa/theme-common.json index 5166cc78e2..b4153a4832 100644 --- a/packages/docusaurus-theme-translations/locales/fa/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/fa/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "باز کردن دسته بندی در نوار کناری '{label}'", "theme.ErrorPageContent.title": "بارگذاری صفحه با خطا روبرو شد.", "theme.ErrorPageContent.tryAgain": "تلاش مجدد", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "صفحه اصلی", "theme.NotFound.p1": "صفحه‌ای که دنبال آن بودید پیدا نشد.", "theme.NotFound.p2": "لطفا با صاحب وبسایت تماس بگیرید و ایشان را از مشکل پیش آمده مطلع کنید.", diff --git a/packages/docusaurus-theme-translations/locales/fa/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/fa/theme-search-algolia.json index e9108bc9da..4b237da096 100644 --- a/packages/docusaurus-theme-translations/locales/fa/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/fa/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "جستجو", "theme.SearchBar.seeAll": "نمایش {count} نتیجه", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "لطفا اتصال شبکه خود را بررسی کنید.", "theme.SearchModal.errorScreen.titleText": "دریافت نتایج ممکن نیست", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "کلید Escape", "theme.SearchModal.footer.closeText": "بستن", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "کلید پایین", @@ -11,25 +24,37 @@ "theme.SearchModal.footer.searchByText": "جستجو برای", "theme.SearchModal.footer.selectKeyAriaLabel": "کلید اینتر", "theme.SearchModal.footer.selectText": "انتخاب", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "هیچ نتیجه ای برای", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "با ما در میان بگذارید.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "آیا اطمینان دارید این جستجو باید نتیجه ای داشته باشد؟", "theme.SearchModal.noResultsScreen.suggestedQueryText": "جستجو پیشنهادی برای", "theme.SearchModal.placeholder": "جستجوی مستندات", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "کنسل", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "پاک کردن جستجو", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "برگزیده", "theme.SearchModal.startScreen.noRecentSearchesText": "جستجوی اخیر مشاهده نشد", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "اخیرا", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "این جستجو از برگزیده ها پاک شود", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "این جستجو از تاریخچه پاک شود", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "ذخیره این جستجو", - "theme.SearchPage.algoliaLabel": "جستجو با Algolia", + "theme.SearchPage.algoliaLabel": "قدرت گرفته از Algolia", "theme.SearchPage.documentsFound.plurals": "یک مورد پیدا شد|{count} مورد پیدا شد", "theme.SearchPage.emptyResultsTitle": "جستجو در متن", "theme.SearchPage.existingResultsTitle": "جستجو برای عبارت \"{query}\"", "theme.SearchPage.fetchingNewResults": "در حال دریافت نتایج...", "theme.SearchPage.inputLabel": "جستجو", - "theme.SearchPage.inputPlaceholder": "عبارت مورد نظر را اینجا بنویسید", - "theme.SearchPage.noResultsText": "هیچ نتیجه ای پیدا نشد" + "theme.SearchPage.inputPlaceholder": "جستجوی خود را اینجا تایپ کنید", + "theme.SearchPage.noResultsText": "هیچ نتیجه‌ای پیدا نشد" } diff --git a/packages/docusaurus-theme-translations/locales/fil/theme-common.json b/packages/docusaurus-theme-translations/locales/fil/theme-common.json index 27de696ad9..04d89a095c 100644 --- a/packages/docusaurus-theme-translations/locales/fil/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/fil/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", "theme.ErrorPageContent.title": "This page crashed.", "theme.ErrorPageContent.tryAgain": "Try again", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Main", "theme.NotFound.p1": "Hindi namin mahanap ang iyong hinananap.", "theme.NotFound.p2": "Mangyaring makipag-ugnayan sa may-ari ng site na nag-link sa iyo sa orihinal na URL at sabihin sa kanila na ang kanilang link ay putol.", diff --git a/packages/docusaurus-theme-translations/locales/fil/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/fil/theme-search-algolia.json index d17d797ded..ec81fd9efe 100644 --- a/packages/docusaurus-theme-translations/locales/fil/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/fil/theme-search-algolia.json @@ -1,35 +1,60 @@ { "theme.SearchBar.label": "Maghanap", "theme.SearchBar.seeAll": "See all {count} results", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "You might want to check your network connection.", "theme.SearchModal.errorScreen.titleText": "Unable to fetch results", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape key", "theme.SearchModal.footer.closeText": "to close", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Arrow down", "theme.SearchModal.footer.navigateText": "to navigate", "theme.SearchModal.footer.navigateUpKeyAriaLabel": "Arrow up", - "theme.SearchModal.footer.searchByText": "Search by", + "theme.SearchModal.footer.searchByText": "Powered by", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter key", "theme.SearchModal.footer.selectText": "to select", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "No results for", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Let us know.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Believe this query should return results?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Try searching for", "theme.SearchModal.placeholder": "Search docs", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Cancel", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Clear the query", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favorite", "theme.SearchModal.startScreen.noRecentSearchesText": "No recent searches", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Recent", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Remove this search from favorites", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Remove this search from history", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Save this search", - "theme.SearchPage.algoliaLabel": "Paghahanap hatid ng Algolia", + "theme.SearchPage.algoliaLabel": "Pinapagana ng Algolia", "theme.SearchPage.documentsFound.plurals": "Isang dokumento ang nahanap|{count} na mga dokumento ang nahanap", "theme.SearchPage.emptyResultsTitle": "Maghanap sa dokumentasyón", "theme.SearchPage.existingResultsTitle": "Resulta ng paghahanap para sa \"{query}\"", "theme.SearchPage.fetchingNewResults": "Kumukuha ng mga bagong resulta...", "theme.SearchPage.inputLabel": "Maghanap", - "theme.SearchPage.inputPlaceholder": "I-type and inyong hinahanap dito", - "theme.SearchPage.noResultsText": "Walang resultang nahanap" + "theme.SearchPage.inputPlaceholder": "I-type ang inyong paghahanap dito", + "theme.SearchPage.noResultsText": "Walang nahanap na resulta" } diff --git a/packages/docusaurus-theme-translations/locales/fr/theme-common.json b/packages/docusaurus-theme-translations/locales/fr/theme-common.json index 598928765c..36037b5bff 100644 --- a/packages/docusaurus-theme-translations/locales/fr/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/fr/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Développer la catégorie '{label}' de la barre latérale", "theme.ErrorPageContent.title": "Cette page a planté.", "theme.ErrorPageContent.tryAgain": "Réessayer", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Main", "theme.NotFound.p1": "Nous n'avons pas trouvé ce que vous recherchez.", "theme.NotFound.p2": "Veuillez contacter le propriétaire du site qui vous a lié à l'URL d'origine et leur faire savoir que leur lien est cassé.", diff --git a/packages/docusaurus-theme-translations/locales/fr/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/fr/theme-search-algolia.json index be970d1af6..2eda7f3db5 100644 --- a/packages/docusaurus-theme-translations/locales/fr/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/fr/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Chercher", "theme.SearchBar.seeAll": "Voir les {count} résultats", + "theme.SearchModal.askAiScreen.afterToolCallText": "Recherche effectuée pour ", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copié !", + "theme.SearchModal.askAiScreen.copyButtonText": "Copier", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copier", + "theme.SearchModal.askAiScreen.disclaimerText": "Les réponses sont générées par l'IA et peuvent contenir des erreurs. Veuillez vérifier les réponses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Je n'aime pas", + "theme.SearchModal.askAiScreen.duringToolCallText": "Recherche de ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "J'aime", + "theme.SearchModal.askAiScreen.preToolCallText": "Recherche en cours...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Sources connexes", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Merci pour votre retour !", + "theme.SearchModal.askAiScreen.thinkingText": "Réflexion en cours...", "theme.SearchModal.errorScreen.helpText": "Vous pouvez vérifier votre connexion réseau.", "theme.SearchModal.errorScreen.titleText": "Impossible de récupérer les résultats", + "theme.SearchModal.footer.backToSearchText": "Retour à la recherche", "theme.SearchModal.footer.closeKeyAriaLabel": "Touche Echap", "theme.SearchModal.footer.closeText": "fermer", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Flèche vers le bas", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "Recherche via", "theme.SearchModal.footer.selectKeyAriaLabel": "Touche Entrée", "theme.SearchModal.footer.selectText": "sélectionner", + "theme.SearchModal.footer.submitQuestionText": "Soumettre la question", "theme.SearchModal.noResultsScreen.noResultsText": "Aucun résultat pour", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Faites-le nous savoir.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Vous pensez que cette requête doit donner des résultats ?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Essayez de chercher", "theme.SearchModal.placeholder": "Rechercher des docs", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Demander à l'IA : ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Retour à la recherche par mots-clés", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Retour à la recherche par mots-clés", "theme.SearchModal.searchBox.cancelButtonText": "Annuler", + "theme.SearchModal.searchBox.enterKeyHint": "rechercher", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "entrée", + "theme.SearchModal.searchBox.placeholderText": "Rechercher des docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Poser une autre question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "En train de répondre...", "theme.SearchModal.searchBox.resetButtonTitle": "Effacer la requête", + "theme.SearchModal.searchBox.searchInputLabel": "Rechercher", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favoris", "theme.SearchModal.startScreen.noRecentSearchesText": "Aucune recherche récente", + "theme.SearchModal.startScreen.recentConversationsTitle": "Conversations récentes", "theme.SearchModal.startScreen.recentSearchesTitle": "Récemment", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Supprimer cette recherche des favoris", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Supprimer cette conversation de l'historique", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Supprimer cette recherche de l'historique", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Sauvegarder cette recherche", - "theme.SearchPage.algoliaLabel": "Recherche par Algolia", + "theme.SearchPage.algoliaLabel": "Fourni par Algolia", "theme.SearchPage.documentsFound.plurals": "Un document trouvé|{count} documents trouvés", "theme.SearchPage.emptyResultsTitle": "Rechercher dans la documentation", "theme.SearchPage.existingResultsTitle": "Résultats de recherche pour « {query} »", diff --git a/packages/docusaurus-theme-translations/locales/he/theme-common.json b/packages/docusaurus-theme-translations/locales/he/theme-common.json index 87e0593b8b..5e4806e8c3 100644 --- a/packages/docusaurus-theme-translations/locales/he/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/he/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", "theme.ErrorPageContent.title": "This page crashed.", "theme.ErrorPageContent.tryAgain": "Try again", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Main", "theme.NotFound.p1": "אנחנו לא מוצאים את מה שאתה מנסה לחפש.", "theme.NotFound.p2": "הקישור אינו תקין, אנא פנה למנהל האתר ממנו קיבלת קישור זה.", diff --git a/packages/docusaurus-theme-translations/locales/he/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/he/theme-search-algolia.json index 75f2ca642c..43d6a07b78 100644 --- a/packages/docusaurus-theme-translations/locales/he/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/he/theme-search-algolia.json @@ -1,35 +1,60 @@ { "theme.SearchBar.label": "חיפוש", "theme.SearchBar.seeAll": "See all {count} results", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "You might want to check your network connection.", "theme.SearchModal.errorScreen.titleText": "Unable to fetch results", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape key", "theme.SearchModal.footer.closeText": "to close", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Arrow down", "theme.SearchModal.footer.navigateText": "to navigate", "theme.SearchModal.footer.navigateUpKeyAriaLabel": "Arrow up", - "theme.SearchModal.footer.searchByText": "Search by", + "theme.SearchModal.footer.searchByText": "Powered by", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter key", "theme.SearchModal.footer.selectText": "to select", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "No results for", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Let us know.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Believe this query should return results?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Try searching for", "theme.SearchModal.placeholder": "Search docs", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Cancel", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Clear the query", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favorite", "theme.SearchModal.startScreen.noRecentSearchesText": "No recent searches", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Recent", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Remove this search from favorites", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Remove this search from history", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Save this search", - "theme.SearchPage.algoliaLabel": "חיפוש by Algolia", + "theme.SearchPage.algoliaLabel": "מופעל על ידי Algolia", "theme.SearchPage.documentsFound.plurals": "נמצא מסמך אחד|{count} מסמכים נמצאו|{count} מסמכים נמצאו|{count} מסמכים נמצאו", "theme.SearchPage.emptyResultsTitle": "חפש בדוקומנטאציה", "theme.SearchPage.existingResultsTitle": "תוצאות חיפוש עבור \"{query}\"", "theme.SearchPage.fetchingNewResults": "טוען תוצאות חיפוש חדשות...", "theme.SearchPage.inputLabel": "חיפוש", - "theme.SearchPage.inputPlaceholder": "הקלד כאן לחיפוש", + "theme.SearchPage.inputPlaceholder": "הקלד את החיפוש שלך כאן", "theme.SearchPage.noResultsText": "לא נמצאו תוצאות" } diff --git a/packages/docusaurus-theme-translations/locales/hi/theme-common.json b/packages/docusaurus-theme-translations/locales/hi/theme-common.json index 5f5a4f5d35..8fe459cf0d 100644 --- a/packages/docusaurus-theme-translations/locales/hi/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/hi/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", "theme.ErrorPageContent.title": "This page crashed.", "theme.ErrorPageContent.tryAgain": "Try again", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Main", "theme.NotFound.p1": "हमें वह नहीं मिला, जिसकी आपको तलाश थी।", "theme.NotFound.p2": "कृपया उस साइट के मालिक से संपर्क करें जिसने आपको मूल URL से जोड़ा है और उन्हें बताएं कि उनका लिंक टूट गया है।", diff --git a/packages/docusaurus-theme-translations/locales/hi/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/hi/theme-search-algolia.json index f718a2fac5..46f24d198e 100644 --- a/packages/docusaurus-theme-translations/locales/hi/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/hi/theme-search-algolia.json @@ -1,35 +1,60 @@ { "theme.SearchBar.label": "खोज करें", "theme.SearchBar.seeAll": "See all {count} results", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "You might want to check your network connection.", "theme.SearchModal.errorScreen.titleText": "Unable to fetch results", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape key", "theme.SearchModal.footer.closeText": "to close", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Arrow down", "theme.SearchModal.footer.navigateText": "to navigate", "theme.SearchModal.footer.navigateUpKeyAriaLabel": "Arrow up", - "theme.SearchModal.footer.searchByText": "Search by", + "theme.SearchModal.footer.searchByText": "Powered by", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter key", "theme.SearchModal.footer.selectText": "to select", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "No results for", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Let us know.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Believe this query should return results?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Try searching for", "theme.SearchModal.placeholder": "Search docs", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Cancel", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Clear the query", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favorite", "theme.SearchModal.startScreen.noRecentSearchesText": "No recent searches", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Recent", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Remove this search from favorites", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Remove this search from history", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Save this search", - "theme.SearchPage.algoliaLabel": "अल्गोलिया द्वारा खोजें", + "theme.SearchPage.algoliaLabel": "Algolia द्वारा संचालित", "theme.SearchPage.documentsFound.plurals": "एक डॉक्यूमेंट मिला|{count} डॉक्यूमेंट मिलें", "theme.SearchPage.emptyResultsTitle": "डॉक्यूमेंटेशन में खोजें", "theme.SearchPage.existingResultsTitle": "\"{query}\" के लिए खोज परिणाम", - "theme.SearchPage.fetchingNewResults": "नए परिणाम प्राप्त कियें जा रहे हैं...", - "theme.SearchPage.inputLabel": "खोज करें", - "theme.SearchPage.inputPlaceholder": "अपनी खोज यहाँ टाइप करें", - "theme.SearchPage.noResultsText": "कोई परिणाम नहीं मिलें" + "theme.SearchPage.fetchingNewResults": "नए परिणाम प्राप्त कर रहे हैं...", + "theme.SearchPage.inputLabel": "खोजें", + "theme.SearchPage.inputPlaceholder": "यहाँ अपनी खोज टाइप करें", + "theme.SearchPage.noResultsText": "कोई परिणाम नहीं मिला" } diff --git a/packages/docusaurus-theme-translations/locales/hu/theme-common.json b/packages/docusaurus-theme-translations/locales/hu/theme-common.json index b01e4922d3..7d9514ea99 100644 --- a/packages/docusaurus-theme-translations/locales/hu/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/hu/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "A(z) '{label}' nevű oldalsáv kategória kinyitása", "theme.ErrorPageContent.title": "Hiba történt a oldalon.", "theme.ErrorPageContent.tryAgain": "Próbáld újra", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Fő", "theme.NotFound.p1": "Sajnos nem találtuk azt az oldalt, amit kerestél.", "theme.NotFound.p2": "Kérjük, lépj kapcsolatba az oldal tulajdonosával, ahonnan erre a hivatkozásra léptél, hogy jelezd, hogy a hivatkozás nem működik.", diff --git a/packages/docusaurus-theme-translations/locales/hu/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/hu/theme-search-algolia.json index 0bf7ebca24..ef048a6bb1 100644 --- a/packages/docusaurus-theme-translations/locales/hu/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/hu/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Keresés", "theme.SearchBar.seeAll": "Összes eredmény megtekintése ({count})", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Ellenőrizze a hálózati kapcsolatot.", "theme.SearchModal.errorScreen.titleText": "Nem sikerült az eredményeket lekérni", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape billentyű", "theme.SearchModal.footer.closeText": "bezárás", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Lefelé nyíl", @@ -11,26 +24,37 @@ "theme.SearchModal.footer.searchByText": "Motor:", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter billentyű", "theme.SearchModal.footer.selectText": "kiválasztás", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Nincs eredmény", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Adja meg nekünk.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Úgy gondolja, hogy ez a keresés eredményt kellene adnia?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Próbálja meg keresni", "theme.SearchModal.placeholder": "Dokumentumok keresése", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Mégse", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Keresési kérés törlése", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Kedvencek", "theme.SearchModal.startScreen.noRecentSearchesText": "Nincsenek legutóbbi keresések", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Legutóbbi", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Törölje ezt a keresést a kedvencekből", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Törölje ezt a keresést az előzményekből", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Mentsük el ezt a keresést", - "theme.SearchPage.algoliaLabel": "Keresés az Algolia segítségével", + "theme.SearchPage.algoliaLabel": "Az Algolia támogatásával", "theme.SearchPage.documentsFound.plurals": "Egy dokumentum|{count} dokumentumok", "theme.SearchPage.emptyResultsTitle": "Keresés a webhelyen", "theme.SearchPage.existingResultsTitle": "\"{query}\" keresési eredményei", "theme.SearchPage.fetchingNewResults": "Új keresési eredmények betöltése...", "theme.SearchPage.inputLabel": "Keresés", - "theme.SearchPage.inputPlaceholder": "Adja meg a keresendő kifejezést", - "theme.SearchPage.noResultsText": "Nincs találat a keresésre", - "theme.SearchPage.saveRecentSearchButtonTitle": "Mentse ezt a keresést" + "theme.SearchPage.inputPlaceholder": "Írja be a keresését ide", + "theme.SearchPage.noResultsText": "Nem található eredmény" } diff --git a/packages/docusaurus-theme-translations/locales/id/theme-common.json b/packages/docusaurus-theme-translations/locales/id/theme-common.json index 454e94db88..b228dcc5b6 100644 --- a/packages/docusaurus-theme-translations/locales/id/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/id/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Perluas kategori bilah sisi '{label}'", "theme.ErrorPageContent.title": "Terjadi kesalahan.", "theme.ErrorPageContent.tryAgain": "Coba kembali", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Utama", "theme.NotFound.p1": "Kami tak dapat menemukan yang anda cari.", "theme.NotFound.p2": "Silakan hubungi pemilik situs yang mengarahkan anda ke URL asli dan beri tahu mereka bahwa tautan mereka salah.", diff --git a/packages/docusaurus-theme-translations/locales/id/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/id/theme-search-algolia.json index b294959d00..cbd7c6955c 100644 --- a/packages/docusaurus-theme-translations/locales/id/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/id/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Cari", "theme.SearchBar.seeAll": "Lihat semua {count} hasilnya", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Barangkali anda perlu memerika koneksi jaringan anda.", "theme.SearchModal.errorScreen.titleText": "Gagal mendapatkan hasilnya", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Tombol Escape", "theme.SearchModal.footer.closeText": "menutup", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Panah ke bawah", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "Cari dengan teks", "theme.SearchModal.footer.selectKeyAriaLabel": "Tombol Enter", "theme.SearchModal.footer.selectText": "memilih", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Tak ada hasil untuk", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Beri tahu kami.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Yakin pencarian ini seharusnya memberikan hasil?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Coba lakukan pencarian untuk", "theme.SearchModal.placeholder": "Cari dokumentasi", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Batalkan", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Hapus teks pencarian", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favorit", "theme.SearchModal.startScreen.noRecentSearchesText": "Tak ada riwayat pencarian", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Terbaru", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Hapus pencarian ini dari favorit", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Hapus pencarian ini dari riwayat", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Simpan pencarian ini", - "theme.SearchPage.algoliaLabel": "Pencarian oleh Algolia", + "theme.SearchPage.algoliaLabel": "Didukung oleh Algolia", "theme.SearchPage.documentsFound.plurals": "Satu dokumen ditemukan|{count} dokumen ditemukan", "theme.SearchPage.emptyResultsTitle": "Cari dokumentasi", "theme.SearchPage.existingResultsTitle": "Hasil pencarian untuk \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/is/theme-common.json b/packages/docusaurus-theme-translations/locales/is/theme-common.json index 95e0a23f64..9bc2e48265 100644 --- a/packages/docusaurus-theme-translations/locales/is/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/is/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Víkka spássíu flokk '{label}'", "theme.ErrorPageContent.title": "Síðan hrundi.", "theme.ErrorPageContent.tryAgain": "Reyndu aftur", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Aðal", "theme.NotFound.p1": "Við fundum ekki það sem þú leitaðir að.", "theme.NotFound.p2": "Vinsamlegast hafðu samband við eiganda síðunnar sem sendi þig hingað og láttu hann vita að hlekkurinn er brotinn.", diff --git a/packages/docusaurus-theme-translations/locales/is/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/is/theme-search-algolia.json index 547c0c0807..3b492a99a9 100644 --- a/packages/docusaurus-theme-translations/locales/is/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/is/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Leita", "theme.SearchBar.seeAll": "Sjá allar {count} niðurstöður", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Þú gætir viljað athuga nettenginguna.", "theme.SearchModal.errorScreen.titleText": "Tókst ekki að sækja niðurstöður", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape hnappur", "theme.SearchModal.footer.closeText": "til að loka", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Ör niður", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "Leit með", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter hnappur", "theme.SearchModal.footer.selectText": "að velja", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Engin niðurstaða fyrir", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Láttu okkur vita.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Tel að þessi fyrirspurn eigi að skila niðurstöðum?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Prófaðu að leita að", "theme.SearchModal.placeholder": "Leita í skjölum", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Hætta", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Hreinsa fyrirspurn", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Uppáhalds", "theme.SearchModal.startScreen.noRecentSearchesText": "Engar nýlegar leitir", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Nýlegar", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Fjarlægja þessa leit úr uppáhalds", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Fjarlægja þessa leit úr sögu", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Vista þessa leit", - "theme.SearchPage.algoliaLabel": "Leit með Algolia", + "theme.SearchPage.algoliaLabel": "Keyrt af Algolia", "theme.SearchPage.documentsFound.plurals": "Eitt skjal fannst|{count} skjöl fundust", "theme.SearchPage.emptyResultsTitle": "Leita í skjölun", "theme.SearchPage.existingResultsTitle": "Niðurstöður fyrir \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/it/theme-common.json b/packages/docusaurus-theme-translations/locales/it/theme-common.json index 7babe752f1..dc35eb97c8 100644 --- a/packages/docusaurus-theme-translations/locales/it/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/it/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", "theme.ErrorPageContent.title": "Questa pagina è andata in crash.", "theme.ErrorPageContent.tryAgain": "Prova di nuovo", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Principale", "theme.NotFound.p1": "Non siamo riusciti a trovare quello che stavi cercando.", "theme.NotFound.p2": "Contatta il proprietario del sito che ti ha collegato all'URL originale e fagli sapere che il loro collegamento è interrotto.", diff --git a/packages/docusaurus-theme-translations/locales/it/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/it/theme-search-algolia.json index 0160450688..f78ea26ab3 100644 --- a/packages/docusaurus-theme-translations/locales/it/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/it/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Cerca", "theme.SearchBar.seeAll": "Vedi tutti {count} risultati", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Potresti voler controllare la tua connessione di rete.", "theme.SearchModal.errorScreen.titleText": "Impossibile recuperare i risultati", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Tasto di fuga", "theme.SearchModal.footer.closeText": "chiudere", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Freccia giù", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "Cercato da", "theme.SearchModal.footer.selectKeyAriaLabel": "Tasto Invio", "theme.SearchModal.footer.selectText": "selezionare", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Nessun risultato per", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Facci sapere.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Credi che questa query dovrebbe restituire risultati?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Prova a cercare", "theme.SearchModal.placeholder": "Cerca documenti", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Annulla", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Cancella la query", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Preferita", "theme.SearchModal.startScreen.noRecentSearchesText": "Nessuna ricerca recente", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Recente", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Rimuovi questa ricerca dai preferiti", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Rimuovi questa ricerca dalla cronologia", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Salva questa ricerca", - "theme.SearchPage.algoliaLabel": "Ricerca tramite Algolia", + "theme.SearchPage.algoliaLabel": "Fornito da Algolia", "theme.SearchPage.documentsFound.plurals": "Un documento trovato|{count} documenti trovati", "theme.SearchPage.emptyResultsTitle": "Cerca nella documentazione", "theme.SearchPage.existingResultsTitle": "Risultati di ricerca per \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/ja/theme-common.json b/packages/docusaurus-theme-translations/locales/ja/theme-common.json index baa3964a64..577f6a4831 100644 --- a/packages/docusaurus-theme-translations/locales/ja/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/ja/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "'{label}'の目次を開く", "theme.ErrorPageContent.title": "エラーが発生しました", "theme.ErrorPageContent.tryAgain": "もう一度試してください", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "ナビゲーション", "theme.NotFound.p1": "お探しのページが見つかりませんでした", "theme.NotFound.p2": "このページにリンクしているサイトの所有者にリンクが壊れていることを伝えてください", diff --git a/packages/docusaurus-theme-translations/locales/ja/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/ja/theme-search-algolia.json index fa0ffbacdc..8d41242252 100644 --- a/packages/docusaurus-theme-translations/locales/ja/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/ja/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "検索", "theme.SearchBar.seeAll": "検索結果{count}件をすべて見る", + "theme.SearchModal.askAiScreen.afterToolCallText": "検索完了:", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "コピーしました!", + "theme.SearchModal.askAiScreen.copyButtonText": "コピー", + "theme.SearchModal.askAiScreen.copyButtonTitle": "コピー", + "theme.SearchModal.askAiScreen.disclaimerText": "回答はAIによって生成されており、誤りがある可能性があります。必ず内容を確認してください。", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "よくない", + "theme.SearchModal.askAiScreen.duringToolCallText": "検索中:", + "theme.SearchModal.askAiScreen.likeButtonTitle": "いいね", + "theme.SearchModal.askAiScreen.preToolCallText": "検索中...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "関連ソース", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "フィードバックありがとうございます!", + "theme.SearchModal.askAiScreen.thinkingText": "考え中...", "theme.SearchModal.errorScreen.helpText": "ネットワーク接続を確認してください", "theme.SearchModal.errorScreen.titleText": "検索結果の取得に失敗しました", + "theme.SearchModal.footer.backToSearchText": "検索に戻る", "theme.SearchModal.footer.closeKeyAriaLabel": "エスケープキー", "theme.SearchModal.footer.closeText": "閉じる", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "下矢印キー", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "検索", "theme.SearchModal.footer.selectKeyAriaLabel": "エンターキー", "theme.SearchModal.footer.selectText": "選ぶ", + "theme.SearchModal.footer.submitQuestionText": "質問を送信", "theme.SearchModal.noResultsScreen.noResultsText": "見つかりませんでした", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "報告する", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "よりよい検索結果がありますか?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "次の検索を試す:", "theme.SearchModal.placeholder": "ドキュメントを検索", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "AIに質問:", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "キーワード検索に戻る", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "キーワード検索に戻る", "theme.SearchModal.searchBox.cancelButtonText": "キャンセル", + "theme.SearchModal.searchBox.enterKeyHint": "検索", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "確定", + "theme.SearchModal.searchBox.placeholderText": "ドキュメントを検索", + "theme.SearchModal.searchBox.placeholderTextAskAi": "別の質問をする...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "回答中...", "theme.SearchModal.searchBox.resetButtonTitle": "クリア", + "theme.SearchModal.searchBox.searchInputLabel": "検索", "theme.SearchModal.startScreen.favoriteSearchesTitle": "お気に入り", "theme.SearchModal.startScreen.noRecentSearchesText": "最近の検索履歴はありません", + "theme.SearchModal.startScreen.recentConversationsTitle": "最近の会話", "theme.SearchModal.startScreen.recentSearchesTitle": "最近の検索", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "この検索をお気に入りから削除", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "この会話を履歴から削除", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "この検索を履歴から削除", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "この検索をお気に入りに追加", - "theme.SearchPage.algoliaLabel": "Algoliaで検索", + "theme.SearchPage.algoliaLabel": "Algolia提供", "theme.SearchPage.documentsFound.plurals": "{count}件のドキュメントが見つかりました", "theme.SearchPage.emptyResultsTitle": "ドキュメントを検索", "theme.SearchPage.existingResultsTitle": "『{query}』の検索結果", diff --git a/packages/docusaurus-theme-translations/locales/ko/theme-common.json b/packages/docusaurus-theme-translations/locales/ko/theme-common.json index 0eefc6ea49..0fc6e14665 100644 --- a/packages/docusaurus-theme-translations/locales/ko/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/ko/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "사이드바 분류 '{label}' 펼치기", "theme.ErrorPageContent.title": "페이지에 오류가 발생하였습니다.", "theme.ErrorPageContent.tryAgain": "다시 시도해 보세요", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "메인", "theme.NotFound.p1": "원하는 페이지를 찾을 수 없습니다.", "theme.NotFound.p2": "사이트 관리자에게 링크가 깨진 것을 알려주세요.", diff --git a/packages/docusaurus-theme-translations/locales/ko/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/ko/theme-search-algolia.json index d1941ec178..15111a335c 100644 --- a/packages/docusaurus-theme-translations/locales/ko/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/ko/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "검색", "theme.SearchBar.seeAll": "{count}개의 결과 확인하기", + "theme.SearchModal.askAiScreen.afterToolCallText": "검색 완료: ", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "복사됨!", + "theme.SearchModal.askAiScreen.copyButtonText": "복사", + "theme.SearchModal.askAiScreen.copyButtonTitle": "복사", + "theme.SearchModal.askAiScreen.disclaimerText": "답변은 AI가 생성하며 오류가 있을 수 있습니다. 응답을 확인해주세요.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "싫어요", + "theme.SearchModal.askAiScreen.duringToolCallText": "검색 중: ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "좋아요", + "theme.SearchModal.askAiScreen.preToolCallText": "검색 중...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "관련 출처", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "피드백 감사합니다!", + "theme.SearchModal.askAiScreen.thinkingText": "생각 중...", "theme.SearchModal.errorScreen.helpText": "인터넷 연결을 다시 확인하시기 바랍니다.", "theme.SearchModal.errorScreen.titleText": "결과를 불러올 수 없음", + "theme.SearchModal.footer.backToSearchText": "검색으로 돌아가기", "theme.SearchModal.footer.closeKeyAriaLabel": "Esc 키", "theme.SearchModal.footer.closeText": "로 종료", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "화살표 아래 키", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "검색 제공", "theme.SearchModal.footer.selectKeyAriaLabel": "엔터 키", "theme.SearchModal.footer.selectText": "로 선택", + "theme.SearchModal.footer.submitQuestionText": "질문 제출", "theme.SearchModal.noResultsScreen.noResultsText": "검색 결과 없음", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "알려주시기 바랍니다.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "검색 결과가 없는 것이 오류라고 생각되십니까?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "다른 추천 검색어", "theme.SearchModal.placeholder": "문서 검색", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "AI에게 질문: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "키워드 검색으로 돌아가기", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "키워드 검색으로 돌아가기", "theme.SearchModal.searchBox.cancelButtonText": "취소", + "theme.SearchModal.searchBox.enterKeyHint": "검색", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "입력", + "theme.SearchModal.searchBox.placeholderText": "문서 검색", + "theme.SearchModal.searchBox.placeholderTextAskAi": "다른 질문하기...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "답변 중...", "theme.SearchModal.searchBox.resetButtonTitle": "검색어 초기화", + "theme.SearchModal.searchBox.searchInputLabel": "검색", "theme.SearchModal.startScreen.favoriteSearchesTitle": "즐겨찾기", "theme.SearchModal.startScreen.noRecentSearchesText": "최근 검색어 없음", + "theme.SearchModal.startScreen.recentConversationsTitle": "최근 대화", "theme.SearchModal.startScreen.recentSearchesTitle": "최근", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "이 검색어를 즐겨찾기에서 삭제", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "이 대화를 기록에서 삭제", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "이 검색어를 최근 검색어에서 삭제", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "이 검색어를 저장", - "theme.SearchPage.algoliaLabel": "Algolia로 검색", + "theme.SearchPage.algoliaLabel": "Algolia 제공", "theme.SearchPage.documentsFound.plurals": "{count}개의 문서를 찾았습니다.", "theme.SearchPage.emptyResultsTitle": "문서를 검색합니다.", "theme.SearchPage.existingResultsTitle": "\"{query}\" 검색 결과", diff --git a/packages/docusaurus-theme-translations/locales/nb/theme-common.json b/packages/docusaurus-theme-translations/locales/nb/theme-common.json index 269df3c551..97d7c3eb77 100644 --- a/packages/docusaurus-theme-translations/locales/nb/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/nb/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", "theme.ErrorPageContent.title": "Denne siden krasjet.", "theme.ErrorPageContent.tryAgain": "Prøv på nytt", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Hoved", "theme.NotFound.p1": "Vi kunne ikke finne det du lette etter.", "theme.NotFound.p2": "Kontakt eieren av nettstedet som koblet deg til den opprinnelige nettadressen og la dem få vite at koblingen deres er ødelagt.", diff --git a/packages/docusaurus-theme-translations/locales/nb/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/nb/theme-search-algolia.json index 1871413677..95048f778b 100644 --- a/packages/docusaurus-theme-translations/locales/nb/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/nb/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Søk", "theme.SearchBar.seeAll": "Se alle {count} resultat", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Det kan være lurt å sjekke nettverkstilkoblingen.", "theme.SearchModal.errorScreen.titleText": "Kan ikke hente resultater", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape-tasten", "theme.SearchModal.footer.closeText": "Lukk", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Pil ned", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "Søk på", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter-tasten", "theme.SearchModal.footer.selectText": "for å velge", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Ingen resultat", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Gi oss beskjed.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Tenker du at denne spørringen bør gi resultater?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Prøv å søke etter", "theme.SearchModal.placeholder": "Søk i dokumenter", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Avbryt", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Fjern søket", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favoritt", "theme.SearchModal.startScreen.noRecentSearchesText": "Ingen nylige søk", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Nylig", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Fjern dette søket fra favoritter", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Fjern dette søket fra loggen", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Lagre dette søket", - "theme.SearchPage.algoliaLabel": "Søk med Algolia", + "theme.SearchPage.algoliaLabel": "Drevet av Algolia", "theme.SearchPage.documentsFound.plurals": "Ett dokument funnet|{count} dokumenter funnet", "theme.SearchPage.emptyResultsTitle": "Søk i dokumentasjonen", "theme.SearchPage.existingResultsTitle": "Søkeresultater for \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/nl/theme-common.json b/packages/docusaurus-theme-translations/locales/nl/theme-common.json index 706e70871f..8059850dff 100644 --- a/packages/docusaurus-theme-translations/locales/nl/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/nl/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Categorie zijbalk uitklappen '{label}'", "theme.ErrorPageContent.title": "Deze pagina is gecrasht.", "theme.ErrorPageContent.tryAgain": "Probeer opnieuw", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Main", "theme.NotFound.p1": "We kunnen niet vinden waar je naar op zoek bent.", "theme.NotFound.p2": "Neem contact op met de eigenaar van de website die naar de originele URL heeft geleid en laat weten dat de link niet meer werkt.", diff --git a/packages/docusaurus-theme-translations/locales/nl/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/nl/theme-search-algolia.json index 8b99bcd7a7..910e036249 100644 --- a/packages/docusaurus-theme-translations/locales/nl/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/nl/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Zoeken", "theme.SearchBar.seeAll": "Laat alle {count} resultaten zien", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Misschien wilt u uw netwerkverbinding controleren.", "theme.SearchModal.errorScreen.titleText": "Niet in staat resultaten op te halen", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape-toets", "theme.SearchModal.footer.closeText": "om te sluiten", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Pijltoets naar beneden", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "Zoek op", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter-toets", "theme.SearchModal.footer.selectText": "om te selecteren", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Geen resultaten voor", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Laat het ons weten.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Zou deze zoekopdracht resultaten moeten opleveren?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Probeer om te zoeken op", "theme.SearchModal.placeholder": "Doorzoek de documentatie", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Annuleren", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Maak de zoekopdracht leeg", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favoriet", "theme.SearchModal.startScreen.noRecentSearchesText": "Geen recente zoekopdrachten", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Recente zoekopdrachten", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Verwijder deze zoekopdracht uit mijn favorieten", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Verwijder deze zoekopdracht uit mijn geschiedenis", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Sla deze zoekopdracht op", - "theme.SearchPage.algoliaLabel": "Zoeken door Algolia", + "theme.SearchPage.algoliaLabel": "Aangedreven door Algolia", "theme.SearchPage.documentsFound.plurals": "Een document gevonden|{count} documenten gevonden", "theme.SearchPage.emptyResultsTitle": "Doorzoek de documentatie", "theme.SearchPage.existingResultsTitle": "Zoekresultaten voor \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/pl/theme-common.json b/packages/docusaurus-theme-translations/locales/pl/theme-common.json index 3a6f707943..bd1789d618 100644 --- a/packages/docusaurus-theme-translations/locales/pl/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/pl/theme-common.json @@ -5,11 +5,12 @@ "theme.CodeBlock.copy": "Kopiuj", "theme.CodeBlock.copyButtonAriaLabel": "Kopiuj do schowka", "theme.CodeBlock.wordWrapToggle": "Przełącz zawijanie słów", - "theme.DocSidebarItem.collapseCategoryAriaLabel": "Collapse sidebar category '{label}'", - "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", + "theme.DocSidebarItem.collapseCategoryAriaLabel": "Zwiń kategorię paska bocznego '{label}'", + "theme.DocSidebarItem.expandCategoryAriaLabel": "Rozwiń kategorię paska bocznego '{label}'", "theme.ErrorPageContent.title": "Ta strona uległa awarii.", "theme.ErrorPageContent.tryAgain": "Spróbuj ponownie", - "theme.NavBar.navAriaLabel": "Main", + "theme.IconExternalLink.ariaLabel": "(otwiera się w nowej karcie)", + "theme.NavBar.navAriaLabel": "Główny", "theme.NotFound.p1": "Nie mogliśmy znaleźć strony której szukasz.", "theme.NotFound.p2": "Proszę skontaktuj się z właścielem strony, z której link doprowadził Cię tutaj i poinformuj go, że link jest nieprawidłowy.", "theme.NotFound.title": "Strona nie została znaleziona", @@ -19,7 +20,7 @@ "theme.admonition.info": "informacja", "theme.admonition.note": "notatka", "theme.admonition.tip": "wskazówka", - "theme.admonition.warning": "warning", + "theme.admonition.warning": "ostrzeżenie", "theme.blog.archive.description": "Archiwum", "theme.blog.archive.title": "Archiwum", "theme.blog.author.noPosts": "Ten autor nie napisał jeszcze żadnych postów.", @@ -45,8 +46,8 @@ "theme.common.editThisPage": "Edytuj tę stronę", "theme.common.headingLinkTitle": "Bezpośredni link do {heading}", "theme.common.skipToMainContent": "Przejdź do głównej zawartości", - "theme.contentVisibility.draftBanner.message": "This page is a draft. It will only be visible in dev and be excluded from the production build.", - "theme.contentVisibility.draftBanner.title": "Draft page", + "theme.contentVisibility.draftBanner.message": "Ta strona jest w wersji roboczej. Będzie widoczna tylko w wersji deweloperskiej i zostanie wyłączona z wersji produkcyjnej.", + "theme.contentVisibility.draftBanner.title": "Wersja robocza strony", "theme.contentVisibility.unlistedBanner.message": "Ta strona jest niepubliczna. Wyszukiwarki nie będą jej indeksować, a dostęp do niej będą mieli tylko użytkownicy posiadający bezpośredni link.", "theme.contentVisibility.unlistedBanner.title": "Niepubliczna strona", "theme.docs.DocCard.categoryDescription.plurals": "1 element|{count} elementy|{count} elementów", diff --git a/packages/docusaurus-theme-translations/locales/pl/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/pl/theme-search-algolia.json index bc4ab9d5f6..b689bd2133 100644 --- a/packages/docusaurus-theme-translations/locales/pl/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/pl/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Szukaj", "theme.SearchBar.seeAll": "Wyświetl wszystkie {count} wyników", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Sprawdź swoje połączenie sieciowe.", "theme.SearchModal.errorScreen.titleText": "Nie można pobrać wyników", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Klawisz Escape", "theme.SearchModal.footer.closeText": "aby zamknąć", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Strzałka w dół", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "Szukaj według", "theme.SearchModal.footer.selectKeyAriaLabel": "Klawisz Enter", "theme.SearchModal.footer.selectText": "aby wybrać", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Brak wyników dla", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Daj nam znać.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Wydaje Ci się, że to zapytanie powinno zwrócić wyniki?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Spróbuj poszukać", "theme.SearchModal.placeholder": "Wyszukaj dokumenty", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Anuluj", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Wyczyść zapytanie", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Ulubione", "theme.SearchModal.startScreen.noRecentSearchesText": "Brak ostatnich wyszukiwań", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Ostatnie wyszukiwania", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Usuń to wyszukiwanie z ulubionych", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Usuń to wyszukiwanie z historii", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Zapisz to wyszukiwanie", - "theme.SearchPage.algoliaLabel": "Dostawca rozwiązania Algolia", + "theme.SearchPage.algoliaLabel": "Napędzane przez Algolia", "theme.SearchPage.documentsFound.plurals": "Jeden dokument znaleziony|{count} dokumenty znalezione|{count} dokumentów znalezionych", "theme.SearchPage.emptyResultsTitle": "Wyszukaj w dokumentacji", "theme.SearchPage.existingResultsTitle": "Wyniki wyszukiwania dla \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/pt-BR/theme-common.json b/packages/docusaurus-theme-translations/locales/pt-BR/theme-common.json index d848584d66..5d39829d8d 100644 --- a/packages/docusaurus-theme-translations/locales/pt-BR/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/pt-BR/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Expandir a categoria '{label}'", "theme.ErrorPageContent.title": "Esta página deu erro.", "theme.ErrorPageContent.tryAgain": "Tentar novamente", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Navegação principal", "theme.NotFound.p1": "Não foi possível encontrar o que você está procurando.", "theme.NotFound.p2": "Por favor, entre em contato com o dono do site que ligou você à URL original e informe que o link está quebrado.", diff --git a/packages/docusaurus-theme-translations/locales/pt-BR/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/pt-BR/theme-search-algolia.json index 83938b9c90..31ba849998 100644 --- a/packages/docusaurus-theme-translations/locales/pt-BR/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/pt-BR/theme-search-algolia.json @@ -1,35 +1,60 @@ { - "theme.SearchBar.label": "Buscar", + "theme.SearchBar.label": "Procurar", "theme.SearchBar.seeAll": "Ver todos os {count} resultados", + "theme.SearchModal.askAiScreen.afterToolCallText": "Procurou por", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copiado!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copiar", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copiar", + "theme.SearchModal.askAiScreen.disclaimerText": "Respostas geradas por IA podem cometer erros. Verifique.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Procurando por ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Procurando...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Resultados relacionados", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Obrigado pelo seu feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Pensando...", "theme.SearchModal.errorScreen.helpText": "Talvez você deva verificar sua conexão de rede.", "theme.SearchModal.errorScreen.titleText": "Não foi possível obter resultados", + "theme.SearchModal.footer.backToSearchText": "Voltar para pesquisa", "theme.SearchModal.footer.closeKeyAriaLabel": "Tecla Esc", "theme.SearchModal.footer.closeText": "fechar", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Seta para baixo", "theme.SearchModal.footer.navigateText": "navegar", "theme.SearchModal.footer.navigateUpKeyAriaLabel": "Seta para cima", - "theme.SearchModal.footer.searchByText": "Esta busca utiliza", + "theme.SearchModal.footer.searchByText": "Esta pesquisa utiliza", "theme.SearchModal.footer.selectKeyAriaLabel": "Tecla Enter", "theme.SearchModal.footer.selectText": "selecionar", + "theme.SearchModal.footer.submitQuestionText": "Enviar pergunta", "theme.SearchModal.noResultsScreen.noResultsText": "Nenhum resultado para", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Nos avise.", - "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Você acha que esta busca deveria retornar resultados?", - "theme.SearchModal.noResultsScreen.suggestedQueryText": "Tente buscar por", - "theme.SearchModal.placeholder": "Buscar documentos", + "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Você acha que esta pesquisa deveria retornar resultados?", + "theme.SearchModal.noResultsScreen.suggestedQueryText": "Tente procurar por", + "theme.SearchModal.placeholder": "Procurar documentos", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Pergunte para a IA: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Voltar para a pesquisa por palavra-chave", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Voltar para a pesquisa por palavra-chave", "theme.SearchModal.searchBox.cancelButtonText": "Cancelar", - "theme.SearchModal.searchBox.resetButtonTitle": "Limpar a busca", + "theme.SearchModal.searchBox.enterKeyHint": "procurar", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Procurar na documentação", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Pergunte outra coisa...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Respondendo...", + "theme.SearchModal.searchBox.resetButtonTitle": "Limpar a pesquisa", + "theme.SearchModal.searchBox.searchInputLabel": "Procurar", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favorito", - "theme.SearchModal.startScreen.noRecentSearchesText": "Nenhuma busca recente", + "theme.SearchModal.startScreen.noRecentSearchesText": "Nenhuma pesquisa recente", + "theme.SearchModal.startScreen.recentConversationsTitle": "Conversas recentes", "theme.SearchModal.startScreen.recentSearchesTitle": "Recente", - "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Remover esta busca dos favoritos", - "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Remover esta busca do histórico", - "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Salvar esta busca", - "theme.SearchPage.algoliaLabel": "Busca feita por Algolia", + "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Remover esta pesquisa dos favoritos", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", + "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Remover esta pesquisa do histórico", + "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Salvar esta pesquisa", + "theme.SearchPage.algoliaLabel": "Desenvolvido por Algolia", "theme.SearchPage.documentsFound.plurals": "Um documento encontrado|{count} documentos encontrados", - "theme.SearchPage.emptyResultsTitle": "Busca da documentação", - "theme.SearchPage.existingResultsTitle": "Resultado da busca por \"{query}\"", + "theme.SearchPage.emptyResultsTitle": "Pesquisa da documentação", + "theme.SearchPage.existingResultsTitle": "Resultado da pesquisa por \"{query}\"", "theme.SearchPage.fetchingNewResults": "Trazendo novos resultados...", - "theme.SearchPage.inputLabel": "Buscar", - "theme.SearchPage.inputPlaceholder": "Digite sua busca aqui", + "theme.SearchPage.inputLabel": "Procurar", + "theme.SearchPage.inputPlaceholder": "Digite sua pesquisa aqui", "theme.SearchPage.noResultsText": "Nenhum resultado foi encontrado" } diff --git a/packages/docusaurus-theme-translations/locales/pt-PT/theme-common.json b/packages/docusaurus-theme-translations/locales/pt-PT/theme-common.json index 9904d6c177..af7fff8e74 100644 --- a/packages/docusaurus-theme-translations/locales/pt-PT/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/pt-PT/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", "theme.ErrorPageContent.title": "This page crashed.", "theme.ErrorPageContent.tryAgain": "Try again", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Main", "theme.NotFound.p1": "Não foi possível encontrar o que procura.", "theme.NotFound.p2": "Por favor, contacte o proprietário do site que o trouxe aqui e informe-lhe que o link está partido.", diff --git a/packages/docusaurus-theme-translations/locales/pt-PT/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/pt-PT/theme-search-algolia.json index 1d1ab1ef63..2a47d02c79 100644 --- a/packages/docusaurus-theme-translations/locales/pt-PT/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/pt-PT/theme-search-algolia.json @@ -1,30 +1,55 @@ { "theme.SearchBar.label": "Pesquisar", "theme.SearchBar.seeAll": "See all {count} results", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "You might want to check your network connection.", "theme.SearchModal.errorScreen.titleText": "Unable to fetch results", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape key", "theme.SearchModal.footer.closeText": "to close", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Arrow down", "theme.SearchModal.footer.navigateText": "to navigate", "theme.SearchModal.footer.navigateUpKeyAriaLabel": "Arrow up", - "theme.SearchModal.footer.searchByText": "Search by", + "theme.SearchModal.footer.searchByText": "Powered by", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter key", "theme.SearchModal.footer.selectText": "to select", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "No results for", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Let us know.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Believe this query should return results?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Try searching for", "theme.SearchModal.placeholder": "Search docs", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Cancel", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Clear the query", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favorite", "theme.SearchModal.startScreen.noRecentSearchesText": "No recent searches", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Recent", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Remove this search from favorites", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Remove this search from history", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Save this search", - "theme.SearchPage.algoliaLabel": "Pesquisa por Algolia", + "theme.SearchPage.algoliaLabel": "Desenvolvido por Algolia", "theme.SearchPage.documentsFound.plurals": "Um documento encontrado|{count} documentos encontrados", "theme.SearchPage.emptyResultsTitle": "Pesquisar pela documentação", "theme.SearchPage.existingResultsTitle": "Resultados da pesquisa por \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/ru/theme-common.json b/packages/docusaurus-theme-translations/locales/ru/theme-common.json index e432ddb2c0..0dbeaf6aed 100644 --- a/packages/docusaurus-theme-translations/locales/ru/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/ru/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", "theme.ErrorPageContent.title": "На странице произошёл сбой.", "theme.ErrorPageContent.tryAgain": "Попробуйте ещё раз", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Main", "theme.NotFound.p1": "К сожалению, мы не смогли найти запрашиваемую вами страницу.", "theme.NotFound.p2": "Пожалуйста, обратитесь к владельцу сайта, с которого вы перешли на эту ссылку, чтобы сообщить ему, что ссылка не работает.", diff --git a/packages/docusaurus-theme-translations/locales/ru/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/ru/theme-search-algolia.json index 39005aee5c..1df1f89722 100644 --- a/packages/docusaurus-theme-translations/locales/ru/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/ru/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Поиск", "theme.SearchBar.seeAll": "Посмотреть все результаты ({count})", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Проверьте подключение к интернету.", "theme.SearchModal.errorScreen.titleText": "Невозможно загрузить результаты поиска", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Клавиша Escape", "theme.SearchModal.footer.closeText": "закрыть", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Клавиша стрелка вниз", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "Поиск от", "theme.SearchModal.footer.selectKeyAriaLabel": "Клавиша Enter", "theme.SearchModal.footer.selectText": "выбрать", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Нет результатов по запросу", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Сообщите нам.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Нет подходящего результата поиска?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Попробуйте", "theme.SearchModal.placeholder": "Поиск", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Отменить", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Очистить", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Избранное", "theme.SearchModal.startScreen.noRecentSearchesText": "Нет истории поиска", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Недавнее", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Удалить запись из избранное", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Удалить запись из историю", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Сохранить поисковый запрос", - "theme.SearchPage.algoliaLabel": "Поиск от Algolia", + "theme.SearchPage.algoliaLabel": "При поддержке Algolia", "theme.SearchPage.documentsFound.plurals": "{count} документ|{count} документа|{count} документов", "theme.SearchPage.emptyResultsTitle": "Поиск по сайту", "theme.SearchPage.existingResultsTitle": "Результаты поиска по запросу \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/sl/theme-common.json b/packages/docusaurus-theme-translations/locales/sl/theme-common.json index ecec838635..6cdefa9bd1 100644 --- a/packages/docusaurus-theme-translations/locales/sl/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/sl/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Razširite kategorijo stranske vrstice '{label}'", "theme.ErrorPageContent.title": "Ta stran se je zrušila.", "theme.ErrorPageContent.tryAgain": "Poskusite ponovno", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Glavna navigacija", "theme.NotFound.p1": "Iskane strani ni bilo možno najti", "theme.NotFound.p2": "Prosim kontaktirajte lastnike strani, s katere ste sledili povezavi in jih obvestite, da povezava ne deluje.", diff --git a/packages/docusaurus-theme-translations/locales/sl/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/sl/theme-search-algolia.json index e2c1e41bc3..d9d61b94d5 100644 --- a/packages/docusaurus-theme-translations/locales/sl/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/sl/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Išči", "theme.SearchBar.seeAll": "Poglej vse rezultate ({count})", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Preverite vašo spletno povezavo.", "theme.SearchModal.errorScreen.titleText": "Rezultatov ni bilo možno naložiti", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Tipka Escape", "theme.SearchModal.footer.closeText": "zapri", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Tipka puščica navzdol", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "Iskanje", "theme.SearchModal.footer.selectKeyAriaLabel": "tipka Enter", "theme.SearchModal.footer.selectText": "izberi", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Ni rezultatov za", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Obvestite nas.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Mislite, da bi morali obstajati rezultati?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Poskusite poiskati", "theme.SearchModal.placeholder": "Išči po dokumentaciji", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Prekliči", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Izprazni iskalni niz", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Priljubljena iskanja", "theme.SearchModal.startScreen.noRecentSearchesText": "Ni iskanj pred kratkim", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Pred kratkim", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Umakni iskanje iz priljubljenih", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Umakni iskanje iz zgodovine", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Shrani to iskanje", - "theme.SearchPage.algoliaLabel": "Iskanje Algolia", + "theme.SearchPage.algoliaLabel": "Poganja Algolia", "theme.SearchPage.documentsFound.plurals": "Dokument najden|Dokumenta najdena|{count} dokumenti najdeni|{count} dokumentov najdenih", "theme.SearchPage.emptyResultsTitle": "Išči po dokumentaciji", "theme.SearchPage.existingResultsTitle": "Rezultati iskanja za \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/sr/theme-common.json b/packages/docusaurus-theme-translations/locales/sr/theme-common.json index 8bbe9459bb..82b658edb1 100644 --- a/packages/docusaurus-theme-translations/locales/sr/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/sr/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", "theme.ErrorPageContent.title": "This page crashed.", "theme.ErrorPageContent.tryAgain": "Try again", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Main", "theme.NotFound.p1": "Тражени резултат не постоји.", "theme.NotFound.p2": "Молимо вас да контактирате власника сајта који вас је упутио овде и обавестите га да је њихова веза нетачна.", diff --git a/packages/docusaurus-theme-translations/locales/sr/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/sr/theme-search-algolia.json index 4c6e05d55e..337015a14e 100644 --- a/packages/docusaurus-theme-translations/locales/sr/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/sr/theme-search-algolia.json @@ -1,30 +1,55 @@ { "theme.SearchBar.label": "Тражи", "theme.SearchBar.seeAll": "See all {count} results", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "You might want to check your network connection.", "theme.SearchModal.errorScreen.titleText": "Unable to fetch results", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape key", "theme.SearchModal.footer.closeText": "to close", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Arrow down", "theme.SearchModal.footer.navigateText": "to navigate", "theme.SearchModal.footer.navigateUpKeyAriaLabel": "Arrow up", - "theme.SearchModal.footer.searchByText": "Search by", + "theme.SearchModal.footer.searchByText": "Powered by", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter key", "theme.SearchModal.footer.selectText": "to select", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "No results for", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Let us know.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Believe this query should return results?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Try searching for", "theme.SearchModal.placeholder": "Search docs", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Cancel", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Clear the query", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favorite", "theme.SearchModal.startScreen.noRecentSearchesText": "No recent searches", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Recent", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Remove this search from favorites", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Remove this search from history", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Save this search", - "theme.SearchPage.algoliaLabel": "Претрага из Algolia", + "theme.SearchPage.algoliaLabel": "Покреће Algolia", "theme.SearchPage.documentsFound.plurals": "Један пронађен документ|{count} пронађених докумената", "theme.SearchPage.emptyResultsTitle": "Тражи документацију", "theme.SearchPage.existingResultsTitle": "Резултати за \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/sv/theme-common.json b/packages/docusaurus-theme-translations/locales/sv/theme-common.json index c37e11ac95..201816a092 100644 --- a/packages/docusaurus-theme-translations/locales/sv/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/sv/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Expand sidebar category '{label}'", "theme.ErrorPageContent.title": "Denna sida har kraschat.", "theme.ErrorPageContent.tryAgain": "Försök igen", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Main", "theme.NotFound.p1": "Vi kunde inte hitta det du letade efter.", "theme.NotFound.p2": "Vänligen kontakta ägaren av webbplatsen som länkade dig till den ursprungliga webbadressen och låt dem veta att denna länk är trasig.", diff --git a/packages/docusaurus-theme-translations/locales/sv/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/sv/theme-search-algolia.json index c5477d8b59..c83d2e778b 100644 --- a/packages/docusaurus-theme-translations/locales/sv/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/sv/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Sök", "theme.SearchBar.seeAll": "Se alla {count} resultat", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Du kanske vill kontrollera din nätverksanslutning.", "theme.SearchModal.errorScreen.titleText": "Kunde inte hämta resultat", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape-tangenten", "theme.SearchModal.footer.closeText": "för att stänga", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Pil ned", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "Sökning från", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter-tangenten", "theme.SearchModal.footer.selectText": "för att välja", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Inga resultat för", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Återkoppla.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Tycker du att sökningen borde returnera resultat?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Försöka söka efter", "theme.SearchModal.placeholder": "Sök i dokumentationen", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Avbryt", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Rensa sökningen", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favoriter", "theme.SearchModal.startScreen.noRecentSearchesText": "Inga senaste sökningar", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Senaste sökningar", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Ta bort från favoriter", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Ta bort från historiken", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Lägg till som favorit", - "theme.SearchPage.algoliaLabel": "Sökning från Algolia", + "theme.SearchPage.algoliaLabel": "Drivs av Algolia", "theme.SearchPage.documentsFound.plurals": "Ett dokument hittades|{count} dokument hittades", "theme.SearchPage.emptyResultsTitle": "Sök genom dokumentationen", "theme.SearchPage.existingResultsTitle": "Sökresultat för \"{query}\"", diff --git a/packages/docusaurus-theme-translations/locales/tk/theme-common.json b/packages/docusaurus-theme-translations/locales/tk/theme-common.json index 406db5528a..7c4558bff1 100644 --- a/packages/docusaurus-theme-translations/locales/tk/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/tk/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Gapdal paneli görkez'{label}'", "theme.ErrorPageContent.title": "Sahypada näsazlyk ýüze çykdy.", "theme.ErrorPageContent.tryAgain": "Gaýtadan synanyşyň", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Esasy", "theme.NotFound.p1": "Gynansakda, ýüzlenen sahypaňyz tapylmady", "theme.NotFound.p2": "Web sahypanyň dolandyryjylaryna habar bermegiňizi sizden haýyş edýäris", diff --git a/packages/docusaurus-theme-translations/locales/tk/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/tk/theme-search-algolia.json index 39627ef516..c3621dcaff 100644 --- a/packages/docusaurus-theme-translations/locales/tk/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/tk/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Gözleg", "theme.SearchBar.seeAll": "Ähli netijeleri gör ({count})", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Internet birikmäňizi barlaň.", "theme.SearchModal.errorScreen.titleText": "Gözleg netijelerini ýüklemek mümkin däl", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Escape düwmesi", "theme.SearchModal.footer.closeText": "ýapmak", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Aşak ok düwmesi", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "Gözleg", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter düwmesi", "theme.SearchModal.footer.selectText": "saýlamak", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Sorag boýunça netijeler ýok", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Bize habar beriň.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Gözleg netijesi ýokmy?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Synanyşyň", "theme.SearchModal.placeholder": "Gözleg", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Ýatyrmak", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Arassalamak", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Halaýanlar", "theme.SearchModal.startScreen.noRecentSearchesText": "Gözleg taryhy ýok", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Soňky", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Halaýan ýazgyny aýyrmak", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Taryh ýazgysyny aýyrmak", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Gözleg soragyny ýatda saklaň", - "theme.SearchPage.algoliaLabel": "Algolia tarapyndan gözleg", + "theme.SearchPage.algoliaLabel": "Algolia tarapyndan goldanylýar", "theme.SearchPage.documentsFound.plurals": "{count} dokument|{count} dokumentler", "theme.SearchPage.emptyResultsTitle": "Sahypada gözleg", "theme.SearchPage.existingResultsTitle": "\"{query}\" boýunça gözleg netijeleri", diff --git a/packages/docusaurus-theme-translations/locales/tr/theme-common.json b/packages/docusaurus-theme-translations/locales/tr/theme-common.json index de75f52498..433b7d0c67 100644 --- a/packages/docusaurus-theme-translations/locales/tr/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/tr/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Kenar çubuğu kategorisini genişlet '{label}'", "theme.ErrorPageContent.title": "Bu sayfa çöktü.", "theme.ErrorPageContent.tryAgain": "Tekrar deneyin", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Ana menü", "theme.NotFound.p1": "Aradığınız şeyi bulamadık.", "theme.NotFound.p2": "Lütfen sizi orijinal URL'ye yönlendiren sitenin sahibiyle iletişime geçin ve bağlantısının bozuk olduğunu bildirin.", diff --git a/packages/docusaurus-theme-translations/locales/tr/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/tr/theme-search-algolia.json index 04b00b9690..c1635ea334 100644 --- a/packages/docusaurus-theme-translations/locales/tr/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/tr/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Ara", "theme.SearchBar.seeAll": "{count} sonucun tümünü görün", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Ağ bağlantınızı kontrol etmek isteyebilirsiniz.", "theme.SearchModal.errorScreen.titleText": "Sonuçlar alınamadı", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "ESC Tuşu", "theme.SearchModal.footer.closeText": "Kapat", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Aşağı ok", @@ -11,20 +24,32 @@ "theme.SearchModal.footer.searchByText": "Şuna göre ara:", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter tuşu", "theme.SearchModal.footer.selectText": "Seç", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "için sonuç yok", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Bilmemize izin ver.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Bu sorgunun sonuç döndürmesi gerektiğine inanıyor musunuz?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Aramayı deneyin", "theme.SearchModal.placeholder": "Dokümanlarda ara", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "İptal", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Sorguyu temizle", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Favori", "theme.SearchModal.startScreen.noRecentSearchesText": "Son arama yok", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Son", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Bu aramayı favorilerden kaldır", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Bu aramayı geçmişten kaldır", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Bu aramayı kaydet", - "theme.SearchPage.algoliaLabel": "Algolia ile Ara", + "theme.SearchPage.algoliaLabel": "Algolia tarafından desteklenmektedir", "theme.SearchPage.documentsFound.plurals": "Bir döküman bulundu|{count} döküman bulundu", "theme.SearchPage.emptyResultsTitle": "Dokümanlarda ara", "theme.SearchPage.existingResultsTitle": "Arama sonuçları", diff --git a/packages/docusaurus-theme-translations/locales/uk/theme-common.json b/packages/docusaurus-theme-translations/locales/uk/theme-common.json index 72ee02cdf7..759ca2716f 100644 --- a/packages/docusaurus-theme-translations/locales/uk/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/uk/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Розгорнути категорію в сайдбарі '{label}'", "theme.ErrorPageContent.title": "На сторінці стався збій.", "theme.ErrorPageContent.tryAgain": "Спробуйте ще раз", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Головна", "theme.NotFound.p1": "На жаль, ми не змогли знайти сторінку, яку ви запитували.", "theme.NotFound.p2": "Будь ласка, зверніться до власника сайту, з якого ви перейшли на це посилання, щоб повідомити, що посилання не працює.", diff --git a/packages/docusaurus-theme-translations/locales/uk/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/uk/theme-search-algolia.json index 263ee92511..d26538bc52 100644 --- a/packages/docusaurus-theme-translations/locales/uk/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/uk/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Пошук", "theme.SearchBar.seeAll": "Переглянути всі результати ({count})", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Перевірте підключення до мережі.", "theme.SearchModal.errorScreen.titleText": "Не вдалося отримати результати", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Клавіша Escape", "theme.SearchModal.footer.closeText": "закрити", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Стрілка вниз", @@ -11,25 +24,37 @@ "theme.SearchModal.footer.searchByText": "Пошук за допомогою", "theme.SearchModal.footer.selectKeyAriaLabel": "Клавіша Enter", "theme.SearchModal.footer.selectText": "обрати", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Немає результатів для", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Дайте нам знати.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Чи вважаєте ви, що цей запит має повернути результати?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Спробуйте пошукати", "theme.SearchModal.placeholder": "Пошук документів", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Скасувати", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Очистити запит", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Обране", "theme.SearchModal.startScreen.noRecentSearchesText": "Немає останніх пошуків", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Останні", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Видалити цей пошук з обраного", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Видалити цей пошук з історії", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Зберегти цей пошук", - "theme.SearchPage.algoliaLabel": "Пошук за допомогою Algolia", + "theme.SearchPage.algoliaLabel": "Працює на Algolia", "theme.SearchPage.documentsFound.plurals": "{count} документ|{count} документи|{count} документів", "theme.SearchPage.emptyResultsTitle": "Пошук по сайту", "theme.SearchPage.existingResultsTitle": "Результати пошуку за запитом \"{query}\"", "theme.SearchPage.fetchingNewResults": "Завантаження нових результатів пошуку...", "theme.SearchPage.inputLabel": "Пошук", - "theme.SearchPage.inputPlaceholder": "Введіть фразу для пошуку", - "theme.SearchPage.noResultsText": "За запитом нічого не знайдено" + "theme.SearchPage.inputPlaceholder": "Введіть ваш пошук тут", + "theme.SearchPage.noResultsText": "Не знайдено результатів" } diff --git a/packages/docusaurus-theme-translations/locales/vi/theme-common.json b/packages/docusaurus-theme-translations/locales/vi/theme-common.json index 33994fd5e2..04ba9c6b75 100644 --- a/packages/docusaurus-theme-translations/locales/vi/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/vi/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "Xem thêm danh mục '{label}'", "theme.ErrorPageContent.title": "Trang này đã gặp lỗi.", "theme.ErrorPageContent.tryAgain": "Thử lại", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "Thanh điều hướng", "theme.NotFound.p1": "Chúng tôi không thể tìm thấy nội dung bạn đang tìm kiếm.", "theme.NotFound.p2": "Vui lòng liên hệ với trang web đã đưa bạn đến đây và thông báo rằng đường dẫn này bị lỗi.", diff --git a/packages/docusaurus-theme-translations/locales/vi/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/vi/theme-search-algolia.json index 664f86539c..18191ca11a 100644 --- a/packages/docusaurus-theme-translations/locales/vi/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/vi/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "Tìm kiếm", "theme.SearchBar.seeAll": "Xem tất cả {count} kết quả", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "Bạn nên kiểm tra lại kết nối mạng của mình.", "theme.SearchModal.errorScreen.titleText": "Không thể tìm nạp dữ liệu", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Phím thoát", "theme.SearchModal.footer.closeText": "để đóng", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "Mũi tên xuống", @@ -11,25 +24,37 @@ "theme.SearchModal.footer.searchByText": "Tìm kiếm theo", "theme.SearchModal.footer.selectKeyAriaLabel": "Nhập khóa", "theme.SearchModal.footer.selectText": "để chọn", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "Không có kết quả dành cho", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "Hãy để chúng tôi biết.", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "Tin rằng truy vấn này sẽ trả về kết quả?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "Thử tìm kiếm", "theme.SearchModal.placeholder": "Tìm kiếm tài liệu", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "Hủy bỏ", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "Xóa truy vấn", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "Yêu thích", "theme.SearchModal.startScreen.noRecentSearchesText": "Không có tìm kiếm nào gần đây", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "Gần đây", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "Xóa tìm kiếm này khỏi danh sách yêu thích", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "Xóa tìm kiếm này khỏi lịch sử", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "Lưu tìm kiếm này", - "theme.SearchPage.algoliaLabel": "Tìm kiếm với Algolia", + "theme.SearchPage.algoliaLabel": "Được cung cấp bởi Algolia", "theme.SearchPage.documentsFound.plurals": "Tìm thấy {count} kết quả", "theme.SearchPage.emptyResultsTitle": "Tìm kiếm", "theme.SearchPage.existingResultsTitle": "Kết quả tìm kiếm cho \"{query}\"", "theme.SearchPage.fetchingNewResults": "Đang tải thêm kết quả...", "theme.SearchPage.inputLabel": "Tìm kiếm", - "theme.SearchPage.inputPlaceholder": "Nhập từ khóa cần tìm vào đây", - "theme.SearchPage.noResultsText": "Không tìm thấy kết quả nào" + "theme.SearchPage.inputPlaceholder": "Nhập tìm kiếm của bạn ở đây", + "theme.SearchPage.noResultsText": "Không tìm thấy kết quả" } diff --git a/packages/docusaurus-theme-translations/locales/zh-Hans/theme-common.json b/packages/docusaurus-theme-translations/locales/zh-Hans/theme-common.json index f9e580a264..0fc0dfd17d 100644 --- a/packages/docusaurus-theme-translations/locales/zh-Hans/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/zh-Hans/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "展开侧边栏分类 '{label}'", "theme.ErrorPageContent.title": "页面已崩溃。", "theme.ErrorPageContent.tryAgain": "重试", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "主导航", "theme.NotFound.p1": "我们找不到您要找的页面。", "theme.NotFound.p2": "请联系原始链接来源网站的所有者,并告知他们链接已损坏。", diff --git a/packages/docusaurus-theme-translations/locales/zh-Hans/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/zh-Hans/theme-search-algolia.json index fb86932938..7f6ac62a23 100644 --- a/packages/docusaurus-theme-translations/locales/zh-Hans/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/zh-Hans/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "搜索", "theme.SearchBar.seeAll": "查看全部 {count} 个结果", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "你可能需要检查网络连接。", "theme.SearchModal.errorScreen.titleText": "无法获取结果", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Esc 键", "theme.SearchModal.footer.closeText": "关闭", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "向下键", @@ -11,25 +24,37 @@ "theme.SearchModal.footer.searchByText": "搜索提供", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter 键", "theme.SearchModal.footer.selectText": "选中", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "没有结果:", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "请告知我们。", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "认为这个查询应该有结果?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "试试搜索", "theme.SearchModal.placeholder": "搜索文档", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "取消", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "清除查询", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "收藏", "theme.SearchModal.startScreen.noRecentSearchesText": "没有最近搜索", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "最近搜索", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "从收藏列表中删除这个搜索", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "从历史记录中删除这个搜索", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "保存这个搜索", - "theme.SearchPage.algoliaLabel": "通过 Algolia 搜索", + "theme.SearchPage.algoliaLabel": "由 Algolia 提供", "theme.SearchPage.documentsFound.plurals": "找到 {count} 份文件", "theme.SearchPage.emptyResultsTitle": "在文档中搜索", "theme.SearchPage.existingResultsTitle": "「{query}」的搜索结果", "theme.SearchPage.fetchingNewResults": "正在获取新的搜索结果...", "theme.SearchPage.inputLabel": "搜索", - "theme.SearchPage.inputPlaceholder": "在此输入搜索字词", - "theme.SearchPage.noResultsText": "未找到任何结果" + "theme.SearchPage.inputPlaceholder": "在此输入搜索词", + "theme.SearchPage.noResultsText": "未找到结果" } diff --git a/packages/docusaurus-theme-translations/locales/zh-Hant/theme-common.json b/packages/docusaurus-theme-translations/locales/zh-Hant/theme-common.json index 1ba88ded27..4ec1bbf99e 100644 --- a/packages/docusaurus-theme-translations/locales/zh-Hant/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/zh-Hant/theme-common.json @@ -9,6 +9,7 @@ "theme.DocSidebarItem.expandCategoryAriaLabel": "展開側邊欄分類 '{label}'", "theme.ErrorPageContent.title": "此頁已當機。", "theme.ErrorPageContent.tryAgain": "重試", + "theme.IconExternalLink.ariaLabel": "(opens in new tab)", "theme.NavBar.navAriaLabel": "主導航", "theme.NotFound.p1": "我們沒有您要找的頁面。", "theme.NotFound.p2": "請聯絡原始連結來源網站的所有者,並通知他們連結已毀損。", diff --git a/packages/docusaurus-theme-translations/locales/zh-Hant/theme-search-algolia.json b/packages/docusaurus-theme-translations/locales/zh-Hant/theme-search-algolia.json index 9e71d66561..4f8bee87df 100644 --- a/packages/docusaurus-theme-translations/locales/zh-Hant/theme-search-algolia.json +++ b/packages/docusaurus-theme-translations/locales/zh-Hant/theme-search-algolia.json @@ -1,8 +1,21 @@ { "theme.SearchBar.label": "搜尋", "theme.SearchBar.seeAll": "查看全部 {count} 個結果", + "theme.SearchModal.askAiScreen.afterToolCallText": "Searched for", + "theme.SearchModal.askAiScreen.copyButtonCopiedText": "Copied!", + "theme.SearchModal.askAiScreen.copyButtonText": "Copy", + "theme.SearchModal.askAiScreen.copyButtonTitle": "Copy", + "theme.SearchModal.askAiScreen.disclaimerText": "Answers are generated with AI which can make mistakes. Verify responses.", + "theme.SearchModal.askAiScreen.dislikeButtonTitle": "Dislike", + "theme.SearchModal.askAiScreen.duringToolCallText": "Searching for ", + "theme.SearchModal.askAiScreen.likeButtonTitle": "Like", + "theme.SearchModal.askAiScreen.preToolCallText": "Searching...", + "theme.SearchModal.askAiScreen.relatedSourcesText": "Related sources", + "theme.SearchModal.askAiScreen.thanksForFeedbackText": "Thanks for your feedback!", + "theme.SearchModal.askAiScreen.thinkingText": "Thinking...", "theme.SearchModal.errorScreen.helpText": "你可能需要檢查網路連線。", "theme.SearchModal.errorScreen.titleText": "無法獲取結果", + "theme.SearchModal.footer.backToSearchText": "Back to search", "theme.SearchModal.footer.closeKeyAriaLabel": "Esc 鍵", "theme.SearchModal.footer.closeText": "關閉", "theme.SearchModal.footer.navigateDownKeyAriaLabel": "向下鍵", @@ -11,25 +24,37 @@ "theme.SearchModal.footer.searchByText": "搜尋提供", "theme.SearchModal.footer.selectKeyAriaLabel": "Enter 鍵", "theme.SearchModal.footer.selectText": "選中", + "theme.SearchModal.footer.submitQuestionText": "Submit question", "theme.SearchModal.noResultsScreen.noResultsText": "沒有結果:", "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": "請告知我們。", "theme.SearchModal.noResultsScreen.reportMissingResultsText": "認為這個查詢應該有結果?", "theme.SearchModal.noResultsScreen.suggestedQueryText": "試試搜尋", "theme.SearchModal.placeholder": "搜尋文檔", + "theme.SearchModal.resultsScreen.askAiPlaceholder": "Ask AI: ", + "theme.SearchModal.searchBox.backToKeywordSearchButtonAriaLabel": "Back to keyword search", + "theme.SearchModal.searchBox.backToKeywordSearchButtonText": "Back to keyword search", "theme.SearchModal.searchBox.cancelButtonText": "取消", + "theme.SearchModal.searchBox.enterKeyHint": "search", + "theme.SearchModal.searchBox.enterKeyHintAskAi": "enter", + "theme.SearchModal.searchBox.placeholderText": "Search docs", + "theme.SearchModal.searchBox.placeholderTextAskAi": "Ask another question...", + "theme.SearchModal.searchBox.placeholderTextAskAiStreaming": "Answering...", "theme.SearchModal.searchBox.resetButtonTitle": "清除查詢", + "theme.SearchModal.searchBox.searchInputLabel": "Search", "theme.SearchModal.startScreen.favoriteSearchesTitle": "收藏", "theme.SearchModal.startScreen.noRecentSearchesText": "沒有最近的搜尋", + "theme.SearchModal.startScreen.recentConversationsTitle": "Recent conversations", "theme.SearchModal.startScreen.recentSearchesTitle": "最近搜尋", "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": "從收藏列表中刪除這個搜尋", + "theme.SearchModal.startScreen.removeRecentConversationButtonTitle": "Remove this conversation from history", "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": "從歷史記錄中刪除這個搜尋", "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": "保存這個搜尋", - "theme.SearchPage.algoliaLabel": "透過 Algolia 搜尋", + "theme.SearchPage.algoliaLabel": "由 Algolia 提供", "theme.SearchPage.documentsFound.plurals": "找到 {count} 份文件", "theme.SearchPage.emptyResultsTitle": "在文件中搜尋", "theme.SearchPage.existingResultsTitle": "「{query}」的搜尋結果", "theme.SearchPage.fetchingNewResults": "正在取得新的搜尋結果...", "theme.SearchPage.inputLabel": "搜尋", - "theme.SearchPage.inputPlaceholder": "在此輸入搜尋字詞", - "theme.SearchPage.noResultsText": "未找到任何結果" + "theme.SearchPage.inputPlaceholder": "在此輸入搜尋詞", + "theme.SearchPage.noResultsText": "未找到結果" } diff --git a/packages/docusaurus-theme-translations/package.json b/packages/docusaurus-theme-translations/package.json index dd6d77946d..fd5f8a515c 100644 --- a/packages/docusaurus-theme-translations/package.json +++ b/packages/docusaurus-theme-translations/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-translations", - "version": "3.8.1", + "version": "3.9.2", "description": "Docusaurus theme translations.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -23,13 +23,13 @@ "tslib": "^2.6.0" }, "devDependencies": { - "@docusaurus/babel": "3.8.1", - "@docusaurus/core": "3.8.1", - "@docusaurus/logger": "3.8.1", - "@docusaurus/utils": "3.8.1", + "@docusaurus/babel": "3.9.2", + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/utils": "3.9.2", "lodash": "^4.17.21" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-tsconfig/package.json b/packages/docusaurus-tsconfig/package.json index 789859431d..d273297725 100644 --- a/packages/docusaurus-tsconfig/package.json +++ b/packages/docusaurus-tsconfig/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/tsconfig", - "version": "3.8.1", + "version": "3.9.2", "description": "Docusaurus base TypeScript configuration.", "main": "tsconfig.json", "publishConfig": { diff --git a/packages/docusaurus-types/package.json b/packages/docusaurus-types/package.json index 6636f2592d..b7705245bc 100644 --- a/packages/docusaurus-types/package.json +++ b/packages/docusaurus-types/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/types", - "version": "3.8.1", + "version": "3.9.2", "description": "Common types for Docusaurus packages.", "types": "./src/index.d.ts", "publishConfig": { diff --git a/packages/docusaurus-types/src/config.d.ts b/packages/docusaurus-types/src/config.d.ts index ec1c8aee7e..bc4180ca7b 100644 --- a/packages/docusaurus-types/src/config.d.ts +++ b/packages/docusaurus-types/src/config.d.ts @@ -33,6 +33,7 @@ export type FasterConfig = { rspackBundler: boolean; rspackPersistentCache: boolean; ssgWorkerThreads: boolean; + gitEagerVcs: boolean; }; export type FutureV4Config = { @@ -40,6 +41,53 @@ export type FutureV4Config = { useCssCascadeLayers: boolean; }; +// VCS (Version Control System) info about a given change, e.g., a git commit. +// The agnostic term "VCS" is used instead of "git" to acknowledge the existence +// of other version control systems, and external systems like CMSs and i18n +// translation SaaS (e.g., Crowdin) +export type VcsChangeInfo = {timestamp: number; author: string}; + +export type VscInitializeParams = { + siteDir: string; + // TODO could it be useful to provide all plugins getPathsToWatch() here? + // this could give the opportunity to find out all VCS roots ahead of times + // this is mostly useful for multi-git-repo setups, can be added later +}; + +// VCS (Version Control System) config hooks to get file change info. +// This lets you override and customize the default Docusaurus behavior. +// This can be useful to optimize calls or when using something else than git +// See https://github.com/facebook/docusaurus/issues/11208 +// See https://github.com/e18e/ecosystem-issues/issues/216 +export type VcsConfig = { + /** + * Initialize the VCS system. + * This is notably useful to pre-read eagerly a full Git repository so that + * all the files first/last update info can be retrieved efficiently later + * + * Note: for now, this function is synchronous on purpose, it can be used to + * start warming up the VCS by reading eagerly, but we don't want to delay + * the rest of the Docusaurus start/build process. Instead of awaiting the + * init promise, you can create/store it and await it later during reads. + * + * @param params Initialization params that can be useful to warm up the VCS + */ + initialize: (params: VscInitializeParams) => void; + getFileCreationInfo: (filePath: string) => Promise; + getFileLastUpdateInfo: (filePath: string) => Promise; +}; + +/** + * List of pre-built VcsConfig that Docusaurus provides. + */ +export type VcsPreset = + | 'git-ad-hoc' + | 'git-eager' + | 'hardcoded' + | 'disabled' + | 'default-v1' + | 'default-v2'; + export type FutureConfig = { /** * Turns v4 future flags on @@ -50,6 +98,8 @@ export type FutureConfig = { experimental_storage: StorageConfig; + experimental_vcs: VcsConfig; + /** * Docusaurus can work with 2 router types. * @@ -367,6 +417,7 @@ export type Config = Overwrite< { v4?: boolean | Partial; experimental_faster?: boolean | Partial; + experimental_vcs?: VcsPreset | VcsConfig | boolean; } >; } diff --git a/packages/docusaurus-types/src/i18n.d.ts b/packages/docusaurus-types/src/i18n.d.ts index ea834788e5..5f1541a5b2 100644 --- a/packages/docusaurus-types/src/i18n.d.ts +++ b/packages/docusaurus-types/src/i18n.d.ts @@ -37,6 +37,25 @@ export type I18nLocaleConfig = { * By default, it will only be run if the `./i18n/` exists. */ translate: boolean; + + /** + * For i18n sites deployed to distinct domains, it is recommended to configure + * a site url on a per-locale basis. + */ + url: string; + + /** + * An explicit baseUrl to use for this locale, overriding the default one: + * Default values: + * - Default locale: `/${siteConfig.baseUrl}/` + * - Other locales: `/${siteConfig.baseUrl}//` + * + * Exception: when using the CLI with a single `--locale` parameter, the + * `//` path segment is not included. This is a better default for + * sites looking to deploy each locale to a different subdomain, such as + * `https://.docusaurus.io` + */ + baseUrl: string; }; export type I18nConfig = { diff --git a/packages/docusaurus-types/src/index.d.ts b/packages/docusaurus-types/src/index.d.ts index d7e61f569d..6d153c387a 100644 --- a/packages/docusaurus-types/src/index.d.ts +++ b/packages/docusaurus-types/src/index.d.ts @@ -13,6 +13,10 @@ export { FutureV4Config, FasterConfig, StorageConfig, + VcsConfig, + VcsPreset, + VcsChangeInfo, + VscInitializeParams, Config, } from './config'; diff --git a/packages/docusaurus-types/src/plugin.d.ts b/packages/docusaurus-types/src/plugin.d.ts index 7d8a91e8a6..25458e9fd8 100644 --- a/packages/docusaurus-types/src/plugin.d.ts +++ b/packages/docusaurus-types/src/plugin.d.ts @@ -104,6 +104,8 @@ export type HtmlTagObject = { tagName: string; /** The inner HTML */ innerHTML?: string; + /** Allow custom html elements, e.g. `` */ + customElement?: boolean; }; export type HtmlTags = string | HtmlTagObject | (string | HtmlTagObject)[]; diff --git a/packages/docusaurus-utils-common/package.json b/packages/docusaurus-utils-common/package.json index a4d9b37692..598a497b1b 100644 --- a/packages/docusaurus-utils-common/package.json +++ b/packages/docusaurus-utils-common/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/utils-common", - "version": "3.8.1", + "version": "3.9.2", "description": "Common (Node/Browser) utility functions for Docusaurus packages.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -19,10 +19,10 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/types": "3.8.1", + "@docusaurus/types": "3.9.2", "tslib": "^2.6.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-utils-validation/package.json b/packages/docusaurus-utils-validation/package.json index faa78bddb5..35c2eda4f2 100644 --- a/packages/docusaurus-utils-validation/package.json +++ b/packages/docusaurus-utils-validation/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/utils-validation", - "version": "3.8.1", + "version": "3.9.2", "description": "Node validation utility functions for Docusaurus packages.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -18,9 +18,9 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-common": "3.8.1", + "@docusaurus/logger": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", "fs-extra": "^11.2.0", "joi": "^17.9.2", "js-yaml": "^4.1.0", @@ -31,6 +31,6 @@ "tmp-promise": "^3.0.3" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus-utils/package.json b/packages/docusaurus-utils/package.json index efcdce2b34..7e775a0117 100644 --- a/packages/docusaurus-utils/package.json +++ b/packages/docusaurus-utils/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/utils", - "version": "3.8.1", + "version": "3.9.2", "description": "Node utility functions for Docusaurus packages.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -18,11 +18,11 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "3.8.1", - "@docusaurus/types": "3.8.1", - "@docusaurus/utils-common": "3.8.1", + "@docusaurus/logger": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-common": "3.9.2", "escape-string-regexp": "^4.0.0", - "execa": "5.1.1", + "execa": "^5.1.1", "file-loader": "^6.2.0", "fs-extra": "^11.1.1", "github-slugger": "^1.5.0", @@ -41,7 +41,7 @@ "webpack": "^5.88.1" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" }, "devDependencies": { "@types/dedent": "^0.7.0", diff --git a/packages/docusaurus-utils/src/__tests__/__fixtures__/simple-site/doc with space.md b/packages/docusaurus-utils/src/__tests__/__fixtures__/simple-site/doc with space.md deleted file mode 100644 index 2b2a616da3..0000000000 --- a/packages/docusaurus-utils/src/__tests__/__fixtures__/simple-site/doc with space.md +++ /dev/null @@ -1 +0,0 @@ -# Hoo hoo, if this path tricks you... diff --git a/packages/docusaurus-utils/src/__tests__/__fixtures__/simple-site/hello.md b/packages/docusaurus-utils/src/__tests__/__fixtures__/simple-site/hello.md deleted file mode 100644 index 38e44ab76c..0000000000 --- a/packages/docusaurus-utils/src/__tests__/__fixtures__/simple-site/hello.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -id: hello -title: Hello, World ! -slug: / ---- - -Hello diff --git a/packages/docusaurus-utils/src/__tests__/gitUtils.test.ts b/packages/docusaurus-utils/src/__tests__/gitUtils.test.ts deleted file mode 100644 index 52d0687f2e..0000000000 --- a/packages/docusaurus-utils/src/__tests__/gitUtils.test.ts +++ /dev/null @@ -1,159 +0,0 @@ -/** - * Copyright (c) Facebook, Inc. and its affiliates. - * - * This source code is licensed under the MIT license found in the - * LICENSE file in the root directory of this source tree. - */ - -import fs from 'fs-extra'; -import path from 'path'; -import {createTempRepo} from '@testing-utils/git'; -import {FileNotTrackedError, getFileCommitDate} from '../gitUtils'; -import {getGitLastUpdate} from '../lastUpdateUtils'; - -/* eslint-disable no-restricted-properties */ -function initializeTempRepo() { - const {repoDir, git} = createTempRepo(); - - fs.writeFileSync(path.join(repoDir, 'test.txt'), 'Some content'); - git.commit( - 'Create test.txt', - '2020-06-19', - 'Caroline ', - ); - fs.writeFileSync(path.join(repoDir, 'test.txt'), 'Updated content'); - git.commit( - 'Update test.txt', - '2020-06-20', - 'Josh-Cena ', - ); - fs.writeFileSync(path.join(repoDir, 'test.txt'), 'Updated content (2)'); - fs.writeFileSync(path.join(repoDir, 'moved.txt'), 'This file is moved'); - git.commit( - 'Update test.txt again, create moved.txt', - '2020-09-13', - 'Caroline ', - ); - fs.moveSync(path.join(repoDir, 'moved.txt'), path.join(repoDir, 'dest.txt')); - git.commit( - 'Rename moved.txt to dest.txt', - '2020-11-13', - 'Josh-Cena ', - ); - fs.writeFileSync(path.join(repoDir, 'untracked.txt'), "I'm untracked"); - - return repoDir; -} - -describe('getFileCommitDate', () => { - const repoDir = initializeTempRepo(); - it('returns earliest commit date', async () => { - await expect( - getFileCommitDate(path.join(repoDir, 'test.txt'), {}), - ).resolves.toEqual({ - date: new Date('2020-06-19'), - timestamp: new Date('2020-06-19').getTime(), - }); - await expect( - getFileCommitDate(path.join(repoDir, 'dest.txt'), {}), - ).resolves.toEqual({ - date: new Date('2020-09-13'), - timestamp: new Date('2020-09-13').getTime(), - }); - }); - it('returns latest commit date', async () => { - await expect( - getFileCommitDate(path.join(repoDir, 'test.txt'), {age: 'newest'}), - ).resolves.toEqual({ - date: new Date('2020-09-13'), - timestamp: new Date('2020-09-13').getTime(), - }); - await expect( - getFileCommitDate(path.join(repoDir, 'dest.txt'), {age: 'newest'}), - ).resolves.toEqual({ - date: new Date('2020-11-13'), - timestamp: new Date('2020-11-13').getTime(), - }); - }); - it('returns latest commit date with author', async () => { - await expect( - getFileCommitDate(path.join(repoDir, 'test.txt'), { - age: 'oldest', - includeAuthor: true, - }), - ).resolves.toEqual({ - date: new Date('2020-06-19'), - timestamp: new Date('2020-06-19').getTime(), - author: 'Caroline', - }); - await expect( - getFileCommitDate(path.join(repoDir, 'dest.txt'), { - age: 'oldest', - includeAuthor: true, - }), - ).resolves.toEqual({ - date: new Date('2020-09-13'), - timestamp: new Date('2020-09-13').getTime(), - author: 'Caroline', - }); - }); - it('returns earliest commit date with author', async () => { - await expect( - getFileCommitDate(path.join(repoDir, 'test.txt'), { - age: 'newest', - includeAuthor: true, - }), - ).resolves.toEqual({ - date: new Date('2020-09-13'), - timestamp: new Date('2020-09-13').getTime(), - author: 'Caroline', - }); - await expect( - getFileCommitDate(path.join(repoDir, 'dest.txt'), { - age: 'newest', - includeAuthor: true, - }), - ).resolves.toEqual({ - date: new Date('2020-11-13'), - timestamp: new Date('2020-11-13').getTime(), - author: 'Josh-Cena', - }); - }); - it('throws custom error when file is not tracked', async () => { - await expect(() => - getFileCommitDate(path.join(repoDir, 'untracked.txt'), { - age: 'newest', - includeAuthor: true, - }), - ).rejects.toThrow(FileNotTrackedError); - }); - it('throws when file not found', async () => { - await expect(() => - getFileCommitDate(path.join(repoDir, 'nonexistent.txt'), { - age: 'newest', - includeAuthor: true, - }), - ).rejects.toThrow( - /Failed to retrieve git history for ".*nonexistent.txt" because the file does not exist./, - ); - }); - - it('multiple files not tracked by git', async () => { - const consoleMock = jest - .spyOn(console, 'warn') - .mockImplementation(() => {}); - const tempFilePath1 = path.join(repoDir, 'file1.md'); - const tempFilePath2 = path.join(repoDir, 'file2.md'); - await fs.writeFile(tempFilePath1, 'Lorem ipsum :)'); - await fs.writeFile(tempFilePath2, 'Lorem ipsum :)'); - // TODO this is not the correct place to test "getGitLastUpdate" - await expect(getGitLastUpdate(tempFilePath1)).resolves.toBeNull(); - await expect(getGitLastUpdate(tempFilePath2)).resolves.toBeNull(); - expect(consoleMock).toHaveBeenCalledTimes(1); - expect(consoleMock).toHaveBeenLastCalledWith( - expect.stringMatching(/not tracked by git./), - ); - await fs.unlink(tempFilePath1); - await fs.unlink(tempFilePath2); - }); -}); diff --git a/packages/docusaurus-utils/src/__tests__/i18nUtils.test.ts b/packages/docusaurus-utils/src/__tests__/i18nUtils.test.ts index 527aa21379..7786001643 100644 --- a/packages/docusaurus-utils/src/__tests__/i18nUtils.test.ts +++ b/packages/docusaurus-utils/src/__tests__/i18nUtils.test.ts @@ -5,12 +5,10 @@ * LICENSE file in the root directory of this source tree. */ -import * as path from 'path'; import { mergeTranslations, updateTranslationFileMessages, getPluginI18nPath, - localizePath, getLocaleConfig, } from '../i18nUtils'; import type {I18n, I18nLocaleConfig} from '@docusaurus/types'; @@ -97,91 +95,6 @@ describe('getPluginI18nPath', () => { }); }); -describe('localizePath', () => { - it('localizes url path with current locale', () => { - expect( - localizePath({ - pathType: 'url', - path: '/baseUrl', - i18n: { - defaultLocale: 'en', - path: 'i18n', - locales: ['en', 'fr'], - currentLocale: 'fr', - localeConfigs: {}, - }, - options: {localizePath: true}, - }), - ).toBe('/baseUrl/fr/'); - }); - - it('localizes fs path with current locale', () => { - expect( - localizePath({ - pathType: 'fs', - path: '/baseFsPath', - i18n: { - defaultLocale: 'en', - path: 'i18n', - locales: ['en', 'fr'], - currentLocale: 'fr', - localeConfigs: {fr: {path: 'fr'}, en: {path: 'en'}}, - }, - options: {localizePath: true}, - }), - ).toBe(`${path.sep}baseFsPath${path.sep}fr`); - }); - - it('localizes path for default locale, if requested', () => { - expect( - localizePath({ - pathType: 'url', - path: '/baseUrl/', - i18n: { - defaultLocale: 'en', - path: 'i18n', - locales: ['en', 'fr'], - currentLocale: 'en', - localeConfigs: {fr: {path: 'fr'}, en: {path: 'en'}}, - }, - options: {localizePath: true}, - }), - ).toBe('/baseUrl/en/'); - }); - - it('does not localize path for default locale by default', () => { - expect( - localizePath({ - pathType: 'url', - path: '/baseUrl/', - i18n: { - defaultLocale: 'en', - path: 'i18n', - locales: ['en', 'fr'], - currentLocale: 'en', - localeConfigs: {fr: {path: 'fr'}, en: {path: 'en'}}, - }, - }), - ).toBe('/baseUrl/'); - }); - - it('localizes path for non-default locale by default', () => { - expect( - localizePath({ - pathType: 'url', - path: '/baseUrl/', - i18n: { - defaultLocale: 'en', - path: 'i18n', - locales: ['en', 'fr'], - currentLocale: 'en', - localeConfigs: {fr: {path: 'fr'}, en: {path: 'en'}}, - }, - }), - ).toBe('/baseUrl/'); - }); -}); - describe('getLocaleConfig', () => { const localeConfigEn: I18nLocaleConfig = { path: 'path', @@ -190,6 +103,7 @@ describe('getLocaleConfig', () => { calendar: 'calendar', label: 'EN', translate: true, + baseUrl: '/', }; const localeConfigFr: I18nLocaleConfig = { path: 'path', @@ -198,6 +112,7 @@ describe('getLocaleConfig', () => { calendar: 'calendar', label: 'FR', translate: true, + baseUrl: '/fr/', }; function i18n(params: Partial): I18n { diff --git a/packages/docusaurus-utils/src/__tests__/lastUpdateUtils.test.ts b/packages/docusaurus-utils/src/__tests__/lastUpdateUtils.test.ts index 3743c4973f..768c9686ff 100644 --- a/packages/docusaurus-utils/src/__tests__/lastUpdateUtils.test.ts +++ b/packages/docusaurus-utils/src/__tests__/lastUpdateUtils.test.ts @@ -5,162 +5,85 @@ * LICENSE file in the root directory of this source tree. */ -import {jest} from '@jest/globals'; -import fs from 'fs-extra'; -import path from 'path'; -import {createTempRepo} from '@testing-utils/git'; -import execa from 'execa'; +import {readLastUpdateData} from '../lastUpdateUtils'; +import {TEST_VCS} from '../vcs/vcs'; -import { - getGitLastUpdate, - LAST_UPDATE_FALLBACK, - LAST_UPDATE_UNTRACKED_GIT_FILEPATH, - readLastUpdateData, -} from '../lastUpdateUtils'; import type {FrontMatterLastUpdate} from '../lastUpdateUtils'; -describe('getGitLastUpdate', () => { - const {repoDir} = createTempRepo(); - - const existingFilePath = path.join( - __dirname, - '__fixtures__/simple-site/hello.md', - ); - it('existing test file in repository with Git timestamp', async () => { - const lastUpdateData = await getGitLastUpdate(existingFilePath); - expect(lastUpdateData).not.toBeNull(); - - const {lastUpdatedAt, lastUpdatedBy} = lastUpdateData!; - expect(lastUpdatedBy).not.toBeNull(); - expect(typeof lastUpdatedBy).toBe('string'); - - expect(lastUpdatedAt).not.toBeNull(); - expect(typeof lastUpdatedAt).toBe('number'); - }); - - it('existing test file with spaces in path', async () => { - const filePathWithSpace = path.join( - __dirname, - '__fixtures__/simple-site/doc with space.md', - ); - const lastUpdateData = await getGitLastUpdate(filePathWithSpace); - expect(lastUpdateData).not.toBeNull(); - - const {lastUpdatedBy, lastUpdatedAt} = lastUpdateData!; - expect(lastUpdatedBy).not.toBeNull(); - expect(typeof lastUpdatedBy).toBe('string'); - - expect(lastUpdatedAt).not.toBeNull(); - expect(typeof lastUpdatedAt).toBe('number'); - }); - - it('non-existing file', async () => { - const consoleMock = jest - .spyOn(console, 'warn') - .mockImplementation(() => {}); - const nonExistingFileName = '.nonExisting'; - const nonExistingFilePath = path.join( - __dirname, - '__fixtures__', - nonExistingFileName, - ); - await expect(getGitLastUpdate(nonExistingFilePath)).rejects.toThrow( - /An error occurred when trying to get the last update date/, - ); - expect(consoleMock).toHaveBeenCalledTimes(0); - consoleMock.mockRestore(); - }); - - it('git does not exist', async () => { - const mock = jest.spyOn(execa, 'sync').mockImplementationOnce(() => { - throw new Error('Git does not exist'); - }); - - const consoleMock = jest - .spyOn(console, 'warn') - .mockImplementation(() => {}); - const lastUpdateData = await getGitLastUpdate(existingFilePath); - expect(lastUpdateData).toBeNull(); - expect(consoleMock).toHaveBeenLastCalledWith( - expect.stringMatching( - /.*\[WARNING\].* Sorry, the last update options require Git\..*/, - ), - ); - - consoleMock.mockRestore(); - mock.mockRestore(); - }); - - it('temporary created file that is not tracked by git', async () => { - const consoleMock = jest - .spyOn(console, 'warn') - .mockImplementation(() => {}); - const tempFilePath = path.join(repoDir, 'file.md'); - await fs.writeFile(tempFilePath, 'Lorem ipsum :)'); - await expect(getGitLastUpdate(tempFilePath)).resolves.toBeNull(); - expect(consoleMock).toHaveBeenCalledTimes(1); - expect(consoleMock).toHaveBeenLastCalledWith( - expect.stringMatching(/not tracked by git./), - ); - await fs.unlink(tempFilePath); - }); -}); - describe('readLastUpdateData', () => { const testDate = '2021-01-01'; const testTimestamp = new Date(testDate).getTime(); const testAuthor = 'ozaki'; + async function readData( + filePath: string, + options: Parameters[1], + lastUpdateFrontMatter: Parameters[2], + ) { + return readLastUpdateData( + filePath, + options, + lastUpdateFrontMatter, + TEST_VCS, + ); + } + describe('on untracked Git file', () => { - function test(lastUpdateFrontMatter: FrontMatterLastUpdate | undefined) { - return readLastUpdateData( - LAST_UPDATE_UNTRACKED_GIT_FILEPATH, + function readUntrackedFile( + lastUpdateFrontMatter: FrontMatterLastUpdate | undefined, + ) { + return readData( + TEST_VCS.UNTRACKED_FILE_PATH, {showLastUpdateAuthor: true, showLastUpdateTime: true}, lastUpdateFrontMatter, ); } it('reads null at/by from Git', async () => { - const {lastUpdatedAt, lastUpdatedBy} = await test({}); + const {lastUpdatedAt, lastUpdatedBy} = await readUntrackedFile({}); expect(lastUpdatedAt).toBeNull(); expect(lastUpdatedBy).toBeNull(); }); it('reads null at from Git and author from front matter', async () => { - const {lastUpdatedAt, lastUpdatedBy} = await test({author: testAuthor}); + const {lastUpdatedAt, lastUpdatedBy} = await readUntrackedFile({ + author: testAuthor, + }); expect(lastUpdatedAt).toBeNull(); expect(lastUpdatedBy).toEqual(testAuthor); }); it('reads null by from Git and date from front matter', async () => { - const {lastUpdatedAt, lastUpdatedBy} = await test({date: testDate}); + const {lastUpdatedAt, lastUpdatedBy} = await readUntrackedFile({ + date: testDate, + }); expect(lastUpdatedBy).toBeNull(); expect(lastUpdatedAt).toEqual(testTimestamp); }); }); it('read last time show author time', async () => { - const {lastUpdatedAt, lastUpdatedBy} = await readLastUpdateData( + const {lastUpdatedAt, lastUpdatedBy} = await readData( '', {showLastUpdateAuthor: true, showLastUpdateTime: true}, {date: testDate}, ); expect(lastUpdatedAt).toEqual(testTimestamp); - expect(lastUpdatedBy).toBe(LAST_UPDATE_FALLBACK.lastUpdatedBy); + expect(lastUpdatedBy).toBe(TEST_VCS.LAST_UPDATE_INFO.author); }); it('read last author show author time', async () => { - const {lastUpdatedAt, lastUpdatedBy} = await readLastUpdateData( + const {lastUpdatedAt, lastUpdatedBy} = await readData( '', {showLastUpdateAuthor: true, showLastUpdateTime: true}, {author: testAuthor}, ); expect(lastUpdatedBy).toEqual(testAuthor); - expect(lastUpdatedAt).toBe(LAST_UPDATE_FALLBACK.lastUpdatedAt); + expect(lastUpdatedAt).toBe(TEST_VCS.LAST_UPDATE_INFO.timestamp); }); it('read last all show author time', async () => { - const {lastUpdatedAt, lastUpdatedBy} = await readLastUpdateData( + const {lastUpdatedAt, lastUpdatedBy} = await readData( '', {showLastUpdateAuthor: true, showLastUpdateTime: true}, {author: testAuthor, date: testDate}, @@ -170,7 +93,7 @@ describe('readLastUpdateData', () => { }); it('read last default show none', async () => { - const lastUpdate = await readLastUpdateData( + const lastUpdate = await readData( '', {showLastUpdateAuthor: false, showLastUpdateTime: false}, {}, @@ -179,7 +102,7 @@ describe('readLastUpdateData', () => { }); it('read last author show none', async () => { - const lastUpdate = await readLastUpdateData( + const lastUpdate = await readData( '', {showLastUpdateAuthor: false, showLastUpdateTime: false}, {author: testAuthor}, @@ -188,17 +111,17 @@ describe('readLastUpdateData', () => { }); it('read last time show author', async () => { - const {lastUpdatedAt, lastUpdatedBy} = await readLastUpdateData( + const {lastUpdatedAt, lastUpdatedBy} = await readData( '', {showLastUpdateAuthor: true, showLastUpdateTime: false}, {date: testDate}, ); - expect(lastUpdatedBy).toBe(LAST_UPDATE_FALLBACK.lastUpdatedBy); + expect(lastUpdatedBy).toBe(TEST_VCS.LAST_UPDATE_INFO.author); expect(lastUpdatedAt).toBeUndefined(); }); it('read last author show author', async () => { - const {lastUpdatedAt, lastUpdatedBy} = await readLastUpdateData( + const {lastUpdatedAt, lastUpdatedBy} = await readData( '', {showLastUpdateAuthor: true, showLastUpdateTime: false}, {author: testAuthor}, @@ -208,17 +131,17 @@ describe('readLastUpdateData', () => { }); it('read last default show author default', async () => { - const {lastUpdatedAt, lastUpdatedBy} = await readLastUpdateData( + const {lastUpdatedAt, lastUpdatedBy} = await readData( '', {showLastUpdateAuthor: true, showLastUpdateTime: false}, {}, ); - expect(lastUpdatedBy).toBe(LAST_UPDATE_FALLBACK.lastUpdatedBy); + expect(lastUpdatedBy).toBe(TEST_VCS.LAST_UPDATE_INFO.author); expect(lastUpdatedAt).toBeUndefined(); }); it('read last time show time', async () => { - const {lastUpdatedAt, lastUpdatedBy} = await readLastUpdateData( + const {lastUpdatedAt, lastUpdatedBy} = await readData( '', {showLastUpdateAuthor: false, showLastUpdateTime: true}, {date: testDate}, @@ -228,17 +151,17 @@ describe('readLastUpdateData', () => { }); it('read last author show time', async () => { - const {lastUpdatedAt, lastUpdatedBy} = await readLastUpdateData( + const {lastUpdatedAt, lastUpdatedBy} = await readData( '', {showLastUpdateAuthor: false, showLastUpdateTime: true}, {author: testAuthor}, ); expect(lastUpdatedBy).toBeUndefined(); - expect(lastUpdatedAt).toEqual(LAST_UPDATE_FALLBACK.lastUpdatedAt); + expect(lastUpdatedAt).toEqual(TEST_VCS.LAST_UPDATE_INFO.timestamp); }); it('read last author show time only - both front matter', async () => { - const {lastUpdatedAt, lastUpdatedBy} = await readLastUpdateData( + const {lastUpdatedAt, lastUpdatedBy} = await readData( '', {showLastUpdateAuthor: false, showLastUpdateTime: true}, {author: testAuthor, date: testDate}, @@ -248,7 +171,7 @@ describe('readLastUpdateData', () => { }); it('read last author show author only - both front matter', async () => { - const {lastUpdatedAt, lastUpdatedBy} = await readLastUpdateData( + const {lastUpdatedAt, lastUpdatedBy} = await readData( '', {showLastUpdateAuthor: true, showLastUpdateTime: false}, {author: testAuthor, date: testDate}, diff --git a/packages/docusaurus-utils/src/__tests__/markdownLinks.test.ts b/packages/docusaurus-utils/src/__tests__/markdownLinks.test.ts index 9a3e0ddfaa..0cf953b5b8 100644 --- a/packages/docusaurus-utils/src/__tests__/markdownLinks.test.ts +++ b/packages/docusaurus-utils/src/__tests__/markdownLinks.test.ts @@ -75,4 +75,60 @@ describe('resolveMarkdownLinkPathname', () => { test('api/classes/divine_uri.URI.md', '/docs/api/classes/uri'); test('another.md', '/docs/another'); }); + + it('uses relative file paths in priority - Fix #11099', () => { + // Unit test to fix bug https://github.com/facebook/docusaurus/issues/11099 + + const context: Context = { + siteDir: '.', + sourceFilePath: 'docs/test/file.mdx', + contentPaths: { + contentPath: 'docs', + contentPathLocalized: 'i18n/docs-localized', + }, + sourceToPermalink: new Map( + Object.entries({ + '@site/docs/file.mdx': '/docs/file', + '@site/docs/test/file.mdx': '/docs/test/file', + }), + ), + }; + + function test(linkPathname: string, expectedOutput: string) { + const output = resolveMarkdownLinkPathname(linkPathname, context); + expect(output).toEqual(expectedOutput); + } + + test('./file.mdx', '/docs/test/file'); + test('file.mdx', '/docs/test/file'); + }); + + it('can resolve @site/ links', () => { + const context: Context = { + siteDir: '.', + sourceFilePath: 'docs/test/file.mdx', + contentPaths: { + contentPath: 'docs', + contentPathLocalized: 'i18n/docs-localized', + }, + sourceToPermalink: new Map( + Object.entries({ + '@site/docs/file.mdx': '/docs/file', + '@site/docs/dir with spaces/file.mdx': '/docs/dir-with-spaces/file', + }), + ), + }; + + function test(linkPathname: string, expectedOutput: string) { + const output = resolveMarkdownLinkPathname(linkPathname, context); + expect(output).toEqual(expectedOutput); + } + + test('@site/docs/file.mdx', '/docs/file'); + test('@site/docs/dir with spaces/file.mdx', '/docs/dir-with-spaces/file'); + test( + '@site/docs/dir%20with%20spaces/file.mdx', + '/docs/dir-with-spaces/file', + ); + }); }); diff --git a/packages/docusaurus-utils/src/gitUtils.ts b/packages/docusaurus-utils/src/gitUtils.ts deleted file mode 100644 index 890c35bd89..0000000000 --- a/packages/docusaurus-utils/src/gitUtils.ts +++ /dev/null @@ -1,200 +0,0 @@ -/** - * Copyright (c) Facebook, Inc. and its affiliates. - * - * This source code is licensed under the MIT license found in the - * LICENSE file in the root directory of this source tree. - */ - -import path from 'path'; -import fs from 'fs-extra'; -import os from 'os'; -import _ from 'lodash'; -import execa from 'execa'; -import PQueue from 'p-queue'; - -// Quite high/conservative concurrency value (it was previously "Infinity") -// See https://github.com/facebook/docusaurus/pull/10915 -const DefaultGitCommandConcurrency = - // TODO Docusaurus v4: bump node, availableParallelism() now always exists - (typeof os.availableParallelism === 'function' - ? os.availableParallelism() - : os.cpus().length) * 4; - -const GitCommandConcurrencyEnv = process.env.DOCUSAURUS_GIT_COMMAND_CONCURRENCY - ? parseInt(process.env.DOCUSAURUS_GIT_COMMAND_CONCURRENCY, 10) - : undefined; - -const GitCommandConcurrency = - GitCommandConcurrencyEnv && GitCommandConcurrencyEnv > 0 - ? GitCommandConcurrencyEnv - : DefaultGitCommandConcurrency; - -// We use a queue to avoid running too many concurrent Git commands at once -// See https://github.com/facebook/docusaurus/issues/10348 -const GitCommandQueue = new PQueue({ - concurrency: GitCommandConcurrency, -}); - -const realHasGitFn = () => { - try { - return execa.sync('git', ['--version']).exitCode === 0; - } catch (error) { - return false; - } -}; - -// The hasGit call is synchronous IO so we memoize it -// The user won't install Git in the middle of a build anyway... -const hasGit = - process.env.NODE_ENV === 'test' ? realHasGitFn : _.memoize(realHasGitFn); - -/** Custom error thrown when git is not found in `PATH`. */ -export class GitNotFoundError extends Error {} - -/** Custom error thrown when the current file is not tracked by git. */ -export class FileNotTrackedError extends Error {} - -/** - * Fetches the git history of a file and returns a relevant commit date. - * It gets the commit date instead of author date so that amended commits - * can have their dates updated. - * - * @throws {@link GitNotFoundError} If git is not found in `PATH`. - * @throws {@link FileNotTrackedError} If the current file is not tracked by git. - * @throws Also throws when `git log` exited with non-zero, or when it outputs - * unexpected text. - */ -export async function getFileCommitDate( - /** Absolute path to the file. */ - file: string, - args: { - /** - * `"oldest"` is the commit that added the file, following renames; - * `"newest"` is the last commit that edited the file. - */ - age?: 'oldest' | 'newest'; - /** Use `includeAuthor: true` to get the author information as well. */ - includeAuthor?: false; - }, -): Promise<{ - /** Relevant commit date. */ - date: Date; - /** Timestamp returned from git, converted to **milliseconds**. */ - timestamp: number; -}>; -/** - * Fetches the git history of a file and returns a relevant commit date. - * It gets the commit date instead of author date so that amended commits - * can have their dates updated. - * - * @throws {@link GitNotFoundError} If git is not found in `PATH`. - * @throws {@link FileNotTrackedError} If the current file is not tracked by git. - * @throws Also throws when `git log` exited with non-zero, or when it outputs - * unexpected text. - */ -export async function getFileCommitDate( - /** Absolute path to the file. */ - file: string, - args: { - /** - * `"oldest"` is the commit that added the file, following renames; - * `"newest"` is the last commit that edited the file. - */ - age?: 'oldest' | 'newest'; - includeAuthor: true; - }, -): Promise<{ - /** Relevant commit date. */ - date: Date; - /** Timestamp returned from git, converted to **milliseconds**. */ - timestamp: number; - /** The author's name, as returned from git. */ - author: string; -}>; - -export async function getFileCommitDate( - file: string, - { - age = 'oldest', - includeAuthor = false, - }: { - age?: 'oldest' | 'newest'; - includeAuthor?: boolean; - }, -): Promise<{ - date: Date; - timestamp: number; - author?: string; -}> { - if (!hasGit()) { - throw new GitNotFoundError( - `Failed to retrieve git history for "${file}" because git is not installed.`, - ); - } - - if (!(await fs.pathExists(file))) { - throw new Error( - `Failed to retrieve git history for "${file}" because the file does not exist.`, - ); - } - - // We add a "RESULT:" prefix to make parsing easier - // See why: https://github.com/facebook/docusaurus/pull/10022 - const resultFormat = includeAuthor ? 'RESULT:%ct,%an' : 'RESULT:%ct'; - - const args = [ - `--format=${resultFormat}`, - '--max-count=1', - age === 'oldest' ? '--follow --diff-filter=A' : undefined, - ] - .filter(Boolean) - .join(' '); - - const command = `git -c log.showSignature=false log ${args} -- "${path.basename( - file, - )}"`; - - const result = (await GitCommandQueue.add(() => { - return execa(command, { - cwd: path.dirname(file), - shell: true, - }); - }))!; - - if (result.exitCode !== 0) { - throw new Error( - `Failed to retrieve the git history for file "${file}" with exit code ${result.exitCode}: ${result.stderr}`, - ); - } - - // We only parse the output line starting with our "RESULT:" prefix - // See why https://github.com/facebook/docusaurus/pull/10022 - const regex = includeAuthor - ? /(?:^|\n)RESULT:(?\d+),(?.+)(?:$|\n)/ - : /(?:^|\n)RESULT:(?\d+)(?:$|\n)/; - - const output = result.stdout.trim(); - - if (!output) { - throw new FileNotTrackedError( - `Failed to retrieve the git history for file "${file}" because the file is not tracked by git.`, - ); - } - - const match = output.match(regex); - - if (!match) { - throw new Error( - `Failed to retrieve the git history for file "${file}" with unexpected output: ${output}`, - ); - } - - const timestampInSeconds = Number(match.groups!.timestamp); - const timestamp = timestampInSeconds * 1_000; - const date = new Date(timestamp); - - if (includeAuthor) { - return {date, timestamp, author: match.groups!.author!}; - } - return {date, timestamp}; -} diff --git a/packages/docusaurus-utils/src/i18nUtils.ts b/packages/docusaurus-utils/src/i18nUtils.ts index 8e7080b962..3c92381521 100644 --- a/packages/docusaurus-utils/src/i18nUtils.ts +++ b/packages/docusaurus-utils/src/i18nUtils.ts @@ -9,7 +9,6 @@ import path from 'path'; import _ from 'lodash'; import logger from '@docusaurus/logger'; import {DEFAULT_PLUGIN_ID} from './constants'; -import {normalizeUrl} from './urlUtils'; import type { TranslationFileContent, TranslationFile, @@ -67,54 +66,6 @@ export function getPluginI18nPath({ ); } -/** - * Takes a path and returns a localized a version (which is basically `path + - * i18n.currentLocale`). - * - * This is used to resolve the `outDir` and `baseUrl` of each locale; it is NOT - * used to determine plugin localization file locations. - */ -export function localizePath({ - pathType, - path: originalPath, - i18n, - options = {}, -}: { - /** - * FS paths will treat Windows specially; URL paths will always have a - * trailing slash to make it a valid base URL. - */ - pathType: 'fs' | 'url'; - /** The path, URL or file path, to be localized. */ - path: string; - /** The current i18n context. */ - i18n: I18n; - options?: { - /** - * By default, we don't localize the path of defaultLocale. This option - * would override that behavior. Setting `false` is useful for `yarn build - * -l zh-Hans` to always emit into the root build directory. - */ - localizePath?: boolean; - }; -}): string { - const shouldLocalizePath: boolean = - options.localizePath ?? i18n.currentLocale !== i18n.defaultLocale; - - if (!shouldLocalizePath) { - return originalPath; - } - // FS paths need special care, for Windows support. Note: we don't use the - // locale config's `path` here, because this function is used for resolving - // outDir, which must be the same as baseUrl. When we have the baseUrl config, - // we need to sync the two. - if (pathType === 'fs') { - return path.join(originalPath, i18n.currentLocale); - } - // Url paths; add a trailing slash so it's a valid base URL - return normalizeUrl([originalPath, i18n.currentLocale, '/']); -} - // TODO we may extract this to a separate package // we want to use it on the frontend too // but "docusaurus-utils-common" (agnostic utils) is not an ideal place since diff --git a/packages/docusaurus-utils/src/index.ts b/packages/docusaurus-utils/src/index.ts index 74b66ca3a9..bd93e1d199 100644 --- a/packages/docusaurus-utils/src/index.ts +++ b/packages/docusaurus-utils/src/index.ts @@ -25,15 +25,16 @@ export { } from './constants'; export {generate, readOutputHTMLFile} from './emitUtils'; export { + // TODO Docusaurus v4: remove these legacy exports, + // they are only kept for retro-compatibility getFileCommitDate, FileNotTrackedError, GitNotFoundError, -} from './gitUtils'; +} from './vcs/gitUtils'; export { mergeTranslations, updateTranslationFileMessages, getPluginI18nPath, - localizePath, getLocaleConfig, } from './i18nUtils'; export {mapAsyncSequential, findAsyncSequential} from './jsUtils'; @@ -122,12 +123,11 @@ export {askPreferredLanguage} from './cliUtils'; export {flattenRoutes} from './routeUtils'; export { - getGitLastUpdate, - getLastUpdate, readLastUpdateData, - LAST_UPDATE_FALLBACK, type LastUpdateData, type FrontMatterLastUpdate, } from './lastUpdateUtils'; +export {VcsPresetNames, getVcsPreset, TEST_VCS} from './vcs/vcs'; + export {normalizeTags, reportInlineTags} from './tags'; diff --git a/packages/docusaurus-utils/src/lastUpdateUtils.ts b/packages/docusaurus-utils/src/lastUpdateUtils.ts index 32c936ee25..8f8acfd437 100644 --- a/packages/docusaurus-utils/src/lastUpdateUtils.ts +++ b/packages/docusaurus-utils/src/lastUpdateUtils.ts @@ -6,13 +6,9 @@ */ import _ from 'lodash'; -import logger from '@docusaurus/logger'; -import { - FileNotTrackedError, - GitNotFoundError, - getFileCommitDate, -} from './gitUtils'; -import type {PluginOptions} from '@docusaurus/types'; +import {getVcsPreset} from './vcs/vcs'; + +import type {PluginOptions, VcsConfig} from '@docusaurus/types'; export type LastUpdateData = { /** @@ -29,72 +25,6 @@ export type LastUpdateData = { lastUpdatedBy: string | undefined | null; }; -let showedGitRequirementError = false; -let showedFileNotTrackedError = false; - -export async function getGitLastUpdate( - filePath: string, -): Promise { - if (!filePath) { - return null; - } - - // Wrap in try/catch in case the shell commands fail - // (e.g. project doesn't use Git, etc). - try { - const result = await getFileCommitDate(filePath, { - age: 'newest', - includeAuthor: true, - }); - - return {lastUpdatedAt: result.timestamp, lastUpdatedBy: result.author}; - } catch (err) { - if (err instanceof GitNotFoundError) { - if (!showedGitRequirementError) { - logger.warn('Sorry, the last update options require Git.'); - showedGitRequirementError = true; - } - } else if (err instanceof FileNotTrackedError) { - if (!showedFileNotTrackedError) { - logger.warn( - 'Cannot infer the update date for some files, as they are not tracked by git.', - ); - showedFileNotTrackedError = true; - } - } else { - throw new Error( - `An error occurred when trying to get the last update date`, - {cause: err}, - ); - } - return null; - } -} - -export const LAST_UPDATE_FALLBACK: LastUpdateData = { - lastUpdatedAt: 1539502055000, - lastUpdatedBy: 'Author', -}; - -// Not proud of this, but convenient for tests :/ -export const LAST_UPDATE_UNTRACKED_GIT_FILEPATH = `file/path/${Math.random()}.mdx`; - -export async function getLastUpdate( - filePath: string, -): Promise { - if (filePath === LAST_UPDATE_UNTRACKED_GIT_FILEPATH) { - return null; - } - if ( - process.env.NODE_ENV !== 'production' || - process.env.DOCUSAURUS_DISABLE_LAST_UPDATE === 'true' - ) { - // Use fake data in dev/test for faster development. - return LAST_UPDATE_FALLBACK; - } - return getGitLastUpdate(filePath); -} - type LastUpdateOptions = Pick< PluginOptions, 'showLastUpdateAuthor' | 'showLastUpdateTime' @@ -109,11 +39,21 @@ export type FrontMatterLastUpdate = { date?: Date | string; }; +// TODO Docusaurus v4: refactor/rename, make it clear this fn is only +// for Markdown files with front matter shared by content plugin export async function readLastUpdateData( filePath: string, options: LastUpdateOptions, lastUpdateFrontMatter: FrontMatterLastUpdate | undefined, + vcsParam: Pick, ): Promise { + // We fallback to the default VSC config at runtime on purpose + // It preserves retro-compatibility if a third-party plugin imports it + // This also ensures unit tests keep working without extra setup + // We still want to ensure type safety by requiring the VCS param + // TODO Docusaurus v4: refactor all these Git read APIs + const vcs = vcsParam ?? getVcsPreset('default-v1'); + const {showLastUpdateAuthor, showLastUpdateTime} = options; if (!showLastUpdateAuthor && !showLastUpdateTime) { @@ -128,14 +68,16 @@ export async function readLastUpdateData( // We try to minimize git last update calls // We call it at most once // If all the data is provided as front matter, we do not call it - const getLastUpdateMemoized = _.memoize(() => getLastUpdate(filePath)); + const getLastUpdateMemoized = _.memoize(() => + vcs.getFileLastUpdateInfo(filePath), + ); const getLastUpdateBy = () => getLastUpdateMemoized().then((update) => { // Important, see https://github.com/facebook/docusaurus/pull/11211 if (update === null) { return null; } - return update?.lastUpdatedBy; + return update?.author; }); const getLastUpdateAt = () => getLastUpdateMemoized().then((update) => { @@ -143,7 +85,7 @@ export async function readLastUpdateData( if (update === null) { return null; } - return update?.lastUpdatedAt; + return update?.timestamp; }); const lastUpdatedBy = showLastUpdateAuthor diff --git a/packages/docusaurus-utils/src/markdownLinks.ts b/packages/docusaurus-utils/src/markdownLinks.ts index a045ab4cd5..5a7ad51495 100644 --- a/packages/docusaurus-utils/src/markdownLinks.ts +++ b/packages/docusaurus-utils/src/markdownLinks.ts @@ -47,9 +47,6 @@ export type SourceToPermalink = Map< string // Permalink: "/docs/content" >; -// Note this is historical logic extracted during a 2024 refactor -// The algo has been kept exactly as before for retro compatibility -// See also https://github.com/facebook/docusaurus/pull/10168 export function resolveMarkdownLinkPathname( linkPathname: string, context: { @@ -60,20 +57,45 @@ export function resolveMarkdownLinkPathname( }, ): string | null { const {sourceFilePath, sourceToPermalink, contentPaths, siteDir} = context; - const sourceDirsToTry: string[] = []; - // ./file.md and ../file.md are always relative to the current file - if (!linkPathname.startsWith('./') && !linkPathname.startsWith('../')) { - sourceDirsToTry.push(...getContentPathList(contentPaths), siteDir); - } - // /file.md is never relative to the source file path - if (!linkPathname.startsWith('/')) { - sourceDirsToTry.push(path.dirname(sourceFilePath)); + + // If the link is already @site aliased, there's no need to resolve it + if (linkPathname.startsWith('@site/')) { + return sourceToPermalink.get(decodeURIComponent(linkPathname)) ?? null; } - const aliasedSourceMatch = sourceDirsToTry + // Get the dirs to "look into", ordered by priority, when resolving the link + function getSourceDirsToTry() { + // /file.md is always resolved from + // - the plugin content paths, + // - then siteDir + if (linkPathname.startsWith('/')) { + return [...getContentPathList(contentPaths), siteDir]; + } + // ./file.md and ../file.md are always resolved from + // - the current file dir + else if (linkPathname.startsWith('./') || linkPathname.startsWith('../')) { + return [path.dirname(sourceFilePath)]; + } + // file.md is resolved from + // - the current file dir, + // - then from the plugin content paths, + // - then siteDir + else { + return [ + path.dirname(sourceFilePath), + ...getContentPathList(contentPaths), + siteDir, + ]; + } + } + + const sourcesToTry = getSourceDirsToTry() .map((sourceDir) => path.join(sourceDir, decodeURIComponent(linkPathname))) - .map((source) => aliasedSitePath(source, siteDir)) - .find((source) => sourceToPermalink.has(source)); + .map((source) => aliasedSitePath(source, siteDir)); + + const aliasedSourceMatch = sourcesToTry.find((source) => + sourceToPermalink.has(source), + ); return aliasedSourceMatch ? sourceToPermalink.get(aliasedSourceMatch) ?? null diff --git a/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/README.md b/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/README.md new file mode 100644 index 0000000000..f7bbbdc9d6 --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/README.md @@ -0,0 +1 @@ +A site fixture with files versioned on Git. \ No newline at end of file diff --git a/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/blog/2025/blog2.md b/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/blog/2025/blog2.md new file mode 100644 index 0000000000..957ede511e --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/blog/2025/blog2.md @@ -0,0 +1 @@ +Blog 2 \ No newline at end of file diff --git a/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/blog/blog1.md b/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/blog/blog1.md new file mode 100644 index 0000000000..3fc60acc30 --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/blog/blog1.md @@ -0,0 +1 @@ +Blog 1 \ No newline at end of file diff --git a/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/docs/_partials/somePartial.md b/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/docs/_partials/somePartial.md new file mode 100644 index 0000000000..9f236098e7 --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/docs/_partials/somePartial.md @@ -0,0 +1,3 @@ +This is a partial in file/folder starting with _: + +It should be excluded by default diff --git a/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/docs/doc with space.md b/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/docs/doc with space.md new file mode 100644 index 0000000000..7d0ae59310 --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/docs/doc with space.md @@ -0,0 +1 @@ +Doc with space in name \ No newline at end of file diff --git a/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/docs/doc1.md b/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/docs/doc1.md new file mode 100644 index 0000000000..81289a604b --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/docs/doc1.md @@ -0,0 +1 @@ +Doc 1 \ No newline at end of file diff --git a/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/docs/doc2.md b/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/docs/doc2.md new file mode 100644 index 0000000000..40675cc092 --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/__tests__/__fixtures__/simple-site/docs/doc2.md @@ -0,0 +1 @@ +Doc 2 \ No newline at end of file diff --git a/packages/docusaurus-utils/src/vcs/__tests__/gitUtils.test.ts b/packages/docusaurus-utils/src/vcs/__tests__/gitUtils.test.ts new file mode 100644 index 0000000000..694a793c50 --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/__tests__/gitUtils.test.ts @@ -0,0 +1,723 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import fs from 'fs-extra'; +import path from 'path'; +import os from 'os'; +import execa from 'execa'; + +import { + FileNotTrackedError, + getFileCommitDate, + getGitLastUpdate, + getGitCreation, + getGitRepoRoot, + getGitSuperProjectRoot, + getGitSubmodulePaths, + getGitAllRepoRoots, + getGitRepositoryFilesInfo, +} from '../gitUtils'; + +class Git { + private constructor(private dir: string) { + this.dir = dir; + } + + private static async runOptimisticGitCommand({ + cwd, + cmd, + args, + options, + }: { + cwd: string; + args: string[]; + cmd: string; + options?: execa.Options; + }): Promise { + const res = await execa(cmd, args, { + cwd, + silent: true, + shell: true, + ...options, + }); + if (res.exitCode !== 0) { + throw new Error( + `Git command failed with code ${res.exitCode}: ${cmd} ${args.join( + ' ', + )}`, + ); + } + return res; + } + + static async initializeRepo(dir: string): Promise { + await Git.runOptimisticGitCommand({ + cmd: 'git', + args: ['init'], + cwd: dir, + }); + await Git.runOptimisticGitCommand({ + cmd: 'git', + args: ['config', 'user.email', '"test@example.com"'], + cwd: dir, + }); + await Git.runOptimisticGitCommand({ + cmd: 'git', + args: ['config', 'user.name', '"Test"'], + cwd: dir, + }); + await Git.runOptimisticGitCommand({ + cmd: 'git', + args: ['commit', '--allow-empty', '-m "First commit"'], + cwd: dir, + }); + return new Git(dir); + } + + async runOptimisticGitCommand( + cmd: string, + args?: string[], + options?: execa.Options, + ): Promise { + return Git.runOptimisticGitCommand({cwd: this.dir, cmd, args, options}); + } + + async add(filePath: string): Promise { + await this.runOptimisticGitCommand('git', ['add', filePath]); + } + async addAll(): Promise { + await this.runOptimisticGitCommand('git', ['add', '.']); + } + + async commit(msg: string, date: string, author: string): Promise { + await this.runOptimisticGitCommand( + `git`, + [ + 'commit', + `-m "${msg}"`, + `--date "${date}T00:00:00Z"`, + `--author "${author}"`, + ], + {env: {GIT_COMMITTER_DATE: `${date}T00:00:00Z`}}, + ); + } + + async commitFile( + filePath: string, + { + fileContent, + commitMessage, + commitDate, + commitAuthor, + }: { + fileContent?: string; + commitMessage?: string; + commitDate?: string; + commitAuthor?: string; + } = {}, + ): Promise { + await fs.ensureDir(path.join(this.dir, path.dirname(filePath))); + await fs.writeFile( + path.join(this.dir, filePath), + fileContent ?? `Content of ${filePath}`, + ); + await this.add(filePath); + await this.commit( + commitMessage ?? `Create ${filePath}`, + commitDate ?? '2020-06-19', + commitAuthor ?? 'Seb ', + ); + } + + async addSubmodule(name: string, repoPath: string): Promise { + return this.runOptimisticGitCommand('git', [ + '-c protocol.file.allow=always', + 'submodule', + 'add', + repoPath, + name, + ]); + } + + async defineSubmodules(submodules: {[name: string]: string}): Promise { + for (const entry of Object.entries(submodules)) { + await this.addSubmodule(entry[0], entry[1]); + } + await this.runOptimisticGitCommand('git', [ + 'submodule', + 'update', + '--init', + '--recursive', + ]); + } +} + +async function createGitRepoEmpty(): Promise<{repoDir: string; git: Git}> { + let repoDir = await fs.mkdtemp(path.join(os.tmpdir(), 'git-test-repo')); + repoDir = await fs.realpath.native(repoDir); + const git = await Git.initializeRepo(repoDir); + return {repoDir, git}; +} + +describe('commit info APIs', () => { + async function createGitRepoTestFixture() { + const {repoDir, git} = await createGitRepoEmpty(); + + await git.commitFile('test.txt', { + fileContent: 'Some content', + commitMessage: 'Create test.txt', + commitDate: '2020-06-19', + commitAuthor: 'Caroline ', + }); + + await git.commitFile('test.txt', { + fileContent: 'Updated content', + commitMessage: 'Update test.txt', + commitDate: '2020-06-20', + commitAuthor: 'Josh-Cena ', + }); + + await fs.writeFile(path.join(repoDir, 'test.txt'), 'Updated content (2)'); + await fs.writeFile(path.join(repoDir, 'moved.txt'), 'This file is moved'); + await git.addAll(); + await git.commit( + 'Update test.txt again, create moved.txt', + '2020-09-13', + 'Robert ', + ); + + await fs.move( + path.join(repoDir, 'moved.txt'), + path.join(repoDir, 'dest.txt'), + ); + await git.addAll(); + await git.commit( + 'Rename moved.txt to dest.txt', + '2020-11-13', + 'Seb ', + ); + + await fs.writeFile(path.join(repoDir, 'untracked.txt'), "I'm untracked"); + + return repoDir; + } + + // Create the repo only once for all tests => faster tests + const repoDirPromise = createGitRepoTestFixture(); + + describe('getFileCommitDate', () => { + it('returns latest commit date with author', async () => { + const repoDir = await repoDirPromise; + + await expect( + getFileCommitDate(path.join(repoDir, 'test.txt'), { + age: 'oldest', + includeAuthor: true, + }), + ).resolves.toEqual({ + date: new Date('2020-06-19'), + timestamp: new Date('2020-06-19').getTime(), + author: 'Caroline', + }); + await expect( + getFileCommitDate(path.join(repoDir, 'dest.txt'), { + age: 'oldest', + includeAuthor: true, + }), + ).resolves.toEqual({ + date: new Date('2020-09-13'), + timestamp: new Date('2020-09-13').getTime(), + author: 'Robert', + }); + }); + + it('returns earliest commit date with author', async () => { + const repoDir = await repoDirPromise; + + await expect( + getFileCommitDate(path.join(repoDir, 'test.txt'), { + age: 'newest', + includeAuthor: true, + }), + ).resolves.toEqual({ + date: new Date('2020-09-13'), + timestamp: new Date('2020-09-13').getTime(), + author: 'Robert', + }); + await expect( + getFileCommitDate(path.join(repoDir, 'dest.txt'), { + age: 'newest', + includeAuthor: true, + }), + ).resolves.toEqual({ + date: new Date('2020-11-13'), + timestamp: new Date('2020-11-13').getTime(), + author: 'Seb', + }); + }); + + it('throws custom error when file is not tracked', async () => { + const repoDir = await repoDirPromise; + + await expect(() => + getFileCommitDate(path.join(repoDir, 'untracked.txt'), { + age: 'newest', + includeAuthor: true, + }), + ).rejects.toThrow(FileNotTrackedError); + }); + + it('throws when file not found', async () => { + const repoDir = await createGitRepoTestFixture(); + + await expect(() => + getFileCommitDate(path.join(repoDir, 'nonexistent.txt'), { + age: 'newest', + includeAuthor: true, + }), + ).rejects.toThrow( + /Failed to retrieve git history for ".*nonexistent.txt" because the file does not exist./, + ); + }); + }); + + describe('commit info APIs', () => { + it('returns creation info for test.txt', async () => { + const repoDir = await repoDirPromise; + + const filePath = path.join(repoDir, 'test.txt'); + await expect(getGitCreation(filePath)).resolves.toEqual({ + author: 'Caroline', + timestamp: new Date('2020-06-19').getTime(), + }); + + await expect(getGitLastUpdate(filePath)).resolves.toEqual({ + author: 'Robert', + timestamp: new Date('2020-09-13').getTime(), + }); + }); + + it('returns creation info for dest.txt', async () => { + const repoDir = await repoDirPromise; + + const filePath = path.join(repoDir, 'dest.txt'); + await expect(getGitCreation(filePath)).resolves.toEqual({ + author: 'Robert', + timestamp: new Date('2020-09-13').getTime(), + }); + await expect(getGitLastUpdate(filePath)).resolves.toEqual({ + author: 'Seb', + timestamp: new Date('2020-11-13').getTime(), + }); + }); + + it('returns creation info for untracked.txt', async () => { + const repoDir = await repoDirPromise; + + const filePath = path.join(repoDir, 'untracked.txt'); + await expect(getGitCreation(filePath)).resolves.toEqual(null); + await expect(getGitLastUpdate(filePath)).resolves.toEqual(null); + }); + + it('returns creation info for non-existing.txt', async () => { + const repoDir = await repoDirPromise; + + const filePath = path.join(repoDir, 'non-existing.txt'); + await expect( + getGitCreation(filePath), + ).rejects.toThrowErrorMatchingInlineSnapshot( + `"An error occurred when trying to get the last update date"`, + ); + await expect( + getGitLastUpdate(filePath), + ).rejects.toThrowErrorMatchingInlineSnapshot( + `"An error occurred when trying to get the last update date"`, + ); + }); + + it('returns files info', async () => { + const repoDir = await repoDirPromise; + + await expect(getGitRepositoryFilesInfo(repoDir)).resolves + .toMatchInlineSnapshot(` + Map { + "dest.txt" => { + "creation": { + "author": "Seb", + "timestamp": 1605225600000, + }, + "lastUpdate": { + "author": "Seb", + "timestamp": 1605225600000, + }, + }, + "moved.txt" => { + "creation": { + "author": "Robert", + "timestamp": 1599955200000, + }, + "lastUpdate": { + "author": "Robert", + "timestamp": 1599955200000, + }, + }, + "test.txt" => { + "creation": { + "author": "Caroline", + "timestamp": 1592524800000, + }, + "lastUpdate": { + "author": "Robert", + "timestamp": 1599955200000, + }, + }, + } + `); + }); + }); +}); + +describe('getGitRepoRoot', () => { + async function initTestRepo() { + const {repoDir, git} = await createGitRepoEmpty(); + await git.commitFile('subDir/test.txt'); + return repoDir; + } + + // Create the repo only once for all tests => faster tests + const repoDirPromise = initTestRepo(); + + it('returns repoDir for cwd=repoDir', async () => { + const repoDir = await repoDirPromise; + const cwd = repoDir; + await expect(getGitRepoRoot(cwd)).resolves.toEqual(repoDir); + }); + + it('returns repoDir for cwd=repoDir/subDir', async () => { + const repoDir = await repoDirPromise; + const cwd = path.join(repoDir, 'subDir'); + await expect(getGitRepoRoot(cwd)).resolves.toEqual(repoDir); + }); + + it('returns Docusaurus repo for cwd=__dirname', async () => { + const cwd = __dirname; + await expect(getGitRepoRoot(cwd)).resolves.toMatch(/docusaurus$/); + }); + + it('rejects for cwd=repoDir/doesNotExist', async () => { + const repoDir = await repoDirPromise; + const cwd = path.join(repoDir, 'doesNotExist'); + await expect(getGitRepoRoot(cwd)).rejects.toThrow( + /Couldn't find the git repository root directory/, + ); + }); +}); + +describe('submodules APIs', () => { + async function initTestRepo() { + const superproject = await createGitRepoEmpty(); + await superproject.git.commitFile('README.md'); + await superproject.git.commitFile('website/docs/myDoc.md'); + + const submodule1 = await createGitRepoEmpty(); + await submodule1.git.commitFile('file1.txt'); + + const submodule2 = await createGitRepoEmpty(); + await submodule2.git.commitFile('subDir/file2.txt'); + + await superproject.git.defineSubmodules({ + 'submodules/submodule1': submodule1.repoDir, + 'submodules/submodule2': submodule2.repoDir, + }); + + return {superproject, submodule1, submodule2}; + } + + // Create the repo only once for all tests => faster tests + const repoPromise = initTestRepo(); + + describe('getGitSuperProjectRoot', () => { + it('returns superproject dir for cwd=superproject', async () => { + const repo = await repoPromise; + const cwd = path.join(repo.superproject.repoDir); + await expect(getGitSuperProjectRoot(cwd)).resolves.toEqual( + repo.superproject.repoDir, + ); + }); + + it('returns superproject dir for cwd=superproject/submodules', async () => { + const repo = await repoPromise; + const cwd = path.join(repo.superproject.repoDir, 'submodules'); + await expect(getGitSuperProjectRoot(cwd)).resolves.toEqual( + repo.superproject.repoDir, + ); + }); + + it('returns superproject dir for cwd=superproject/website/docs', async () => { + const repo = await repoPromise; + const cwd = path.join(repo.superproject.repoDir, 'website/docs'); + await expect(getGitSuperProjectRoot(cwd)).resolves.toEqual( + repo.superproject.repoDir, + ); + }); + + it('returns superproject dir for cwd=submodule1', async () => { + const repo = await repoPromise; + const cwd = path.join(repo.superproject.repoDir, 'submodules/submodule1'); + await expect(getGitSuperProjectRoot(cwd)).resolves.toEqual( + repo.superproject.repoDir, + ); + }); + + it('returns superproject dir for cwd=submodule2', async () => { + const repo = await initTestRepo(); + const cwd = path.join(repo.superproject.repoDir, 'submodules/submodule2'); + await expect(getGitSuperProjectRoot(cwd)).resolves.toEqual( + repo.superproject.repoDir, + ); + }); + + it('returns superproject dir for cwd=submodule2/subDir', async () => { + const repo = await repoPromise; + const cwd = path.join( + repo.superproject.repoDir, + 'submodules/submodule2/subDir', + ); + await expect(getGitSuperProjectRoot(cwd)).resolves.toEqual( + repo.superproject.repoDir, + ); + }); + + it('rejects for cwd of untracked dir', async () => { + const cwd = await os.tmpdir(); + // Do we really want this to throw? + // Not sure, and Git doesn't help us failsafe and return null... + await expect(getGitSuperProjectRoot(cwd)).rejects + .toThrowErrorMatchingInlineSnapshot(` + "Couldn't find the git superproject root directory + Failure while running \`git rev-parse --show-superproject-working-tree\` from cwd="" + The command executed throws an error: Command failed with exit code 128: git rev-parse --show-superproject-working-tree + fatal: not a git repository (or any of the parent directories): .git" + `); + }); + }); + + describe('getGitSubmodulePaths', () => { + it('returns submodules for cwd=superproject', async () => { + const repo = await repoPromise; + const cwd = path.join(repo.superproject.repoDir); + await expect(getGitSubmodulePaths(cwd)).resolves.toEqual([ + 'submodules/submodule1', + 'submodules/submodule2', + ]); + }); + + it('returns submodules for cwd=superproject/website/docs', async () => { + const repo = await repoPromise; + const cwd = path.join(repo.superproject.repoDir, 'website', 'docs'); + await expect(getGitSubmodulePaths(cwd)).resolves.toEqual([ + // The returned paths are relative to CWD, + // Not sure if it's the best behavior. + // But you'd rather call this with the superproject root as CWD anyway! + '../../submodules/submodule1', + '../../submodules/submodule2', + ]); + }); + + it('returns [] for cwd=submodules/submodule1', async () => { + const repo = await repoPromise; + const cwd = path.join( + repo.superproject.repoDir, + 'submodules', + 'submodule1', + ); + await expect(getGitSubmodulePaths(cwd)).resolves.toEqual([]); + }); + + it('returns [] for cwd=submodules/submodule2/subDir', async () => { + const repo = await repoPromise; + const cwd = path.join( + repo.superproject.repoDir, + 'submodules', + 'submodule2', + 'subDir', + ); + await expect(getGitSubmodulePaths(cwd)).resolves.toEqual([]); + }); + + it('rejects for cwd=doesNotExist', async () => { + const repo = await repoPromise; + const cwd = path.join(repo.superproject.repoDir, 'doesNotExist'); + await expect(getGitSubmodulePaths(cwd)).rejects.toThrow( + /Couldn't read the list of git submodules/, + ); + }); + + it('rejects for cwd=notTracked', async () => { + const cwd = await os.tmpdir(); + await expect(getGitSubmodulePaths(cwd)).rejects.toThrow( + /Couldn't read the list of git submodules/, + ); + }); + }); + + describe('getGitAllRepoRoots', () => { + it('returns root paths for cwd=superproject', async () => { + const repo = await repoPromise; + const cwd = path.join(repo.superproject.repoDir); + await expect(getGitAllRepoRoots(cwd)).resolves.toEqual([ + repo.superproject.repoDir, + path.join(repo.superproject.repoDir, 'submodules', 'submodule1'), + path.join(repo.superproject.repoDir, 'submodules', 'submodule2'), + ]); + }); + + it('returns root paths for cwd=superproject/website/docs', async () => { + const repo = await repoPromise; + const cwd = path.join(repo.superproject.repoDir, 'website', 'docs'); + await expect(getGitAllRepoRoots(cwd)).resolves.toEqual([ + repo.superproject.repoDir, + path.join(repo.superproject.repoDir, 'submodules', 'submodule1'), + path.join(repo.superproject.repoDir, 'submodules', 'submodule2'), + ]); + }); + + it('returns root paths for cwd=superproject/submodules', async () => { + const repo = await repoPromise; + const cwd = path.join(repo.superproject.repoDir, 'submodules'); + await expect(getGitAllRepoRoots(cwd)).resolves.toEqual([ + repo.superproject.repoDir, + path.join(repo.superproject.repoDir, 'submodules', 'submodule1'), + path.join(repo.superproject.repoDir, 'submodules', 'submodule2'), + ]); + }); + + it('returns root paths for cwd=superproject/submodules/submodule1', async () => { + const repo = await repoPromise; + const cwd = path.join( + repo.superproject.repoDir, + 'submodules', + 'submodule1', + ); + await expect(getGitAllRepoRoots(cwd)).resolves.toEqual([ + repo.superproject.repoDir, + path.join(repo.superproject.repoDir, 'submodules', 'submodule1'), + path.join(repo.superproject.repoDir, 'submodules', 'submodule2'), + ]); + }); + + it('returns root paths for cwd=superproject/submodules/submodule2/subDir', async () => { + const repo = await repoPromise; + const cwd = path.join( + repo.superproject.repoDir, + 'submodules', + 'submodule2', + 'subDir', + ); + await expect(getGitAllRepoRoots(cwd)).resolves.toEqual([ + repo.superproject.repoDir, + path.join(repo.superproject.repoDir, 'submodules', 'submodule1'), + path.join(repo.superproject.repoDir, 'submodules', 'submodule2'), + ]); + }); + + it('rejects for cwd=doesNotExist', async () => { + const repo = await repoPromise; + const cwd = path.join(repo.superproject.repoDir, 'doesNotExist'); + await expect(getGitAllRepoRoots(cwd)).rejects.toThrow( + /Could not get all the git repository root paths/, + ); + }); + + it('rejects for cwd=notTracked', async () => { + const cwd = await os.tmpdir(); + await expect(getGitAllRepoRoots(cwd)).rejects.toThrow( + /Could not get all the git repository root paths/, + ); + }); + }); + + describe('getGitRepositoryFilesInfo', () => { + it('for superproject', async () => { + const repo = await repoPromise; + const cwd = path.join(repo.superproject.repoDir); + await expect(getGitRepositoryFilesInfo(cwd)).resolves + .toMatchInlineSnapshot(` + Map { + "website/docs/myDoc.md" => { + "creation": { + "author": "Seb", + "timestamp": 1592524800000, + }, + "lastUpdate": { + "author": "Seb", + "timestamp": 1592524800000, + }, + }, + "README.md" => { + "creation": { + "author": "Seb", + "timestamp": 1592524800000, + }, + "lastUpdate": { + "author": "Seb", + "timestamp": 1592524800000, + }, + }, + } + `); + }); + + it('for submodule1', async () => { + const repo = await repoPromise; + const cwd = path.join( + repo.superproject.repoDir, + 'submodules', + 'submodule1', + ); + await expect(getGitRepositoryFilesInfo(cwd)).resolves + .toMatchInlineSnapshot(` + Map { + "file1.txt" => { + "creation": { + "author": "Seb", + "timestamp": 1592524800000, + }, + "lastUpdate": { + "author": "Seb", + "timestamp": 1592524800000, + }, + }, + } + `); + }); + + it('for submodule2', async () => { + const repo = await repoPromise; + const cwd = path.join( + repo.superproject.repoDir, + 'submodules', + 'submodule2', + ); + await expect(getGitRepositoryFilesInfo(cwd)).resolves + .toMatchInlineSnapshot(` + Map { + "subDir/file2.txt" => { + "creation": { + "author": "Seb", + "timestamp": 1592524800000, + }, + "lastUpdate": { + "author": "Seb", + "timestamp": 1592524800000, + }, + }, + } + `); + }); + }); +}); diff --git a/packages/docusaurus-utils/src/vcs/gitUtils.ts b/packages/docusaurus-utils/src/vcs/gitUtils.ts new file mode 100644 index 0000000000..df4db7cf63 --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/gitUtils.ts @@ -0,0 +1,524 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import path from 'path'; +import fs from 'fs-extra'; +import os from 'os'; +import _ from 'lodash'; +import execa from 'execa'; +import PQueue from 'p-queue'; +import logger from '@docusaurus/logger'; + +// Quite high/conservative concurrency value (it was previously "Infinity") +// See https://github.com/facebook/docusaurus/pull/10915 +const DefaultGitCommandConcurrency = + // TODO Docusaurus v4: bump node, availableParallelism() now always exists + (typeof os.availableParallelism === 'function' + ? os.availableParallelism() + : os.cpus().length) * 4; + +const GitCommandConcurrencyEnv = process.env.DOCUSAURUS_GIT_COMMAND_CONCURRENCY + ? parseInt(process.env.DOCUSAURUS_GIT_COMMAND_CONCURRENCY, 10) + : undefined; + +const GitCommandConcurrency = + GitCommandConcurrencyEnv && GitCommandConcurrencyEnv > 0 + ? GitCommandConcurrencyEnv + : DefaultGitCommandConcurrency; + +// We use a queue to avoid running too many concurrent Git commands at once +// See https://github.com/facebook/docusaurus/issues/10348 +const GitCommandQueue = new PQueue({ + concurrency: GitCommandConcurrency, +}); + +const realHasGitFn = () => { + try { + return execa.sync('git', ['--version']).exitCode === 0; + } catch (error) { + return false; + } +}; + +// The hasGit call is synchronous IO so we memoize it +// The user won't install Git in the middle of a build anyway... +const hasGit = + process.env.NODE_ENV === 'test' ? realHasGitFn : _.memoize(realHasGitFn); + +// TODO Docusaurus v4: remove this +// Exceptions are not made for control flow logic +/** Custom error thrown when git is not found in `PATH`. */ +export class GitNotFoundError extends Error {} + +// TODO Docusaurus v4: remove this, only kept for retro-compatibility +// Exceptions are not made for control flow logic +/** Custom error thrown when the current file is not tracked by git. */ +export class FileNotTrackedError extends Error {} + +/** + * Fetches the git history of a file and returns a relevant commit date. + * It gets the commit date instead of author date so that amended commits + * can have their dates updated. + * + * @throws {@link GitNotFoundError} If git is not found in `PATH`. + * @throws {@link FileNotTrackedError} If the current file is not tracked by git. + * @throws Also throws when `git log` exited with non-zero, or when it outputs + * unexpected text. + */ +export async function getFileCommitDate( + /** Absolute path to the file. */ + file: string, + args: { + /** + * `"oldest"` is the commit that added the file, following renames; + * `"newest"` is the last commit that edited the file. + */ + age?: 'oldest' | 'newest'; + /** Use `includeAuthor: true` to get the author information as well. */ + includeAuthor?: false; + }, +): Promise<{ + /** Relevant commit date. */ + date: Date; // TODO duplicate data, not really useful? + /** Timestamp returned from git, converted to **milliseconds**. */ + timestamp: number; +}>; +/** + * Fetches the git history of a file and returns a relevant commit date. + * It gets the commit date instead of author date so that amended commits + * can have their dates updated. + * + * @throws {@link GitNotFoundError} If git is not found in `PATH`. + * @throws {@link FileNotTrackedError} If the current file is not tracked by git. + * @throws Also throws when `git log` exited with non-zero, or when it outputs + * unexpected text. + */ +export async function getFileCommitDate( + /** Absolute path to the file. */ + file: string, + args: { + /** + * `"oldest"` is the commit that added the file, following renames; + * `"newest"` is the last commit that edited the file. + */ + age?: 'oldest' | 'newest'; + includeAuthor: true; + }, +): Promise<{ + /** Relevant commit date. */ + date: Date; + /** Timestamp returned from git, converted to **milliseconds**. */ + timestamp: number; + /** The author's name, as returned from git. */ + author: string; +}>; + +export async function getFileCommitDate( + file: string, + { + age = 'oldest', + includeAuthor = false, + }: { + age?: 'oldest' | 'newest'; + includeAuthor?: boolean; + }, +): Promise<{ + date: Date; + timestamp: number; + author?: string; +}> { + if (!hasGit()) { + throw new GitNotFoundError( + `Failed to retrieve git history for "${file}" because git is not installed.`, + ); + } + + if (!(await fs.pathExists(file))) { + throw new Error( + `Failed to retrieve git history for "${file}" because the file does not exist.`, + ); + } + + // We add a "RESULT:" prefix to make parsing easier + // See why: https://github.com/facebook/docusaurus/pull/10022 + const resultFormat = includeAuthor ? 'RESULT:%ct,%an' : 'RESULT:%ct'; + + const args = [ + `--format=${resultFormat}`, + '--max-count=1', + age === 'oldest' ? '--follow --diff-filter=A' : undefined, + ] + .filter(Boolean) + .join(' '); + + // Do not include GPG signature in the log output + // See https://github.com/facebook/docusaurus/pull/10022 + const command = `git -c log.showSignature=false log ${args} -- "${path.basename( + file, + )}"`; + + const result = (await GitCommandQueue.add(() => { + return execa(command, { + cwd: path.dirname(file), + shell: true, + }); + }))!; + + if (result.exitCode !== 0) { + throw new Error( + `Failed to retrieve the git history for file "${file}" with exit code ${result.exitCode}: ${result.stderr}`, + ); + } + + // We only parse the output line starting with our "RESULT:" prefix + // See why https://github.com/facebook/docusaurus/pull/10022 + const regex = includeAuthor + ? /(?:^|\n)RESULT:(?\d+),(?.+)(?:$|\n)/ + : /(?:^|\n)RESULT:(?\d+)(?:$|\n)/; + + const output = result.stdout.trim(); + + if (!output) { + throw new FileNotTrackedError( + `Failed to retrieve the git history for file "${file}" because the file is not tracked by git.`, + ); + } + + const match = output.match(regex); + + if (!match) { + throw new Error( + `Failed to retrieve the git history for file "${file}" with unexpected output: ${output}`, + ); + } + + const timestampInSeconds = Number(match.groups!.timestamp); + const timestamp = timestampInSeconds * 1_000; + const date = new Date(timestamp); + + if (includeAuthor) { + return {date, timestamp, author: match.groups!.author!}; + } + return {date, timestamp}; +} + +let showedGitRequirementError = false; +let showedFileNotTrackedError = false; + +type GitCommitInfo = {timestamp: number; author: string}; + +async function getGitCommitInfo( + filePath: string, + age: 'oldest' | 'newest', +): Promise { + if (!filePath) { + return null; + } + // Wrap in try/catch in case the shell commands fail + // (e.g. project doesn't use Git, etc). + try { + const result = await getFileCommitDate(filePath, { + age, + includeAuthor: true, + }); + return {timestamp: result.timestamp, author: result.author}; + } catch (err) { + // TODO legacy perf issue: do not use exceptions for control flow! + if (err instanceof GitNotFoundError) { + if (!showedGitRequirementError) { + logger.warn('Sorry, the last update options require Git.'); + showedGitRequirementError = true; + } + } else if (err instanceof FileNotTrackedError) { + if (!showedFileNotTrackedError) { + logger.warn( + 'Cannot infer the update date for some files, as they are not tracked by git.', + ); + showedFileNotTrackedError = true; + } + } else { + throw new Error( + `An error occurred when trying to get the last update date`, + {cause: err}, + ); + } + return null; + } +} + +export async function getGitLastUpdate( + filePath: string, +): Promise { + return getGitCommitInfo(filePath, 'newest'); +} + +export async function getGitCreation( + filePath: string, +): Promise { + return getGitCommitInfo(filePath, 'oldest'); +} + +export async function getGitRepoRoot(cwd: string): Promise { + const createErrorMessageBase = () => { + return `Couldn't find the git repository root directory +Failure while running ${logger.code( + 'git rev-parse --show-toplevel', + )} from cwd=${logger.path(cwd)}`; + }; + + const result = await execa('git', ['rev-parse', '--show-toplevel'], { + cwd, + }).catch((error) => { + // We enter this rejection when cwd is not a dir for example + throw new Error( + `${createErrorMessageBase()} +The command executed throws an error: ${error.message}`, + {cause: error}, + ); + }); + + if (result.exitCode !== 0) { + throw new Error( + `${createErrorMessageBase()} +The command returned exit code ${logger.code(result.exitCode)}: ${logger.subdue( + result.stderr, + )}`, + ); + } + + return fs.realpath.native(result.stdout.trim()); +} + +// A Git "superproject" is a Git repository that contains submodules +// See https://git-scm.com/docs/git-rev-parse#Documentation/git-rev-parse.txt---show-superproject-working-tree +// See https://git-scm.com/book/en/v2/Git-Tools-Submodules +export async function getGitSuperProjectRoot( + cwd: string, +): Promise { + const createErrorMessageBase = () => { + return `Couldn't find the git superproject root directory +Failure while running ${logger.code( + 'git rev-parse --show-superproject-working-tree', + )} from cwd=${logger.path(cwd)}`; + }; + + const result = await execa( + 'git', + ['rev-parse', '--show-superproject-working-tree'], + { + cwd, + }, + ).catch((error) => { + // We enter this rejection when cwd is not a dir for example + throw new Error( + `${createErrorMessageBase()} +The command executed throws an error: ${error.message}`, + {cause: error}, + ); + }); + + if (result.exitCode !== 0) { + throw new Error( + `${createErrorMessageBase()} +The command returned exit code ${logger.code(result.exitCode)}: ${logger.subdue( + result.stderr, + )}`, + ); + } + + const output = result.stdout.trim(); + // this command only works when inside submodules + // otherwise it doesn't return anything when we are inside the main repo + if (output) { + return fs.realpath.native(output); + } + return getGitRepoRoot(cwd); +} + +// See https://git-scm.com/book/en/v2/Git-Tools-Submodules +export async function getGitSubmodulePaths(cwd: string): Promise { + const createErrorMessageBase = () => { + return `Couldn't read the list of git submodules +Failure while running ${logger.code( + 'git submodule status', + )} from cwd=${logger.path(cwd)}`; + }; + + const result = await execa('git', ['submodule', 'status'], { + cwd, + }).catch((error) => { + // We enter this rejection when cwd is not a dir for example + throw new Error( + `${createErrorMessageBase()} +The command executed throws an error: ${error.message}`, + {cause: error}, + ); + }); + + if (result.exitCode !== 0) { + throw new Error( + `${createErrorMessageBase()} +The command returned exit code ${logger.code(result.exitCode)}: ${logger.subdue( + result.stderr, + )}`, + ); + } + + const output = result.stdout.trim(); + + if (!output) { + return []; + } + + /* The output may contain a space/-/+/U prefix, for example + 1234567e3e35d1f5b submodules/foo (heads/main) + -9ab1f1d3a2d77b0a4 submodules/bar (heads/dev) + +f00ba42e1b3ddead submodules/baz (remotes/origin/main) + Udeadbeefcafe1234 submodules/qux + */ + const getSubmodulePath = async (line: string) => { + const submodulePath = line.substring(1).split(' ')[1]; + if (!submodulePath) { + throw new Error(`Failed to parse git submodule line: ${line}`); + } + return submodulePath; + }; + + return Promise.all(output.split('\n').map(getSubmodulePath)); +} + +// Find the root git repository alongside all its submodules, if any +export async function getGitAllRepoRoots(cwd: string): Promise { + try { + const superProjectRoot = await getGitSuperProjectRoot(cwd); + if (!superProjectRoot) { + return []; + } + let submodulePaths = await getGitSubmodulePaths(superProjectRoot); + submodulePaths = await Promise.all( + submodulePaths.map((submodulePath) => + fs.realpath.native(path.resolve(superProjectRoot, submodulePath)), + ), + ); + return [superProjectRoot, ...submodulePaths]; + } catch (error) { + throw new Error( + `Could not get all the git repository root paths (superproject + submodules) from cwd=${cwd}`, + {cause: error}, + ); + } +} + +// Useful information about a file tracked in a Git repository +export type GitFileInfo = { + creation: GitCommitInfo; + lastUpdate: GitCommitInfo; +}; + +// A map of all the files tracked in a Git repository +export type GitFileInfoMap = Map; + +// Logic inspired from Astro Starlight: +// See https://bsky.app/profile/bluwy.me/post/3lyihod6qos2a +// See https://github.com/withastro/starlight/blob/c417f1efd463be63b7230617d72b120caed098cd/packages/starlight/utils/git.ts#L58 +export async function getGitRepositoryFilesInfo( + cwd: string, +): Promise { + // git --no-pager -c log.showSignature=false log --format=t:%ct,a:%an --name-status + const result = await execa( + 'git', + [ + '--no-pager', + // Do not include GPG signature in the log output + // See https://github.com/facebook/docusaurus/pull/10022 + '-c', + 'log.showSignature=false', + // The git command we want to run + 'log', + // Format each history entry as t: + '--format=t:%ct,a:%an', + // In each entry include the name and status for each modified file + '--name-status', + + // For creation info, should we use --follow --find-renames=100% ??? + ], + { + cwd, + encoding: 'utf-8', + // TODO use streaming to avoid a large buffer + // See https://github.com/withastro/starlight/issues/3154 + maxBuffer: 20 * 1024 * 1024, + }, + ); + + if (result.exitCode !== 0) { + throw new Error( + `Docusaurus failed to run the 'git log' to retrieve tracked files last update date/author. +The command exited with code ${result.exitCode}: ${result.stderr}`, + ); + } + + const logLines = result.stdout.split('\n'); + + const now = Date.now(); + + // TODO not fail-fast + let runningDate = now; + let runningAuthor = 'N/A'; + const runningMap: GitFileInfoMap = new Map(); + + for (const logLine of logLines) { + if (logLine.startsWith('t:')) { + // t:,a: + const [timestampStr, authorStr] = logLine.split(',') as [string, string]; + const timestamp = Number.parseInt(timestampStr.slice(2), 10) * 1000; + const author = authorStr.slice(2); + + runningDate = timestamp; + runningAuthor = author; + } + + // TODO the code below doesn't handle delete/move/rename operations properly + // it returns files that no longer exist in the repo (deleted/moved) + + // - Added files take the format `A\t` + // - Modified files take the format `M\t` + // - Deleted files take the format `D\t` + // - Renamed files take the format `R\t\t` + // - Copied files take the format `C\t\t` + // The name of the file as of the commit being processed is always + // the last part of the log line. + const tabSplit = logLine.lastIndexOf('\t'); + if (tabSplit === -1) { + continue; + } + const relativeFile = logLine.slice(tabSplit + 1); + + const currentFileInfo = runningMap.get(relativeFile); + + const currentCreationTime = currentFileInfo?.creation.timestamp || now; + const newCreationTime = Math.min(currentCreationTime, runningDate); + const newCreation: GitCommitInfo = + !currentFileInfo || newCreationTime !== currentCreationTime + ? {timestamp: newCreationTime, author: runningAuthor} + : currentFileInfo.creation; + + const currentLastUpdateTime = currentFileInfo?.lastUpdate.timestamp || 0; + const newLastUpdateTime = Math.max(currentLastUpdateTime, runningDate); + const newLastUpdate: GitCommitInfo = + !currentFileInfo || newLastUpdateTime !== currentLastUpdateTime + ? {timestamp: newLastUpdateTime, author: runningAuthor} + : currentFileInfo.lastUpdate; + + runningMap.set(relativeFile, { + creation: newCreation, + lastUpdate: newLastUpdate, + }); + } + + return runningMap; +} diff --git a/packages/docusaurus-utils/src/vcs/vcs.ts b/packages/docusaurus-utils/src/vcs/vcs.ts new file mode 100644 index 0000000000..2a8b81ddfd --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/vcs.ts @@ -0,0 +1,54 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import { + VCS_HARDCODED_CREATION_INFO, + VCS_HARDCODED_LAST_UPDATE_INFO, + VCS_HARDCODED_UNTRACKED_FILE_PATH, + VcsHardcoded, +} from './vcsHardcoded'; +import {VcsGitAdHoc} from './vcsGitAdHoc'; +import {VscGitEager} from './vcsGitEager'; +import {VcsDisabled} from './vcsDisabled'; +import {VcsDefaultV1} from './vcsDefaultV1'; +import {VcsDefaultV2} from './vcsDefaultV2'; +import type {VcsConfig, VcsPreset} from '@docusaurus/types'; + +const VcsPresets: Record = { + 'git-ad-hoc': VcsGitAdHoc, + 'git-eager': VscGitEager, + hardcoded: VcsHardcoded, + disabled: VcsDisabled, + + 'default-v1': VcsDefaultV1, + 'default-v2': VcsDefaultV2, +}; + +export const VcsPresetNames = Object.keys(VcsPresets) as VcsPreset[]; + +export function findVcsPreset(presetName: string): VcsConfig | undefined { + return VcsPresets[presetName as VcsPreset]; +} + +export function getVcsPreset(presetName: VcsPreset): VcsConfig { + const vcs = findVcsPreset(presetName); + if (vcs) { + return vcs; + } else { + throw new Error( + `Unknown Docusaurus VCS preset name: ${process.env.DOCUSAURUS_VCS}`, + ); + } +} + +// Convenient export for writing unit tests depending on VCS +export const TEST_VCS = { + CREATION_INFO: VCS_HARDCODED_CREATION_INFO, + LAST_UPDATE_INFO: VCS_HARDCODED_LAST_UPDATE_INFO, + UNTRACKED_FILE_PATH: VCS_HARDCODED_UNTRACKED_FILE_PATH, + ...VcsHardcoded, +}; diff --git a/packages/docusaurus-utils/src/vcs/vcsDefaultV1.ts b/packages/docusaurus-utils/src/vcs/vcsDefaultV1.ts new file mode 100644 index 0000000000..431b78fbb1 --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/vcsDefaultV1.ts @@ -0,0 +1,33 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import {VcsHardcoded} from './vcsHardcoded'; +import {VcsGitAdHoc} from './vcsGitAdHoc'; +import type {VcsConfig} from '@docusaurus/types'; + +function getDynamicStrategy(): VcsConfig { + return process.env.NODE_ENV === 'development' || + process.env.NODE_ENV === 'test' + ? VcsHardcoded + : VcsGitAdHoc; +} + +/** + * This VCS implements the historical Git automatic strategy. + * It is only enabled in production mode, using ad-hoc git log commands. + */ +export const VcsDefaultV1: VcsConfig = { + initialize: (...params) => { + return getDynamicStrategy().initialize(...params); + }, + getFileCreationInfo: (...params) => { + return getDynamicStrategy().getFileCreationInfo(...params); + }, + getFileLastUpdateInfo: (...params) => { + return getDynamicStrategy().getFileLastUpdateInfo(...params); + }, +}; diff --git a/packages/docusaurus-utils/src/vcs/vcsDefaultV2.ts b/packages/docusaurus-utils/src/vcs/vcsDefaultV2.ts new file mode 100644 index 0000000000..c946f8d383 --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/vcsDefaultV2.ts @@ -0,0 +1,33 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import {VcsHardcoded} from './vcsHardcoded'; +import {VscGitEager} from './vcsGitEager'; +import type {VcsConfig} from '@docusaurus/types'; + +function getStrategy(): VcsConfig { + return process.env.NODE_ENV === 'development' || + process.env.NODE_ENV === 'test' + ? VcsHardcoded + : VscGitEager; +} + +/** + * This VCS implements the new eager Git automatic strategy. + * It is only enabled in production mode, reading the git repository eagerly. + */ +export const VcsDefaultV2: VcsConfig = { + initialize: (...params) => { + return getStrategy().initialize(...params); + }, + getFileCreationInfo: (...params) => { + return getStrategy().getFileCreationInfo(...params); + }, + getFileLastUpdateInfo: (...params) => { + return getStrategy().getFileLastUpdateInfo(...params); + }, +}; diff --git a/packages/docusaurus-utils/src/vcs/vcsDisabled.ts b/packages/docusaurus-utils/src/vcs/vcsDisabled.ts new file mode 100644 index 0000000000..e8046c2d97 --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/vcsDisabled.ts @@ -0,0 +1,25 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import type {VcsConfig} from '@docusaurus/types'; + +/** + * This VCS implementation always returns null values + */ +export const VcsDisabled: VcsConfig = { + initialize: () => { + // Noop + }, + + getFileCreationInfo: async (_filePath) => { + return null; + }, + + getFileLastUpdateInfo: async (_ilePath) => { + return null; + }, +}; diff --git a/packages/docusaurus-utils/src/vcs/vcsGitAdHoc.ts b/packages/docusaurus-utils/src/vcs/vcsGitAdHoc.ts new file mode 100644 index 0000000000..61c6e592f2 --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/vcsGitAdHoc.ts @@ -0,0 +1,30 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import {getGitLastUpdate, getGitCreation} from './gitUtils'; +import type {VcsConfig} from '@docusaurus/types'; + +/** + * A VCS strategy to query Git information in an ad-hoc way. + * This is the default/historical Docusaurus Git VCS implementation. + * Unfortunately, it is a major bottleneck for large sites/repositories. + * + * See also https://github.com/facebook/docusaurus/issues/11208 + */ +export const VcsGitAdHoc: VcsConfig = { + initialize: () => { + // Nothing to do here for the default/historical Git implementation + }, + + getFileCreationInfo: async (filePath: string) => { + return getGitCreation(filePath); + }, + + getFileLastUpdateInfo: async (filePath: string) => { + return getGitLastUpdate(filePath); + }, +}; diff --git a/packages/docusaurus-utils/src/vcs/vcsGitEager.ts b/packages/docusaurus-utils/src/vcs/vcsGitEager.ts new file mode 100644 index 0000000000..eb691e7f48 --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/vcsGitEager.ts @@ -0,0 +1,99 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import {resolve, basename} from 'node:path'; +import logger, {PerfLogger} from '@docusaurus/logger'; +import {getGitAllRepoRoots, getGitRepositoryFilesInfo} from './gitUtils'; +import type {GitFileInfo, GitFileInfoMap} from './gitUtils'; +import type {VcsConfig} from '@docusaurus/types'; + +// The Map keys should be absolute file paths, not relative Git paths +function resolveFileInfoMapPaths( + repoRoot: string, + filesInfo: GitFileInfoMap, +): GitFileInfoMap { + function transformMapEntry( + entry: [string, GitFileInfo], + ): [string, GitFileInfo] { + // We just resolve the Git paths that are relative to the repo root + return [resolve(repoRoot, entry[0]), entry[1]]; + } + + return new Map(Array.from(filesInfo.entries()).map(transformMapEntry)); +} + +function mergeFileMaps(fileMaps: GitFileInfoMap[]): GitFileInfoMap { + return new Map(fileMaps.flatMap((m) => [...m])); +} + +async function loadAllGitFilesInfoMap(cwd: string): Promise { + const roots = await PerfLogger.async('Reading Git root dirs', () => + getGitAllRepoRoots(cwd), + ); + + const allMaps: GitFileInfoMap[] = await Promise.all( + roots.map(async (root) => { + const map = await PerfLogger.async( + `Reading Git history for repo ${logger.path(basename(root))}`, + () => getGitRepositoryFilesInfo(root), + ); + return resolveFileInfoMapPaths(root, map); + }), + ); + + return mergeFileMaps(allMaps); +} + +function createGitVcsConfig(): VcsConfig { + let filesMapPromise: Promise | null = null; + + async function getGitFileInfo(filePath: string): Promise { + const filesMap = await filesMapPromise; + return filesMap?.get(filePath) ?? null; + } + + return { + initialize: ({siteDir}) => { + if (filesMapPromise) { + // We only initialize this VCS once! + // For i18n sites, this permits reading ahead of time for all locales + // so that it only slows down the first locale + // I assume this logic is fine, but we'll see if it causes trouble + + // Note: we could also only call "initialize()" once from the outside, + // But maybe it could be useful for custom VCS implementations to be + // able to initialize once per locale? + PerfLogger.log( + 'Git Eager VCS strategy already initialized, skipping re-initialization', + ); + return; + } + + filesMapPromise = PerfLogger.async('Git Eager VCS init', () => + loadAllGitFilesInfoMap(siteDir), + ); + filesMapPromise.catch((error) => { + console.error( + 'Failed to initialize the Docusaurus Git Eager VCS strategy', + error, + ); + }); + }, + + getFileCreationInfo: async (filePath: string) => { + const fileInfo = await getGitFileInfo(filePath); + return fileInfo?.creation ?? null; + }, + + getFileLastUpdateInfo: async (filePath: string) => { + const fileInfo = await getGitFileInfo(filePath); + return fileInfo?.lastUpdate ?? null; + }, + }; +} + +export const VscGitEager: VcsConfig = createGitVcsConfig(); diff --git a/packages/docusaurus-utils/src/vcs/vcsHardcoded.ts b/packages/docusaurus-utils/src/vcs/vcsHardcoded.ts new file mode 100644 index 0000000000..c64533a4f2 --- /dev/null +++ b/packages/docusaurus-utils/src/vcs/vcsHardcoded.ts @@ -0,0 +1,45 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import type {VcsConfig, VcsChangeInfo} from '@docusaurus/types'; + +export const VCS_HARDCODED_CREATION_INFO: VcsChangeInfo = { + timestamp: 1490997600000, // 1st Apr 2017 + author: 'Creator', +}; + +export const VCS_HARDCODED_LAST_UPDATE_INFO: VcsChangeInfo = { + timestamp: 1539502055000, // 14th Oct 2018 + author: 'Author', +}; + +export const VCS_HARDCODED_UNTRACKED_FILE_PATH = `file/path/${Math.random()}.mdx`; + +/** + * This VCS implementation always returns hardcoded values for testing purposes. + * It is also useful in dev environments where VCS info is not important. + * Reading information from the VCS can be slow and is not always necessary. + */ +export const VcsHardcoded: VcsConfig = { + initialize: () => { + // Noop + }, + + getFileCreationInfo: async (filePath: string) => { + if (filePath === VCS_HARDCODED_UNTRACKED_FILE_PATH) { + return null; + } + return VCS_HARDCODED_CREATION_INFO; + }, + + getFileLastUpdateInfo: async (filePath: string) => { + if (filePath === VCS_HARDCODED_UNTRACKED_FILE_PATH) { + return null; + } + return VCS_HARDCODED_LAST_UPDATE_INFO; + }, +}; diff --git a/packages/docusaurus/package.json b/packages/docusaurus/package.json index 1f48d810b4..30e26ce7a1 100644 --- a/packages/docusaurus/package.json +++ b/packages/docusaurus/package.json @@ -1,7 +1,7 @@ { "name": "@docusaurus/core", "description": "Easy to Maintain Open Source Documentation Websites", - "version": "3.8.1", + "version": "3.9.2", "license": "MIT", "publishConfig": { "access": "public" @@ -33,13 +33,13 @@ "url": "https://github.com/facebook/docusaurus/issues" }, "dependencies": { - "@docusaurus/babel": "3.8.1", - "@docusaurus/bundler": "3.8.1", - "@docusaurus/logger": "3.8.1", - "@docusaurus/mdx-loader": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-common": "3.8.1", - "@docusaurus/utils-validation": "3.8.1", + "@docusaurus/babel": "3.9.2", + "@docusaurus/bundler": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", "boxen": "^6.2.1", "chalk": "^4.1.2", "chokidar": "^3.5.3", @@ -51,7 +51,7 @@ "escape-html": "^1.0.3", "eta": "^2.2.0", "eval": "^0.1.8", - "execa": "5.1.1", + "execa": "^5.1.1", "fs-extra": "^11.1.1", "html-tags": "^3.3.1", "html-webpack-plugin": "^5.6.0", @@ -73,12 +73,12 @@ "update-notifier": "^6.0.2", "webpack": "^5.95.0", "webpack-bundle-analyzer": "^4.10.2", - "webpack-dev-server": "^4.15.2", + "webpack-dev-server": "^5.2.2", "webpack-merge": "^6.0.1" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.8.1", - "@docusaurus/types": "3.8.1", + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/types": "3.9.2", "@total-typescript/shoehorn": "^0.1.2", "@types/detect-port": "^1.3.3", "@types/react-dom": "^18.2.7", @@ -96,6 +96,6 @@ "react-dom": "^18.0.0 || ^19.0.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/docusaurus/src/client/exports/ComponentCreator.tsx b/packages/docusaurus/src/client/exports/ComponentCreator.tsx index e0664bec5e..48d6640385 100644 --- a/packages/docusaurus/src/client/exports/ComponentCreator.tsx +++ b/packages/docusaurus/src/client/exports/ComponentCreator.tsx @@ -60,7 +60,6 @@ export default function ComponentCreator( Object.entries(flatChunkNames).forEach(([keyPath, chunkName]) => { const chunkRegistry = registry[chunkName]; if (chunkRegistry) { - // eslint-disable-next-line prefer-destructuring loader[keyPath] = chunkRegistry[0]; modules.push(chunkRegistry[1]); optsWebpack.push(chunkRegistry[2]); diff --git a/packages/docusaurus/src/client/exports/__tests__/isInternalUrl.test.ts b/packages/docusaurus/src/client/exports/__tests__/isInternalUrl.test.ts index a914764574..544bc58893 100644 --- a/packages/docusaurus/src/client/exports/__tests__/isInternalUrl.test.ts +++ b/packages/docusaurus/src/client/exports/__tests__/isInternalUrl.test.ts @@ -28,7 +28,7 @@ describe('isInternalUrl', () => { expect(isInternalUrl('https://foo.com')).toBeFalsy(); }); - it('returns false for whatever protocol links', () => { + it('returns false for relative protocol links', () => { expect(isInternalUrl('//foo.com')).toBeFalsy(); }); @@ -43,4 +43,50 @@ describe('isInternalUrl', () => { it('returns false for undefined links', () => { expect(isInternalUrl(undefined)).toBeFalsy(); }); + + describe('custom scheme links', () => { + it('returns true for invalid protocol schemes', () => { + expect(isInternalUrl('+customScheme://')).toBeTruthy(); + expect(isInternalUrl('+customScheme://whatever')).toBeTruthy(); + expect(isInternalUrl('+customScheme:whatever')).toBeTruthy(); + + expect(isInternalUrl('.customScheme://')).toBeTruthy(); + expect(isInternalUrl('.customScheme://whatever')).toBeTruthy(); + expect(isInternalUrl('.customScheme:whatever')).toBeTruthy(); + + expect(isInternalUrl('-customScheme://')).toBeTruthy(); + expect(isInternalUrl('-customScheme://whatever')).toBeTruthy(); + expect(isInternalUrl('-customScheme:whatever')).toBeTruthy(); + + expect(isInternalUrl('custom_scheme://')).toBeTruthy(); + expect(isInternalUrl('custom_scheme://whatever')).toBeTruthy(); + expect(isInternalUrl('custom_scheme:whatever')).toBeTruthy(); + + expect(isInternalUrl('custom scheme://')).toBeTruthy(); + expect(isInternalUrl('custom scheme://whatever')).toBeTruthy(); + expect(isInternalUrl('custom scheme:whatever')).toBeTruthy(); + + expect(isInternalUrl('custom$scheme://')).toBeTruthy(); + expect(isInternalUrl('custom$scheme://whatever')).toBeTruthy(); + expect(isInternalUrl('custom$scheme:whatever')).toBeTruthy(); + }); + + it('returns false valid protocol schemes', () => { + expect(isInternalUrl('customScheme://')).toBeFalsy(); + expect(isInternalUrl('customScheme://whatever')).toBeFalsy(); + expect(isInternalUrl('customScheme:whatever')).toBeFalsy(); + + expect(isInternalUrl('custom-scheme://')).toBeFalsy(); + expect(isInternalUrl('custom-scheme://whatever')).toBeFalsy(); + expect(isInternalUrl('custom-scheme:whatever')).toBeFalsy(); + + expect(isInternalUrl('custom.scheme://')).toBeFalsy(); + expect(isInternalUrl('custom.scheme://whatever')).toBeFalsy(); + expect(isInternalUrl('custom.scheme:whatever')).toBeFalsy(); + + expect(isInternalUrl('custom-sch.eme+-.://')).toBeFalsy(); + expect(isInternalUrl('custom-sch.eme+-.://whatever')).toBeFalsy(); + expect(isInternalUrl('custom-sch.eme+-.:whatever')).toBeFalsy(); + }); + }); }); diff --git a/packages/docusaurus/src/client/exports/isInternalUrl.ts b/packages/docusaurus/src/client/exports/isInternalUrl.ts index 489aff74bc..6335ae003e 100644 --- a/packages/docusaurus/src/client/exports/isInternalUrl.ts +++ b/packages/docusaurus/src/client/exports/isInternalUrl.ts @@ -5,8 +5,11 @@ * LICENSE file in the root directory of this source tree. */ +// Poor man's protocol detection +// Spec: https://datatracker.ietf.org/doc/html/rfc3986#section-3.1 +// In particular: scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) export function hasProtocol(url: string): boolean { - return /^(?:\w*:|\/\/)/.test(url); + return /^(?:[A-Za-z][A-Za-z\d+.-]*:|\/\/)/.test(url); } export default function isInternalUrl(url?: string): boolean { diff --git a/packages/docusaurus/src/commands/build/build.ts b/packages/docusaurus/src/commands/build/build.ts index 4bfea69201..7dfa3f810d 100644 --- a/packages/docusaurus/src/commands/build/build.ts +++ b/packages/docusaurus/src/commands/build/build.ts @@ -8,9 +8,10 @@ import fs from 'fs-extra'; import logger, {PerfLogger} from '@docusaurus/logger'; import {mapAsyncSequential} from '@docusaurus/utils'; -import {loadContext, type LoadContextParams} from '../../server/site'; -import {loadI18n} from '../../server/i18n'; +import {type LoadContextParams} from '../../server/site'; +import {getLocaleList} from '../../server/i18n'; import {buildLocale, type BuildLocaleParams} from './buildLocale'; +import {loadSiteConfig} from '../../server/config'; export type BuildCLIOptions = Pick & { locale?: [string, ...string[]]; @@ -80,28 +81,21 @@ async function getLocalesToBuild({ siteDir: string; cliOptions: BuildCLIOptions; }): Promise<[string, ...string[]]> { - // We disable locale path localization if CLI has single "--locale" option - // yarn build --locale fr => baseUrl=/ instead of baseUrl=/fr/ - const localizePath = cliOptions.locale?.length === 1 ? false : undefined; - - const context = await loadContext({ + const {siteConfig} = await loadSiteConfig({ siteDir, - outDir: cliOptions.outDir, - config: cliOptions.config, - localizePath, + customConfigFilePath: cliOptions.config, }); - const i18n = await loadI18n({ - siteDir, - config: context.siteConfig, - currentLocale: context.siteConfig.i18n.defaultLocale // Awkward but ok - }); - - const locales = cliOptions.locale ?? i18n.locales; + const locales = + cliOptions.locale ?? + getLocaleList({ + i18nConfig: siteConfig.i18n, + currentLocale: siteConfig.i18n.defaultLocale, // Awkward but ok + }); return orderLocales({ locales: locales as [string, ...string[]], - defaultLocale: i18n.defaultLocale, + defaultLocale: siteConfig.i18n.defaultLocale, }); } diff --git a/packages/docusaurus/src/commands/build/buildLocale.ts b/packages/docusaurus/src/commands/build/buildLocale.ts index 33ae8d346e..21175d55af 100644 --- a/packages/docusaurus/src/commands/build/buildLocale.ts +++ b/packages/docusaurus/src/commands/build/buildLocale.ts @@ -27,6 +27,7 @@ import type { import type {SiteCollectedData} from '../../common'; import {BuildCLIOptions} from './build'; import clearPath from '../utils/clearPath'; +import {isAutomaticBaseUrlLocalizationDisabled} from './buildUtils'; export type BuildLocaleParams = { siteDir: string; @@ -35,6 +36,7 @@ export type BuildLocaleParams = { }; const SkipBundling = process.env.DOCUSAURUS_SKIP_BUNDLING === 'true'; +const ReturnAfterLoading = process.env.DOCUSAURUS_RETURN_AFTER_LOADING === 'true'; const ExitAfterLoading = process.env.DOCUSAURUS_EXIT_AFTER_LOADING === 'true'; const ExitAfterBundling = process.env.DOCUSAURUS_EXIT_AFTER_BUNDLING === 'true'; @@ -56,10 +58,13 @@ export async function buildLocale({ outDir: cliOptions.outDir, config: cliOptions.config, locale, - localizePath: cliOptions.locale?.length === 1 ? false : undefined, + automaticBaseUrlLocalizationDisabled: isAutomaticBaseUrlLocalizationDisabled(cliOptions), }), ); + if (ReturnAfterLoading) { + return; + } if (ExitAfterLoading) { return process.exit(0); } diff --git a/packages/docusaurus/src/commands/build/buildUtils.ts b/packages/docusaurus/src/commands/build/buildUtils.ts new file mode 100644 index 0000000000..4421c2646d --- /dev/null +++ b/packages/docusaurus/src/commands/build/buildUtils.ts @@ -0,0 +1,18 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import {BuildCLIOptions} from './build'; + +/** + * We disable locale path localization if CLI has a single "--locale" option + * yarn build --locale fr => baseUrl=/ instead of baseUrl=/fr/ + * By default, this makes it easier to support multi-domain deployments + * See https://docusaurus.io/docs/i18n/tutorial#multi-domain-deployment + */ +export function isAutomaticBaseUrlLocalizationDisabled(cliOptions: BuildCLIOptions) { + return cliOptions.locale?.length === 1; +} diff --git a/packages/docusaurus/src/commands/start/utils.ts b/packages/docusaurus/src/commands/start/utils.ts index 4c2b3fdf15..505c701a7f 100644 --- a/packages/docusaurus/src/commands/start/utils.ts +++ b/packages/docusaurus/src/commands/start/utils.ts @@ -90,7 +90,6 @@ async function createLoadSiteParams({ siteDir, config: cliOptions.config, locale: cliOptions.locale, - localizePath: undefined, // Should this be configurable? }; } diff --git a/packages/docusaurus/src/commands/utils/openBrowser/openBrowser.ts b/packages/docusaurus/src/commands/utils/openBrowser/openBrowser.ts index a0dd2654ce..0660005a73 100644 --- a/packages/docusaurus/src/commands/utils/openBrowser/openBrowser.ts +++ b/packages/docusaurus/src/commands/utils/openBrowser/openBrowser.ts @@ -72,10 +72,16 @@ async function tryOpenWithAppleScript({ '|', )})$"`; - const result = await execPromise(command).catch(() => { - // Ignore grep errors when macOS user has no Chromium-based browser open - // See https://github.com/facebook/docusaurus/issues/11204 - }); + const result = await Promise + // TODO Docusaurus v4: use Promise.try() + // See why here https://github.com/facebook/docusaurus/issues/11204#issuecomment-3073480330 + .resolve() + .then(() => execPromise(command)) + .catch(() => { + // Ignore all errors + // In particular grep errors when macOS user has no Chromium-based browser open + // See https://github.com/facebook/docusaurus/issues/11204 + }); if (!result) { return []; } @@ -89,6 +95,9 @@ async function tryOpenWithAppleScript({ ); } + // Test this manually with: + // osascript ./packages/docusaurus/src/commands/utils/openBrowser/openChrome.applescript "http://localhost:8080" "Google Chrome" + // osascript ./packages/docusaurus/src/commands/utils/openBrowser/openChrome.applescript "http://localhost:8080" "Arc" async function tryBrowser(browserName: string): Promise { try { // This command runs the openChrome.applescript (copied from CRA) diff --git a/packages/docusaurus/src/commands/utils/openBrowser/openChrome.applescript b/packages/docusaurus/src/commands/utils/openBrowser/openChrome.applescript index c1efba1598..6d8e9a85ef 100644 --- a/packages/docusaurus/src/commands/utils/openBrowser/openChrome.applescript +++ b/packages/docusaurus/src/commands/utils/openBrowser/openChrome.applescript @@ -19,6 +19,16 @@ on run argv set theProgram to item 2 of argv end if + -- Arc: simple open + activate, no tab reuse + -- See https://github.com/facebook/docusaurus/issues/11582 + if theProgram is "Arc" then + tell application "Arc" + activate + open location theURL + end tell + return + end if + using terms from application "Google Chrome" tell application theProgram diff --git a/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/docusaurus.config.js b/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/docusaurus.config.js new file mode 100644 index 0000000000..d1f7e5ab01 --- /dev/null +++ b/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/docusaurus.config.js @@ -0,0 +1,38 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +module.exports = { + title: 'Hello', + baseUrl: '/myBaseUrl/', + url: 'https://docusaurus.io', + i18n: { + defaultLocale: 'en', + locales: ['en','fr', 'es', 'de', 'it'], + localeConfigs: { + en: { + baseUrl: '/myBaseUrl/', + }, + fr: { + baseUrl: 'myBaseUrl/fr', + }, + es: { + url: 'https://es.docusaurus.io', + // TODO it's not clear what should be the inferred outDir in this case + baseUrl: 'es', + }, + de: { + // TODO it's not clear what should be the inferred outDir in this case + baseUrl: 'WHATEVER/de', + }, + it: { + url: 'https://it.docusaurus.io', + // TODO it's not clear what should be the inferred outDir in this case + baseUrl: '', + }, + } + } +}; diff --git a/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/docusaurus.config.custom.js b/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/docusaurus.config.custom.js new file mode 100644 index 0000000000..4ab382e3fa --- /dev/null +++ b/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/docusaurus.config.custom.js @@ -0,0 +1,12 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +module.exports = { + title: 'Hello 2', + baseUrl: '/myBaseUrl-2/', + url: 'https://docusaurus.io', +}; diff --git a/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/docusaurus.config.js b/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/docusaurus.config.js new file mode 100644 index 0000000000..ea910cdc86 --- /dev/null +++ b/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/docusaurus.config.js @@ -0,0 +1,12 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +module.exports = { + title: 'Hello', + baseUrl: '/myBaseUrl/', + url: 'https://docusaurus.io', +}; diff --git a/packages/docusaurus/src/server/__tests__/__snapshots__/config.test.ts.snap b/packages/docusaurus/src/server/__tests__/__snapshots__/config.test.ts.snap index b868fc8330..8b0059830b 100644 --- a/packages/docusaurus/src/server/__tests__/__snapshots__/config.test.ts.snap +++ b/packages/docusaurus/src/server/__tests__/__snapshots__/config.test.ts.snap @@ -9,6 +9,7 @@ exports[`loadSiteConfig website with .cjs siteConfig 1`] = ` "customFields": {}, "future": { "experimental_faster": { + "gitEagerVcs": false, "lightningCssMinimizer": false, "mdxCrossCompilerCache": false, "rspackBundler": false, @@ -23,6 +24,11 @@ exports[`loadSiteConfig website with .cjs siteConfig 1`] = ` "namespace": false, "type": "localStorage", }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, "v4": { "removeLegacyPostBuildHeadAttribute": false, "useCssCascadeLayers": false, @@ -88,6 +94,7 @@ exports[`loadSiteConfig website with ts + js config 1`] = ` "customFields": {}, "future": { "experimental_faster": { + "gitEagerVcs": false, "lightningCssMinimizer": false, "mdxCrossCompilerCache": false, "rspackBundler": false, @@ -102,6 +109,11 @@ exports[`loadSiteConfig website with ts + js config 1`] = ` "namespace": false, "type": "localStorage", }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, "v4": { "removeLegacyPostBuildHeadAttribute": false, "useCssCascadeLayers": false, @@ -167,6 +179,7 @@ exports[`loadSiteConfig website with valid JS CJS config 1`] = ` "customFields": {}, "future": { "experimental_faster": { + "gitEagerVcs": false, "lightningCssMinimizer": false, "mdxCrossCompilerCache": false, "rspackBundler": false, @@ -181,6 +194,11 @@ exports[`loadSiteConfig website with valid JS CJS config 1`] = ` "namespace": false, "type": "localStorage", }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, "v4": { "removeLegacyPostBuildHeadAttribute": false, "useCssCascadeLayers": false, @@ -246,6 +264,7 @@ exports[`loadSiteConfig website with valid JS ESM config 1`] = ` "customFields": {}, "future": { "experimental_faster": { + "gitEagerVcs": false, "lightningCssMinimizer": false, "mdxCrossCompilerCache": false, "rspackBundler": false, @@ -260,6 +279,11 @@ exports[`loadSiteConfig website with valid JS ESM config 1`] = ` "namespace": false, "type": "localStorage", }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, "v4": { "removeLegacyPostBuildHeadAttribute": false, "useCssCascadeLayers": false, @@ -325,6 +349,7 @@ exports[`loadSiteConfig website with valid TypeScript CJS config 1`] = ` "customFields": {}, "future": { "experimental_faster": { + "gitEagerVcs": false, "lightningCssMinimizer": false, "mdxCrossCompilerCache": false, "rspackBundler": false, @@ -339,6 +364,11 @@ exports[`loadSiteConfig website with valid TypeScript CJS config 1`] = ` "namespace": false, "type": "localStorage", }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, "v4": { "removeLegacyPostBuildHeadAttribute": false, "useCssCascadeLayers": false, @@ -404,6 +434,7 @@ exports[`loadSiteConfig website with valid TypeScript ESM config 1`] = ` "customFields": {}, "future": { "experimental_faster": { + "gitEagerVcs": false, "lightningCssMinimizer": false, "mdxCrossCompilerCache": false, "rspackBundler": false, @@ -418,6 +449,11 @@ exports[`loadSiteConfig website with valid TypeScript ESM config 1`] = ` "namespace": false, "type": "localStorage", }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, "v4": { "removeLegacyPostBuildHeadAttribute": false, "useCssCascadeLayers": false, @@ -483,6 +519,7 @@ exports[`loadSiteConfig website with valid async config 1`] = ` "customFields": {}, "future": { "experimental_faster": { + "gitEagerVcs": false, "lightningCssMinimizer": false, "mdxCrossCompilerCache": false, "rspackBundler": false, @@ -497,6 +534,11 @@ exports[`loadSiteConfig website with valid async config 1`] = ` "namespace": false, "type": "localStorage", }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, "v4": { "removeLegacyPostBuildHeadAttribute": false, "useCssCascadeLayers": false, @@ -564,6 +606,7 @@ exports[`loadSiteConfig website with valid async config creator function 1`] = ` "customFields": {}, "future": { "experimental_faster": { + "gitEagerVcs": false, "lightningCssMinimizer": false, "mdxCrossCompilerCache": false, "rspackBundler": false, @@ -578,6 +621,11 @@ exports[`loadSiteConfig website with valid async config creator function 1`] = ` "namespace": false, "type": "localStorage", }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, "v4": { "removeLegacyPostBuildHeadAttribute": false, "useCssCascadeLayers": false, @@ -645,6 +693,7 @@ exports[`loadSiteConfig website with valid config creator function 1`] = ` "customFields": {}, "future": { "experimental_faster": { + "gitEagerVcs": false, "lightningCssMinimizer": false, "mdxCrossCompilerCache": false, "rspackBundler": false, @@ -659,6 +708,11 @@ exports[`loadSiteConfig website with valid config creator function 1`] = ` "namespace": false, "type": "localStorage", }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, "v4": { "removeLegacyPostBuildHeadAttribute": false, "useCssCascadeLayers": false, @@ -729,6 +783,7 @@ exports[`loadSiteConfig website with valid siteConfig 1`] = ` "favicon": "img/docusaurus.ico", "future": { "experimental_faster": { + "gitEagerVcs": false, "lightningCssMinimizer": false, "mdxCrossCompilerCache": false, "rspackBundler": false, @@ -743,6 +798,11 @@ exports[`loadSiteConfig website with valid siteConfig 1`] = ` "namespace": false, "type": "localStorage", }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, "v4": { "removeLegacyPostBuildHeadAttribute": false, "useCssCascadeLayers": false, diff --git a/packages/docusaurus/src/server/__tests__/__snapshots__/configValidation.test.ts.snap b/packages/docusaurus/src/server/__tests__/__snapshots__/configValidation.test.ts.snap index d298a46eb8..c1fea8b6ec 100644 --- a/packages/docusaurus/src/server/__tests__/__snapshots__/configValidation.test.ts.snap +++ b/packages/docusaurus/src/server/__tests__/__snapshots__/configValidation.test.ts.snap @@ -1,9 +1,9 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`normalizeConfig throws error for required fields 1`] = ` -""baseUrl" is required +""url" is required +"baseUrl" is required "title" is required -"url" is required "themes" must be an array "presets" must be an array "scripts" must be an array diff --git a/packages/docusaurus/src/server/__tests__/__snapshots__/site.test.ts.snap b/packages/docusaurus/src/server/__tests__/__snapshots__/site.test.ts.snap index 4b335e062b..ab05656a65 100644 --- a/packages/docusaurus/src/server/__tests__/__snapshots__/site.test.ts.snap +++ b/packages/docusaurus/src/server/__tests__/__snapshots__/site.test.ts.snap @@ -1,6 +1,6 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`load loads props for site 1`] = ` +exports[`loadSite custom-i18n-site loads site 1`] = ` { "baseUrl": "/", "codeTranslations": {}, @@ -15,20 +15,24 @@ exports[`load loads props for site 1`] = ` "defaultLocale": "en", "localeConfigs": { "en": { + "baseUrl": "/", "calendar": "gregory", "direction": "ltr", "htmlLang": "en", "label": "English", "path": "en-custom", "translate": false, + "url": "https://example.com", }, "zh-Hans": { + "baseUrl": "/zh-Hans/", "calendar": "gregory", "direction": "ltr", "htmlLang": "zh-Hans", "label": "简体中文", "path": "zh-Hans-custom", "translate": true, + "url": "https://example.com", }, }, "locales": [ @@ -38,7 +42,7 @@ exports[`load loads props for site 1`] = ` "path": "i18n", }, "localizationDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/custom-i18n-site/i18n/en-custom", - "outDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/custom-i18n-site/build", + "outDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/custom-i18n-site/build/", "plugins": [ { "content": undefined, @@ -85,6 +89,7 @@ exports[`load loads props for site 1`] = ` "customFields": {}, "future": { "experimental_faster": { + "gitEagerVcs": false, "lightningCssMinimizer": false, "mdxCrossCompilerCache": false, "rspackBundler": false, @@ -99,6 +104,11 @@ exports[`load loads props for site 1`] = ` "namespace": false, "type": "localStorage", }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, "v4": { "removeLegacyPostBuildHeadAttribute": false, "useCssCascadeLayers": false, @@ -109,11 +119,9 @@ exports[`load loads props for site 1`] = ` "defaultLocale": "en", "localeConfigs": { "en": { - "direction": "ltr", "path": "en-custom", }, "zh-Hans": { - "direction": "ltr", "path": "zh-Hans-custom", }, }, @@ -175,3 +183,2346 @@ exports[`load loads props for site 1`] = ` "siteVersion": undefined, } `; + +exports[`loadSite simple-site-with-baseUrl loads site - custom config 1`] = ` +{ + "baseUrl": "/myBaseUrl-2/", + "codeTranslations": {}, + "currentBundler": { + "instance": [Function], + "name": "webpack", + }, + "generatedFilesDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/.docusaurus", + "headTags": "", + "i18n": { + "currentLocale": "en", + "defaultLocale": "en", + "localeConfigs": { + "en": { + "baseUrl": "/myBaseUrl-2/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "en", + "label": "English", + "path": "en", + "translate": false, + "url": "https://docusaurus.io", + }, + }, + "locales": [ + "en", + ], + "path": "i18n", + }, + "localizationDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/i18n/en", + "outDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/build/", + "plugins": [ + { + "content": undefined, + "defaultCodeTranslations": {}, + "getClientModules": [Function], + "globalData": undefined, + "injectHtmlTags": [Function], + "name": "docusaurus-bootstrap-plugin", + "options": { + "id": "default", + }, + "path": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + { + "configureWebpack": [Function], + "content": undefined, + "defaultCodeTranslations": {}, + "globalData": undefined, + "name": "docusaurus-mdx-fallback-plugin", + "options": { + "id": "default", + }, + "path": ".", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + ], + "postBodyTags": "", + "preBodyTags": "", + "routes": [], + "routesPaths": [ + "/myBaseUrl-2/404.html", + ], + "siteConfig": { + "baseUrl": "/myBaseUrl-2/", + "baseUrlIssueBanner": true, + "clientModules": [], + "customFields": {}, + "future": { + "experimental_faster": { + "gitEagerVcs": false, + "lightningCssMinimizer": false, + "mdxCrossCompilerCache": false, + "rspackBundler": false, + "rspackPersistentCache": false, + "ssgWorkerThreads": false, + "swcHtmlMinimizer": false, + "swcJsLoader": false, + "swcJsMinimizer": false, + }, + "experimental_router": "browser", + "experimental_storage": { + "namespace": false, + "type": "localStorage", + }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, + "v4": { + "removeLegacyPostBuildHeadAttribute": false, + "useCssCascadeLayers": false, + }, + }, + "headTags": [], + "i18n": { + "defaultLocale": "en", + "localeConfigs": {}, + "locales": [ + "en", + ], + "path": "i18n", + }, + "markdown": { + "anchors": { + "maintainCase": false, + }, + "emoji": true, + "format": "mdx", + "hooks": { + "onBrokenMarkdownImages": "throw", + "onBrokenMarkdownLinks": "warn", + }, + "mdx1Compat": { + "admonitions": true, + "comments": true, + "headingIds": true, + }, + "mermaid": false, + "parseFrontMatter": [Function], + "preprocessor": undefined, + "remarkRehypeOptions": undefined, + }, + "noIndex": false, + "onBrokenAnchors": "warn", + "onBrokenLinks": "throw", + "onDuplicateRoutes": "warn", + "plugins": [], + "presets": [], + "scripts": [], + "staticDirectories": [ + "static", + ], + "stylesheets": [], + "tagline": "", + "themeConfig": {}, + "themes": [], + "title": "Hello 2", + "titleDelimiter": "|", + "url": "https://docusaurus.io", + }, + "siteConfigPath": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/docusaurus.config.custom.js", + "siteDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl", + "siteMetadata": { + "docusaurusVersion": "", + "pluginVersions": {}, + "siteVersion": undefined, + }, + "siteStorage": { + "namespace": "", + "type": "localStorage", + }, + "siteVersion": undefined, +} +`; + +exports[`loadSite simple-site-with-baseUrl loads site - custom outDir 1`] = ` +{ + "baseUrl": "/myBaseUrl/", + "codeTranslations": {}, + "currentBundler": { + "instance": [Function], + "name": "webpack", + }, + "generatedFilesDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/.docusaurus", + "headTags": "", + "i18n": { + "currentLocale": "en", + "defaultLocale": "en", + "localeConfigs": { + "en": { + "baseUrl": "/myBaseUrl/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "en", + "label": "English", + "path": "en", + "translate": false, + "url": "https://docusaurus.io", + }, + }, + "locales": [ + "en", + ], + "path": "i18n", + }, + "localizationDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/i18n/en", + "outDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/custom-out-dir/", + "plugins": [ + { + "content": undefined, + "defaultCodeTranslations": {}, + "getClientModules": [Function], + "globalData": undefined, + "injectHtmlTags": [Function], + "name": "docusaurus-bootstrap-plugin", + "options": { + "id": "default", + }, + "path": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + { + "configureWebpack": [Function], + "content": undefined, + "defaultCodeTranslations": {}, + "globalData": undefined, + "name": "docusaurus-mdx-fallback-plugin", + "options": { + "id": "default", + }, + "path": ".", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + ], + "postBodyTags": "", + "preBodyTags": "", + "routes": [], + "routesPaths": [ + "/myBaseUrl/404.html", + ], + "siteConfig": { + "baseUrl": "/myBaseUrl/", + "baseUrlIssueBanner": true, + "clientModules": [], + "customFields": {}, + "future": { + "experimental_faster": { + "gitEagerVcs": false, + "lightningCssMinimizer": false, + "mdxCrossCompilerCache": false, + "rspackBundler": false, + "rspackPersistentCache": false, + "ssgWorkerThreads": false, + "swcHtmlMinimizer": false, + "swcJsLoader": false, + "swcJsMinimizer": false, + }, + "experimental_router": "browser", + "experimental_storage": { + "namespace": false, + "type": "localStorage", + }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, + "v4": { + "removeLegacyPostBuildHeadAttribute": false, + "useCssCascadeLayers": false, + }, + }, + "headTags": [], + "i18n": { + "defaultLocale": "en", + "localeConfigs": {}, + "locales": [ + "en", + ], + "path": "i18n", + }, + "markdown": { + "anchors": { + "maintainCase": false, + }, + "emoji": true, + "format": "mdx", + "hooks": { + "onBrokenMarkdownImages": "throw", + "onBrokenMarkdownLinks": "warn", + }, + "mdx1Compat": { + "admonitions": true, + "comments": true, + "headingIds": true, + }, + "mermaid": false, + "parseFrontMatter": [Function], + "preprocessor": undefined, + "remarkRehypeOptions": undefined, + }, + "noIndex": false, + "onBrokenAnchors": "warn", + "onBrokenLinks": "throw", + "onDuplicateRoutes": "warn", + "plugins": [], + "presets": [], + "scripts": [], + "staticDirectories": [ + "static", + ], + "stylesheets": [], + "tagline": "", + "themeConfig": {}, + "themes": [], + "title": "Hello", + "titleDelimiter": "|", + "url": "https://docusaurus.io", + }, + "siteConfigPath": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/docusaurus.config.js", + "siteDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl", + "siteMetadata": { + "docusaurusVersion": "", + "pluginVersions": {}, + "siteVersion": undefined, + }, + "siteStorage": { + "namespace": "", + "type": "localStorage", + }, + "siteVersion": undefined, +} +`; + +exports[`loadSite simple-site-with-baseUrl loads site 1`] = ` +{ + "baseUrl": "/myBaseUrl/", + "codeTranslations": {}, + "currentBundler": { + "instance": [Function], + "name": "webpack", + }, + "generatedFilesDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/.docusaurus", + "headTags": "", + "i18n": { + "currentLocale": "en", + "defaultLocale": "en", + "localeConfigs": { + "en": { + "baseUrl": "/myBaseUrl/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "en", + "label": "English", + "path": "en", + "translate": false, + "url": "https://docusaurus.io", + }, + }, + "locales": [ + "en", + ], + "path": "i18n", + }, + "localizationDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/i18n/en", + "outDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/build/", + "plugins": [ + { + "content": undefined, + "defaultCodeTranslations": {}, + "getClientModules": [Function], + "globalData": undefined, + "injectHtmlTags": [Function], + "name": "docusaurus-bootstrap-plugin", + "options": { + "id": "default", + }, + "path": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + { + "configureWebpack": [Function], + "content": undefined, + "defaultCodeTranslations": {}, + "globalData": undefined, + "name": "docusaurus-mdx-fallback-plugin", + "options": { + "id": "default", + }, + "path": ".", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + ], + "postBodyTags": "", + "preBodyTags": "", + "routes": [], + "routesPaths": [ + "/myBaseUrl/404.html", + ], + "siteConfig": { + "baseUrl": "/myBaseUrl/", + "baseUrlIssueBanner": true, + "clientModules": [], + "customFields": {}, + "future": { + "experimental_faster": { + "gitEagerVcs": false, + "lightningCssMinimizer": false, + "mdxCrossCompilerCache": false, + "rspackBundler": false, + "rspackPersistentCache": false, + "ssgWorkerThreads": false, + "swcHtmlMinimizer": false, + "swcJsLoader": false, + "swcJsMinimizer": false, + }, + "experimental_router": "browser", + "experimental_storage": { + "namespace": false, + "type": "localStorage", + }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, + "v4": { + "removeLegacyPostBuildHeadAttribute": false, + "useCssCascadeLayers": false, + }, + }, + "headTags": [], + "i18n": { + "defaultLocale": "en", + "localeConfigs": {}, + "locales": [ + "en", + ], + "path": "i18n", + }, + "markdown": { + "anchors": { + "maintainCase": false, + }, + "emoji": true, + "format": "mdx", + "hooks": { + "onBrokenMarkdownImages": "throw", + "onBrokenMarkdownLinks": "warn", + }, + "mdx1Compat": { + "admonitions": true, + "comments": true, + "headingIds": true, + }, + "mermaid": false, + "parseFrontMatter": [Function], + "preprocessor": undefined, + "remarkRehypeOptions": undefined, + }, + "noIndex": false, + "onBrokenAnchors": "warn", + "onBrokenLinks": "throw", + "onDuplicateRoutes": "warn", + "plugins": [], + "presets": [], + "scripts": [], + "staticDirectories": [ + "static", + ], + "stylesheets": [], + "tagline": "", + "themeConfig": {}, + "themes": [], + "title": "Hello", + "titleDelimiter": "|", + "url": "https://docusaurus.io", + }, + "siteConfigPath": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/docusaurus.config.js", + "siteDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl", + "siteMetadata": { + "docusaurusVersion": "", + "pluginVersions": {}, + "siteVersion": undefined, + }, + "siteStorage": { + "namespace": "", + "type": "localStorage", + }, + "siteVersion": undefined, +} +`; + +exports[`loadSite simple-site-with-baseUrl-i18n loads site - locale fr + custom outDir 1`] = ` +{ + "baseUrl": "/myBaseUrl/fr/", + "codeTranslations": {}, + "currentBundler": { + "instance": [Function], + "name": "webpack", + }, + "generatedFilesDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/.docusaurus", + "headTags": "", + "i18n": { + "currentLocale": "fr", + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "de", + "label": "Deutsch", + "path": "de", + "translate": false, + "url": "https://docusaurus.io", + }, + "en": { + "baseUrl": "/myBaseUrl/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "en", + "label": "English", + "path": "en", + "translate": false, + "url": "https://docusaurus.io", + }, + "es": { + "baseUrl": "/es/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "es", + "label": "Español", + "path": "es", + "translate": false, + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "fr", + "label": "Français", + "path": "fr", + "translate": false, + "url": "https://docusaurus.io", + }, + "it": { + "baseUrl": "/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "it", + "label": "Italiano", + "path": "it", + "translate": false, + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "localizationDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/i18n/fr", + "outDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/custom-out-dir/fr/", + "plugins": [ + { + "content": undefined, + "defaultCodeTranslations": {}, + "getClientModules": [Function], + "globalData": undefined, + "injectHtmlTags": [Function], + "name": "docusaurus-bootstrap-plugin", + "options": { + "id": "default", + }, + "path": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + { + "configureWebpack": [Function], + "content": undefined, + "defaultCodeTranslations": {}, + "globalData": undefined, + "name": "docusaurus-mdx-fallback-plugin", + "options": { + "id": "default", + }, + "path": ".", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + ], + "postBodyTags": "", + "preBodyTags": "", + "routes": [], + "routesPaths": [ + "/myBaseUrl/fr/404.html", + ], + "siteConfig": { + "baseUrl": "/myBaseUrl/fr/", + "baseUrlIssueBanner": true, + "clientModules": [], + "customFields": {}, + "future": { + "experimental_faster": { + "gitEagerVcs": false, + "lightningCssMinimizer": false, + "mdxCrossCompilerCache": false, + "rspackBundler": false, + "rspackPersistentCache": false, + "ssgWorkerThreads": false, + "swcHtmlMinimizer": false, + "swcJsLoader": false, + "swcJsMinimizer": false, + }, + "experimental_router": "browser", + "experimental_storage": { + "namespace": false, + "type": "localStorage", + }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, + "v4": { + "removeLegacyPostBuildHeadAttribute": false, + "useCssCascadeLayers": false, + }, + }, + "headTags": [], + "i18n": { + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + }, + "en": { + "baseUrl": "/myBaseUrl/", + }, + "es": { + "baseUrl": "/es/", + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + }, + "it": { + "baseUrl": "/", + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "markdown": { + "anchors": { + "maintainCase": false, + }, + "emoji": true, + "format": "mdx", + "hooks": { + "onBrokenMarkdownImages": "throw", + "onBrokenMarkdownLinks": "warn", + }, + "mdx1Compat": { + "admonitions": true, + "comments": true, + "headingIds": true, + }, + "mermaid": false, + "parseFrontMatter": [Function], + "preprocessor": undefined, + "remarkRehypeOptions": undefined, + }, + "noIndex": false, + "onBrokenAnchors": "warn", + "onBrokenLinks": "throw", + "onDuplicateRoutes": "warn", + "plugins": [], + "presets": [], + "scripts": [], + "staticDirectories": [ + "static", + ], + "stylesheets": [], + "tagline": "", + "themeConfig": {}, + "themes": [], + "title": "Hello", + "titleDelimiter": "|", + "url": "https://docusaurus.io", + }, + "siteConfigPath": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/docusaurus.config.js", + "siteDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "siteMetadata": { + "docusaurusVersion": "", + "pluginVersions": {}, + "siteVersion": undefined, + }, + "siteStorage": { + "namespace": "", + "type": "localStorage", + }, + "siteVersion": undefined, +} +`; + +exports[`loadSite simple-site-with-baseUrl-i18n loads site - custom outDir 1`] = ` +{ + "baseUrl": "/myBaseUrl/", + "codeTranslations": {}, + "currentBundler": { + "instance": [Function], + "name": "webpack", + }, + "generatedFilesDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/.docusaurus", + "headTags": "", + "i18n": { + "currentLocale": "en", + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "de", + "label": "Deutsch", + "path": "de", + "translate": false, + "url": "https://docusaurus.io", + }, + "en": { + "baseUrl": "/myBaseUrl/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "en", + "label": "English", + "path": "en", + "translate": false, + "url": "https://docusaurus.io", + }, + "es": { + "baseUrl": "/es/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "es", + "label": "Español", + "path": "es", + "translate": false, + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "fr", + "label": "Français", + "path": "fr", + "translate": false, + "url": "https://docusaurus.io", + }, + "it": { + "baseUrl": "/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "it", + "label": "Italiano", + "path": "it", + "translate": false, + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "localizationDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/i18n/en", + "outDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/custom-out-dir/", + "plugins": [ + { + "content": undefined, + "defaultCodeTranslations": {}, + "getClientModules": [Function], + "globalData": undefined, + "injectHtmlTags": [Function], + "name": "docusaurus-bootstrap-plugin", + "options": { + "id": "default", + }, + "path": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + { + "configureWebpack": [Function], + "content": undefined, + "defaultCodeTranslations": {}, + "globalData": undefined, + "name": "docusaurus-mdx-fallback-plugin", + "options": { + "id": "default", + }, + "path": ".", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + ], + "postBodyTags": "", + "preBodyTags": "", + "routes": [], + "routesPaths": [ + "/myBaseUrl/404.html", + ], + "siteConfig": { + "baseUrl": "/myBaseUrl/", + "baseUrlIssueBanner": true, + "clientModules": [], + "customFields": {}, + "future": { + "experimental_faster": { + "gitEagerVcs": false, + "lightningCssMinimizer": false, + "mdxCrossCompilerCache": false, + "rspackBundler": false, + "rspackPersistentCache": false, + "ssgWorkerThreads": false, + "swcHtmlMinimizer": false, + "swcJsLoader": false, + "swcJsMinimizer": false, + }, + "experimental_router": "browser", + "experimental_storage": { + "namespace": false, + "type": "localStorage", + }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, + "v4": { + "removeLegacyPostBuildHeadAttribute": false, + "useCssCascadeLayers": false, + }, + }, + "headTags": [], + "i18n": { + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + }, + "en": { + "baseUrl": "/myBaseUrl/", + }, + "es": { + "baseUrl": "/es/", + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + }, + "it": { + "baseUrl": "/", + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "markdown": { + "anchors": { + "maintainCase": false, + }, + "emoji": true, + "format": "mdx", + "hooks": { + "onBrokenMarkdownImages": "throw", + "onBrokenMarkdownLinks": "warn", + }, + "mdx1Compat": { + "admonitions": true, + "comments": true, + "headingIds": true, + }, + "mermaid": false, + "parseFrontMatter": [Function], + "preprocessor": undefined, + "remarkRehypeOptions": undefined, + }, + "noIndex": false, + "onBrokenAnchors": "warn", + "onBrokenLinks": "throw", + "onDuplicateRoutes": "warn", + "plugins": [], + "presets": [], + "scripts": [], + "staticDirectories": [ + "static", + ], + "stylesheets": [], + "tagline": "", + "themeConfig": {}, + "themes": [], + "title": "Hello", + "titleDelimiter": "|", + "url": "https://docusaurus.io", + }, + "siteConfigPath": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/docusaurus.config.js", + "siteDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "siteMetadata": { + "docusaurusVersion": "", + "pluginVersions": {}, + "siteVersion": undefined, + }, + "siteStorage": { + "namespace": "", + "type": "localStorage", + }, + "siteVersion": undefined, +} +`; + +exports[`loadSite simple-site-with-baseUrl-i18n loads site - locale de 1`] = ` +{ + "baseUrl": "/WHATEVER/de/", + "codeTranslations": {}, + "currentBundler": { + "instance": [Function], + "name": "webpack", + }, + "generatedFilesDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/.docusaurus", + "headTags": "", + "i18n": { + "currentLocale": "de", + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "de", + "label": "Deutsch", + "path": "de", + "translate": false, + "url": "https://docusaurus.io", + }, + "en": { + "baseUrl": "/myBaseUrl/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "en", + "label": "English", + "path": "en", + "translate": false, + "url": "https://docusaurus.io", + }, + "es": { + "baseUrl": "/es/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "es", + "label": "Español", + "path": "es", + "translate": false, + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "fr", + "label": "Français", + "path": "fr", + "translate": false, + "url": "https://docusaurus.io", + }, + "it": { + "baseUrl": "/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "it", + "label": "Italiano", + "path": "it", + "translate": false, + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "localizationDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/i18n/de", + "outDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/build/WHATEVER/de/", + "plugins": [ + { + "content": undefined, + "defaultCodeTranslations": {}, + "getClientModules": [Function], + "globalData": undefined, + "injectHtmlTags": [Function], + "name": "docusaurus-bootstrap-plugin", + "options": { + "id": "default", + }, + "path": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + { + "configureWebpack": [Function], + "content": undefined, + "defaultCodeTranslations": {}, + "globalData": undefined, + "name": "docusaurus-mdx-fallback-plugin", + "options": { + "id": "default", + }, + "path": ".", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + ], + "postBodyTags": "", + "preBodyTags": "", + "routes": [], + "routesPaths": [ + "/WHATEVER/de/404.html", + ], + "siteConfig": { + "baseUrl": "/WHATEVER/de/", + "baseUrlIssueBanner": true, + "clientModules": [], + "customFields": {}, + "future": { + "experimental_faster": { + "gitEagerVcs": false, + "lightningCssMinimizer": false, + "mdxCrossCompilerCache": false, + "rspackBundler": false, + "rspackPersistentCache": false, + "ssgWorkerThreads": false, + "swcHtmlMinimizer": false, + "swcJsLoader": false, + "swcJsMinimizer": false, + }, + "experimental_router": "browser", + "experimental_storage": { + "namespace": false, + "type": "localStorage", + }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, + "v4": { + "removeLegacyPostBuildHeadAttribute": false, + "useCssCascadeLayers": false, + }, + }, + "headTags": [], + "i18n": { + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + }, + "en": { + "baseUrl": "/myBaseUrl/", + }, + "es": { + "baseUrl": "/es/", + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + }, + "it": { + "baseUrl": "/", + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "markdown": { + "anchors": { + "maintainCase": false, + }, + "emoji": true, + "format": "mdx", + "hooks": { + "onBrokenMarkdownImages": "throw", + "onBrokenMarkdownLinks": "warn", + }, + "mdx1Compat": { + "admonitions": true, + "comments": true, + "headingIds": true, + }, + "mermaid": false, + "parseFrontMatter": [Function], + "preprocessor": undefined, + "remarkRehypeOptions": undefined, + }, + "noIndex": false, + "onBrokenAnchors": "warn", + "onBrokenLinks": "throw", + "onDuplicateRoutes": "warn", + "plugins": [], + "presets": [], + "scripts": [], + "staticDirectories": [ + "static", + ], + "stylesheets": [], + "tagline": "", + "themeConfig": {}, + "themes": [], + "title": "Hello", + "titleDelimiter": "|", + "url": "https://docusaurus.io", + }, + "siteConfigPath": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/docusaurus.config.js", + "siteDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "siteMetadata": { + "docusaurusVersion": "", + "pluginVersions": {}, + "siteVersion": undefined, + }, + "siteStorage": { + "namespace": "", + "type": "localStorage", + }, + "siteVersion": undefined, +} +`; + +exports[`loadSite simple-site-with-baseUrl-i18n loads site - locale en 1`] = ` +{ + "baseUrl": "/myBaseUrl/", + "codeTranslations": {}, + "currentBundler": { + "instance": [Function], + "name": "webpack", + }, + "generatedFilesDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/.docusaurus", + "headTags": "", + "i18n": { + "currentLocale": "en", + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "de", + "label": "Deutsch", + "path": "de", + "translate": false, + "url": "https://docusaurus.io", + }, + "en": { + "baseUrl": "/myBaseUrl/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "en", + "label": "English", + "path": "en", + "translate": false, + "url": "https://docusaurus.io", + }, + "es": { + "baseUrl": "/es/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "es", + "label": "Español", + "path": "es", + "translate": false, + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "fr", + "label": "Français", + "path": "fr", + "translate": false, + "url": "https://docusaurus.io", + }, + "it": { + "baseUrl": "/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "it", + "label": "Italiano", + "path": "it", + "translate": false, + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "localizationDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/i18n/en", + "outDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/build/", + "plugins": [ + { + "content": undefined, + "defaultCodeTranslations": {}, + "getClientModules": [Function], + "globalData": undefined, + "injectHtmlTags": [Function], + "name": "docusaurus-bootstrap-plugin", + "options": { + "id": "default", + }, + "path": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + { + "configureWebpack": [Function], + "content": undefined, + "defaultCodeTranslations": {}, + "globalData": undefined, + "name": "docusaurus-mdx-fallback-plugin", + "options": { + "id": "default", + }, + "path": ".", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + ], + "postBodyTags": "", + "preBodyTags": "", + "routes": [], + "routesPaths": [ + "/myBaseUrl/404.html", + ], + "siteConfig": { + "baseUrl": "/myBaseUrl/", + "baseUrlIssueBanner": true, + "clientModules": [], + "customFields": {}, + "future": { + "experimental_faster": { + "gitEagerVcs": false, + "lightningCssMinimizer": false, + "mdxCrossCompilerCache": false, + "rspackBundler": false, + "rspackPersistentCache": false, + "ssgWorkerThreads": false, + "swcHtmlMinimizer": false, + "swcJsLoader": false, + "swcJsMinimizer": false, + }, + "experimental_router": "browser", + "experimental_storage": { + "namespace": false, + "type": "localStorage", + }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, + "v4": { + "removeLegacyPostBuildHeadAttribute": false, + "useCssCascadeLayers": false, + }, + }, + "headTags": [], + "i18n": { + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + }, + "en": { + "baseUrl": "/myBaseUrl/", + }, + "es": { + "baseUrl": "/es/", + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + }, + "it": { + "baseUrl": "/", + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "markdown": { + "anchors": { + "maintainCase": false, + }, + "emoji": true, + "format": "mdx", + "hooks": { + "onBrokenMarkdownImages": "throw", + "onBrokenMarkdownLinks": "warn", + }, + "mdx1Compat": { + "admonitions": true, + "comments": true, + "headingIds": true, + }, + "mermaid": false, + "parseFrontMatter": [Function], + "preprocessor": undefined, + "remarkRehypeOptions": undefined, + }, + "noIndex": false, + "onBrokenAnchors": "warn", + "onBrokenLinks": "throw", + "onDuplicateRoutes": "warn", + "plugins": [], + "presets": [], + "scripts": [], + "staticDirectories": [ + "static", + ], + "stylesheets": [], + "tagline": "", + "themeConfig": {}, + "themes": [], + "title": "Hello", + "titleDelimiter": "|", + "url": "https://docusaurus.io", + }, + "siteConfigPath": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/docusaurus.config.js", + "siteDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "siteMetadata": { + "docusaurusVersion": "", + "pluginVersions": {}, + "siteVersion": undefined, + }, + "siteStorage": { + "namespace": "", + "type": "localStorage", + }, + "siteVersion": undefined, +} +`; + +exports[`loadSite simple-site-with-baseUrl-i18n loads site - locale es 1`] = ` +{ + "baseUrl": "/es/", + "codeTranslations": {}, + "currentBundler": { + "instance": [Function], + "name": "webpack", + }, + "generatedFilesDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/.docusaurus", + "headTags": "", + "i18n": { + "currentLocale": "es", + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "de", + "label": "Deutsch", + "path": "de", + "translate": false, + "url": "https://docusaurus.io", + }, + "en": { + "baseUrl": "/myBaseUrl/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "en", + "label": "English", + "path": "en", + "translate": false, + "url": "https://docusaurus.io", + }, + "es": { + "baseUrl": "/es/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "es", + "label": "Español", + "path": "es", + "translate": false, + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "fr", + "label": "Français", + "path": "fr", + "translate": false, + "url": "https://docusaurus.io", + }, + "it": { + "baseUrl": "/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "it", + "label": "Italiano", + "path": "it", + "translate": false, + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "localizationDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/i18n/es", + "outDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/build/es/", + "plugins": [ + { + "content": undefined, + "defaultCodeTranslations": {}, + "getClientModules": [Function], + "globalData": undefined, + "injectHtmlTags": [Function], + "name": "docusaurus-bootstrap-plugin", + "options": { + "id": "default", + }, + "path": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + { + "configureWebpack": [Function], + "content": undefined, + "defaultCodeTranslations": {}, + "globalData": undefined, + "name": "docusaurus-mdx-fallback-plugin", + "options": { + "id": "default", + }, + "path": ".", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + ], + "postBodyTags": "", + "preBodyTags": "", + "routes": [], + "routesPaths": [ + "/es/404.html", + ], + "siteConfig": { + "baseUrl": "/es/", + "baseUrlIssueBanner": true, + "clientModules": [], + "customFields": {}, + "future": { + "experimental_faster": { + "gitEagerVcs": false, + "lightningCssMinimizer": false, + "mdxCrossCompilerCache": false, + "rspackBundler": false, + "rspackPersistentCache": false, + "ssgWorkerThreads": false, + "swcHtmlMinimizer": false, + "swcJsLoader": false, + "swcJsMinimizer": false, + }, + "experimental_router": "browser", + "experimental_storage": { + "namespace": false, + "type": "localStorage", + }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, + "v4": { + "removeLegacyPostBuildHeadAttribute": false, + "useCssCascadeLayers": false, + }, + }, + "headTags": [], + "i18n": { + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + }, + "en": { + "baseUrl": "/myBaseUrl/", + }, + "es": { + "baseUrl": "/es/", + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + }, + "it": { + "baseUrl": "/", + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "markdown": { + "anchors": { + "maintainCase": false, + }, + "emoji": true, + "format": "mdx", + "hooks": { + "onBrokenMarkdownImages": "throw", + "onBrokenMarkdownLinks": "warn", + }, + "mdx1Compat": { + "admonitions": true, + "comments": true, + "headingIds": true, + }, + "mermaid": false, + "parseFrontMatter": [Function], + "preprocessor": undefined, + "remarkRehypeOptions": undefined, + }, + "noIndex": false, + "onBrokenAnchors": "warn", + "onBrokenLinks": "throw", + "onDuplicateRoutes": "warn", + "plugins": [], + "presets": [], + "scripts": [], + "staticDirectories": [ + "static", + ], + "stylesheets": [], + "tagline": "", + "themeConfig": {}, + "themes": [], + "title": "Hello", + "titleDelimiter": "|", + "url": "https://docusaurus.io", + }, + "siteConfigPath": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/docusaurus.config.js", + "siteDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "siteMetadata": { + "docusaurusVersion": "", + "pluginVersions": {}, + "siteVersion": undefined, + }, + "siteStorage": { + "namespace": "", + "type": "localStorage", + }, + "siteVersion": undefined, +} +`; + +exports[`loadSite simple-site-with-baseUrl-i18n loads site - locale fr 1`] = ` +{ + "baseUrl": "/myBaseUrl/fr/", + "codeTranslations": {}, + "currentBundler": { + "instance": [Function], + "name": "webpack", + }, + "generatedFilesDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/.docusaurus", + "headTags": "", + "i18n": { + "currentLocale": "fr", + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "de", + "label": "Deutsch", + "path": "de", + "translate": false, + "url": "https://docusaurus.io", + }, + "en": { + "baseUrl": "/myBaseUrl/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "en", + "label": "English", + "path": "en", + "translate": false, + "url": "https://docusaurus.io", + }, + "es": { + "baseUrl": "/es/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "es", + "label": "Español", + "path": "es", + "translate": false, + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "fr", + "label": "Français", + "path": "fr", + "translate": false, + "url": "https://docusaurus.io", + }, + "it": { + "baseUrl": "/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "it", + "label": "Italiano", + "path": "it", + "translate": false, + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "localizationDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/i18n/fr", + "outDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/build/fr/", + "plugins": [ + { + "content": undefined, + "defaultCodeTranslations": {}, + "getClientModules": [Function], + "globalData": undefined, + "injectHtmlTags": [Function], + "name": "docusaurus-bootstrap-plugin", + "options": { + "id": "default", + }, + "path": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + { + "configureWebpack": [Function], + "content": undefined, + "defaultCodeTranslations": {}, + "globalData": undefined, + "name": "docusaurus-mdx-fallback-plugin", + "options": { + "id": "default", + }, + "path": ".", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + ], + "postBodyTags": "", + "preBodyTags": "", + "routes": [], + "routesPaths": [ + "/myBaseUrl/fr/404.html", + ], + "siteConfig": { + "baseUrl": "/myBaseUrl/fr/", + "baseUrlIssueBanner": true, + "clientModules": [], + "customFields": {}, + "future": { + "experimental_faster": { + "gitEagerVcs": false, + "lightningCssMinimizer": false, + "mdxCrossCompilerCache": false, + "rspackBundler": false, + "rspackPersistentCache": false, + "ssgWorkerThreads": false, + "swcHtmlMinimizer": false, + "swcJsLoader": false, + "swcJsMinimizer": false, + }, + "experimental_router": "browser", + "experimental_storage": { + "namespace": false, + "type": "localStorage", + }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, + "v4": { + "removeLegacyPostBuildHeadAttribute": false, + "useCssCascadeLayers": false, + }, + }, + "headTags": [], + "i18n": { + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + }, + "en": { + "baseUrl": "/myBaseUrl/", + }, + "es": { + "baseUrl": "/es/", + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + }, + "it": { + "baseUrl": "/", + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "markdown": { + "anchors": { + "maintainCase": false, + }, + "emoji": true, + "format": "mdx", + "hooks": { + "onBrokenMarkdownImages": "throw", + "onBrokenMarkdownLinks": "warn", + }, + "mdx1Compat": { + "admonitions": true, + "comments": true, + "headingIds": true, + }, + "mermaid": false, + "parseFrontMatter": [Function], + "preprocessor": undefined, + "remarkRehypeOptions": undefined, + }, + "noIndex": false, + "onBrokenAnchors": "warn", + "onBrokenLinks": "throw", + "onDuplicateRoutes": "warn", + "plugins": [], + "presets": [], + "scripts": [], + "staticDirectories": [ + "static", + ], + "stylesheets": [], + "tagline": "", + "themeConfig": {}, + "themes": [], + "title": "Hello", + "titleDelimiter": "|", + "url": "https://docusaurus.io", + }, + "siteConfigPath": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/docusaurus.config.js", + "siteDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "siteMetadata": { + "docusaurusVersion": "", + "pluginVersions": {}, + "siteVersion": undefined, + }, + "siteStorage": { + "namespace": "", + "type": "localStorage", + }, + "siteVersion": undefined, +} +`; + +exports[`loadSite simple-site-with-baseUrl-i18n loads site - locale it 1`] = ` +{ + "baseUrl": "/", + "codeTranslations": {}, + "currentBundler": { + "instance": [Function], + "name": "webpack", + }, + "generatedFilesDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/.docusaurus", + "headTags": "", + "i18n": { + "currentLocale": "it", + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "de", + "label": "Deutsch", + "path": "de", + "translate": false, + "url": "https://docusaurus.io", + }, + "en": { + "baseUrl": "/myBaseUrl/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "en", + "label": "English", + "path": "en", + "translate": false, + "url": "https://docusaurus.io", + }, + "es": { + "baseUrl": "/es/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "es", + "label": "Español", + "path": "es", + "translate": false, + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "fr", + "label": "Français", + "path": "fr", + "translate": false, + "url": "https://docusaurus.io", + }, + "it": { + "baseUrl": "/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "it", + "label": "Italiano", + "path": "it", + "translate": false, + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "localizationDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/i18n/it", + "outDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/build/", + "plugins": [ + { + "content": undefined, + "defaultCodeTranslations": {}, + "getClientModules": [Function], + "globalData": undefined, + "injectHtmlTags": [Function], + "name": "docusaurus-bootstrap-plugin", + "options": { + "id": "default", + }, + "path": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + { + "configureWebpack": [Function], + "content": undefined, + "defaultCodeTranslations": {}, + "globalData": undefined, + "name": "docusaurus-mdx-fallback-plugin", + "options": { + "id": "default", + }, + "path": ".", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + ], + "postBodyTags": "", + "preBodyTags": "", + "routes": [], + "routesPaths": [ + "/404.html", + ], + "siteConfig": { + "baseUrl": "/", + "baseUrlIssueBanner": true, + "clientModules": [], + "customFields": {}, + "future": { + "experimental_faster": { + "gitEagerVcs": false, + "lightningCssMinimizer": false, + "mdxCrossCompilerCache": false, + "rspackBundler": false, + "rspackPersistentCache": false, + "ssgWorkerThreads": false, + "swcHtmlMinimizer": false, + "swcJsLoader": false, + "swcJsMinimizer": false, + }, + "experimental_router": "browser", + "experimental_storage": { + "namespace": false, + "type": "localStorage", + }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, + "v4": { + "removeLegacyPostBuildHeadAttribute": false, + "useCssCascadeLayers": false, + }, + }, + "headTags": [], + "i18n": { + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + }, + "en": { + "baseUrl": "/myBaseUrl/", + }, + "es": { + "baseUrl": "/es/", + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + }, + "it": { + "baseUrl": "/", + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "markdown": { + "anchors": { + "maintainCase": false, + }, + "emoji": true, + "format": "mdx", + "hooks": { + "onBrokenMarkdownImages": "throw", + "onBrokenMarkdownLinks": "warn", + }, + "mdx1Compat": { + "admonitions": true, + "comments": true, + "headingIds": true, + }, + "mermaid": false, + "parseFrontMatter": [Function], + "preprocessor": undefined, + "remarkRehypeOptions": undefined, + }, + "noIndex": false, + "onBrokenAnchors": "warn", + "onBrokenLinks": "throw", + "onDuplicateRoutes": "warn", + "plugins": [], + "presets": [], + "scripts": [], + "staticDirectories": [ + "static", + ], + "stylesheets": [], + "tagline": "", + "themeConfig": {}, + "themes": [], + "title": "Hello", + "titleDelimiter": "|", + "url": "https://docusaurus.io", + }, + "siteConfigPath": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/docusaurus.config.js", + "siteDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "siteMetadata": { + "docusaurusVersion": "", + "pluginVersions": {}, + "siteVersion": undefined, + }, + "siteStorage": { + "namespace": "", + "type": "localStorage", + }, + "siteVersion": undefined, +} +`; + +exports[`loadSite simple-site-with-baseUrl-i18n loads site 1`] = ` +{ + "baseUrl": "/myBaseUrl/", + "codeTranslations": {}, + "currentBundler": { + "instance": [Function], + "name": "webpack", + }, + "generatedFilesDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/.docusaurus", + "headTags": "", + "i18n": { + "currentLocale": "en", + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "de", + "label": "Deutsch", + "path": "de", + "translate": false, + "url": "https://docusaurus.io", + }, + "en": { + "baseUrl": "/myBaseUrl/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "en", + "label": "English", + "path": "en", + "translate": false, + "url": "https://docusaurus.io", + }, + "es": { + "baseUrl": "/es/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "es", + "label": "Español", + "path": "es", + "translate": false, + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "fr", + "label": "Français", + "path": "fr", + "translate": false, + "url": "https://docusaurus.io", + }, + "it": { + "baseUrl": "/", + "calendar": "gregory", + "direction": "ltr", + "htmlLang": "it", + "label": "Italiano", + "path": "it", + "translate": false, + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "localizationDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/i18n/en", + "outDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/build/", + "plugins": [ + { + "content": undefined, + "defaultCodeTranslations": {}, + "getClientModules": [Function], + "globalData": undefined, + "injectHtmlTags": [Function], + "name": "docusaurus-bootstrap-plugin", + "options": { + "id": "default", + }, + "path": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + { + "configureWebpack": [Function], + "content": undefined, + "defaultCodeTranslations": {}, + "globalData": undefined, + "name": "docusaurus-mdx-fallback-plugin", + "options": { + "id": "default", + }, + "path": ".", + "routes": [], + "version": { + "type": "synthetic", + }, + }, + ], + "postBodyTags": "", + "preBodyTags": "", + "routes": [], + "routesPaths": [ + "/myBaseUrl/404.html", + ], + "siteConfig": { + "baseUrl": "/myBaseUrl/", + "baseUrlIssueBanner": true, + "clientModules": [], + "customFields": {}, + "future": { + "experimental_faster": { + "gitEagerVcs": false, + "lightningCssMinimizer": false, + "mdxCrossCompilerCache": false, + "rspackBundler": false, + "rspackPersistentCache": false, + "ssgWorkerThreads": false, + "swcHtmlMinimizer": false, + "swcJsLoader": false, + "swcJsMinimizer": false, + }, + "experimental_router": "browser", + "experimental_storage": { + "namespace": false, + "type": "localStorage", + }, + "experimental_vcs": { + "getFileCreationInfo": [Function], + "getFileLastUpdateInfo": [Function], + "initialize": [Function], + }, + "v4": { + "removeLegacyPostBuildHeadAttribute": false, + "useCssCascadeLayers": false, + }, + }, + "headTags": [], + "i18n": { + "defaultLocale": "en", + "localeConfigs": { + "de": { + "baseUrl": "/WHATEVER/de/", + }, + "en": { + "baseUrl": "/myBaseUrl/", + }, + "es": { + "baseUrl": "/es/", + "url": "https://es.docusaurus.io", + }, + "fr": { + "baseUrl": "/myBaseUrl/fr/", + }, + "it": { + "baseUrl": "/", + "url": "https://it.docusaurus.io", + }, + }, + "locales": [ + "en", + "fr", + "es", + "de", + "it", + ], + "path": "i18n", + }, + "markdown": { + "anchors": { + "maintainCase": false, + }, + "emoji": true, + "format": "mdx", + "hooks": { + "onBrokenMarkdownImages": "throw", + "onBrokenMarkdownLinks": "warn", + }, + "mdx1Compat": { + "admonitions": true, + "comments": true, + "headingIds": true, + }, + "mermaid": false, + "parseFrontMatter": [Function], + "preprocessor": undefined, + "remarkRehypeOptions": undefined, + }, + "noIndex": false, + "onBrokenAnchors": "warn", + "onBrokenLinks": "throw", + "onDuplicateRoutes": "warn", + "plugins": [], + "presets": [], + "scripts": [], + "staticDirectories": [ + "static", + ], + "stylesheets": [], + "tagline": "", + "themeConfig": {}, + "themes": [], + "title": "Hello", + "titleDelimiter": "|", + "url": "https://docusaurus.io", + }, + "siteConfigPath": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n/docusaurus.config.js", + "siteDir": "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl-i18n", + "siteMetadata": { + "docusaurusVersion": "", + "pluginVersions": {}, + "siteVersion": undefined, + }, + "siteStorage": { + "namespace": "", + "type": "localStorage", + }, + "siteVersion": undefined, +} +`; diff --git a/packages/docusaurus/src/server/__tests__/configValidation.test.ts b/packages/docusaurus/src/server/__tests__/configValidation.test.ts index aaad1d3bae..379ce8af28 100644 --- a/packages/docusaurus/src/server/__tests__/configValidation.test.ts +++ b/packages/docusaurus/src/server/__tests__/configValidation.test.ts @@ -6,6 +6,7 @@ */ import {jest} from '@jest/globals'; +import {getVcsPreset} from '@docusaurus/utils'; import { ConfigSchema, DEFAULT_CONFIG, @@ -27,6 +28,10 @@ import type { Config, DocusaurusConfig, PluginConfig, + I18nConfig, + I18nLocaleConfig, + VcsConfig, + VcsPreset, } from '@docusaurus/types'; import type {DeepPartial} from 'utility-types'; @@ -66,11 +71,17 @@ describe('normalizeConfig', () => { rspackBundler: true, rspackPersistentCache: true, ssgWorkerThreads: true, + gitEagerVcs: true, }, experimental_storage: { type: 'sessionStorage', namespace: true, }, + experimental_vcs: { + initialize: (_params) => {}, + getFileCreationInfo: (_filePath) => null, + getFileLastUpdateInfo: (_filePath) => null, + }, experimental_router: 'hash', }, tagline: 'my awesome site', @@ -304,6 +315,19 @@ describe('headTags', () => { `); }); + it('accepts headTags with a custom element without attributes', () => { + expect(() => + normalizeConfig({ + headTags: [ + { + tagName: 'my-custom-element', + customElement: true, + }, + ], + }), + ).not.toThrow(); + }); + it("throws error if headTags doesn't have string attributes", () => { expect(() => { normalizeConfig({ @@ -366,6 +390,121 @@ describe('onBrokenLinks', () => { }); }); +describe('i18n', () => { + function normalizeI18n(i18n: DeepPartial): I18nConfig { + return normalizeConfig({i18n}).i18n; + } + + it('accepts undefined object', () => { + expect(normalizeI18n(undefined)).toEqual(DEFAULT_CONFIG.i18n); + }); + + it('rejects empty object', () => { + expect(() => normalizeI18n({})).toThrowErrorMatchingInlineSnapshot(` + ""i18n.defaultLocale" is required + "i18n.locales" is required + " + `); + }); + + it('accepts minimal i18n config', () => { + expect(normalizeI18n({defaultLocale: 'fr', locales: ['fr']})).toEqual({ + defaultLocale: 'fr', + localeConfigs: {}, + locales: ['fr'], + path: 'i18n', + }); + }); + + describe('locale config', () => { + function normalizeLocaleConfig( + localeConfig?: Partial, + ): Partial { + return normalizeConfig({ + i18n: { + defaultLocale: 'fr', + locales: ['fr'], + localeConfigs: { + fr: localeConfig, + }, + }, + }).i18n.localeConfigs.fr; + } + + it('accepts undefined locale config', () => { + expect(normalizeLocaleConfig(undefined)).toBeUndefined(); + }); + + it('accepts empty locale config', () => { + expect(normalizeLocaleConfig({})).toEqual({}); + }); + + describe('url', () => { + it('accepts undefined', () => { + expect(normalizeLocaleConfig({url: undefined})).toEqual({ + url: undefined, + }); + }); + + it('rejects empty', () => { + expect(() => normalizeLocaleConfig({url: ''})) + .toThrowErrorMatchingInlineSnapshot(` + ""i18n.localeConfigs.fr.url" is not allowed to be empty + " + `); + }); + + it('accepts valid url', () => { + expect( + normalizeLocaleConfig({url: 'https://fr.docusaurus.io'}), + ).toEqual({ + url: 'https://fr.docusaurus.io', + }); + }); + + it('accepts valid url and removes trailing slash', () => { + expect( + normalizeLocaleConfig({url: 'https://fr.docusaurus.io/'}), + ).toEqual({ + url: 'https://fr.docusaurus.io', + }); + }); + }); + + describe('baseUrl', () => { + it('accepts undefined baseUrl', () => { + expect(normalizeLocaleConfig({baseUrl: undefined})).toEqual({ + baseUrl: undefined, + }); + }); + + it('accepts empty baseUrl', () => { + expect(normalizeLocaleConfig({baseUrl: ''})).toEqual({ + baseUrl: '/', + }); + }); + + it('accepts regular baseUrl', () => { + expect(normalizeLocaleConfig({baseUrl: '/myBase/Url/'})).toEqual({ + baseUrl: '/myBase/Url/', + }); + }); + + it('accepts baseUrl without leading/trailing slashes', () => { + expect(normalizeLocaleConfig({baseUrl: 'myBase/Url'})).toEqual({ + baseUrl: '/myBase/Url/', + }); + }); + + it('accepts translate true', () => { + expect(normalizeLocaleConfig({translate: true})).toEqual({ + translate: true, + }); + }); + }); + }); +}); + describe('markdown', () => { function normalizeMarkdown( markdown: DeepPartial, @@ -508,9 +647,9 @@ describe('markdown', () => { emoji: 'yes', }), ).toThrowErrorMatchingInlineSnapshot(` - ""markdown.emoji" must be a boolean - " - `); + ""markdown.emoji" must be a boolean + " + `); }); it('throw for number emoji value', () => { @@ -522,9 +661,9 @@ describe('markdown', () => { }, }), ).toThrowErrorMatchingInlineSnapshot(` - ""markdown.emoji" must be a boolean - " - `); + ""markdown.emoji" must be a boolean + " + `); }); }); @@ -959,6 +1098,12 @@ describe('future', () => { rspackBundler: true, rspackPersistentCache: true, ssgWorkerThreads: true, + gitEagerVcs: true, + }, + experimental_vcs: { + initialize: (_params) => {}, + getFileCreationInfo: (_filePath) => null, + getFileLastUpdateInfo: (_filePath) => null, }, experimental_storage: { type: 'sessionStorage', @@ -1277,6 +1422,196 @@ describe('future', () => { }); }); + describe('vcs', () => { + function vcsContaining(vcs: Partial) { + return futureContaining({ + experimental_vcs: expect.objectContaining(vcs), + }); + } + + describe('base', () => { + it('accepts vcs - undefined', () => { + expect( + normalizeConfig({ + future: { + experimental_vcs: undefined, + }, + }), + ).toEqual( + futureContaining({ + ...DEFAULT_FUTURE_CONFIG, + experimental_vcs: getVcsPreset('default-v1'), + }), + ); + }); + + it('accepts vcs - true', () => { + expect( + normalizeConfig({ + future: { + experimental_vcs: true, + }, + }), + ).toEqual( + futureContaining({ + ...DEFAULT_FUTURE_CONFIG, + experimental_vcs: getVcsPreset('default-v1'), + }), + ); + }); + + it('accepts vcs - false', () => { + expect( + normalizeConfig({ + future: { + experimental_vcs: false, + }, + }), + ).toEqual( + futureContaining({ + ...DEFAULT_FUTURE_CONFIG, + experimental_vcs: getVcsPreset('disabled'), + }), + ); + }); + }); + + describe('presets', () => { + it('accepts git-ad-hoc', () => { + const presetName: VcsPreset = 'git-ad-hoc'; + expect( + normalizeConfig({ + future: { + experimental_vcs: presetName, + }, + }), + ).toEqual(vcsContaining(getVcsPreset(presetName))); + }); + + it('accepts git-eager', () => { + const presetName: VcsPreset = 'git-eager'; + expect( + normalizeConfig({ + future: { + experimental_vcs: presetName, + }, + }), + ).toEqual(vcsContaining(getVcsPreset(presetName))); + }); + + it('accepts hardcoded', () => { + const presetName: VcsPreset = 'hardcoded'; + expect( + normalizeConfig({ + future: { + experimental_vcs: presetName, + }, + }), + ).toEqual(vcsContaining(getVcsPreset(presetName))); + }); + + it('rejects unknown preset name', () => { + // @ts-expect-error: invalid on purpose + const presetName: VcsPreset = 'unknown-preset-name'; + expect(() => + normalizeConfig({ + future: { + experimental_vcs: presetName, + }, + }), + ).toThrowErrorMatchingInlineSnapshot(` + ""future.experimental_vcs" failed custom validation because VCS config preset name 'unknown-preset-name' is not valid. + " + `); + }); + }); + + describe('object config', () => { + it('accepts vcs - full', () => { + const vcs: VcsConfig = { + initialize: (_params) => {}, + getFileCreationInfo: (_filePath) => null, + getFileLastUpdateInfo: (_filePath) => null, + }; + expect( + normalizeConfig({ + future: { + experimental_vcs: vcs, + }, + }), + ).toEqual(vcsContaining(vcs)); + }); + + it('rejects vcs - empty', () => { + expect(() => + normalizeConfig({ + future: {experimental_vcs: {}}, + }), + ).toThrowErrorMatchingInlineSnapshot(` + ""future.experimental_vcs" failed custom validation because "initialize" is required + " + `); + }); + + it('accepts vcs - bad initialize() arity', () => { + const vcs: VcsConfig = { + // @ts-expect-error: invalid arity + initialize: (_params, _extraParam) => {}, + getFileCreationInfo: (_filePath) => null, + getFileLastUpdateInfo: (_filePath) => null, + }; + expect(() => + normalizeConfig({ + future: { + experimental_vcs: vcs, + }, + }), + ).toThrowErrorMatchingInlineSnapshot(` + ""future.experimental_vcs" failed custom validation because "initialize" must have an arity lesser or equal to 1 + " + `); + }); + + it('accepts vcs - bad getFileCreationInfo() arity', () => { + const vcs: VcsConfig = { + initialize: (_params) => {}, + // @ts-expect-error: invalid arity + getFileCreationInfo: (_filePath, _extraParam) => null, + getFileLastUpdateInfo: (_filePath) => null, + }; + expect(() => + normalizeConfig({ + future: { + experimental_vcs: vcs, + }, + }), + ).toThrowErrorMatchingInlineSnapshot(` + ""future.experimental_vcs" failed custom validation because "getFileCreationInfo" must have an arity of 1 + " + `); + }); + + it('accepts vcs - bad getFileLastUpdateInfo() arity', () => { + const vcs: VcsConfig = { + initialize: (_params) => {}, + getFileCreationInfo: (_filePath) => null, + // @ts-expect-error: invalid arity + getFileLastUpdateInfo: (_filePath, _extraParam) => null, + }; + expect(() => + normalizeConfig({ + future: { + experimental_vcs: vcs, + }, + }), + ).toThrowErrorMatchingInlineSnapshot(` + ""future.experimental_vcs" failed custom validation because "getFileLastUpdateInfo" must have an arity of 1 + " + `); + }); + }); + }); + describe('faster', () => { function fasterContaining(faster: Partial) { return futureContaining({ @@ -1312,6 +1647,7 @@ describe('future', () => { rspackBundler: true, rspackPersistentCache: true, ssgWorkerThreads: true, + gitEagerVcs: true, }; expect( normalizeConfig({ @@ -2024,6 +2360,87 @@ describe('future', () => { `); }); }); + + describe('gitEagerVcs', () => { + it('accepts - undefined', () => { + const faster: Partial = { + gitEagerVcs: undefined, + }; + expect( + normalizeConfig({ + future: { + experimental_faster: faster, + }, + }), + ).toEqual(fasterContaining({gitEagerVcs: false})); + }); + + it('accepts - true', () => { + const faster: Partial = { + gitEagerVcs: true, + }; + expect( + normalizeConfig({ + future: { + experimental_faster: faster, + }, + }), + ).toEqual( + futureContaining({ + experimental_faster: expect.objectContaining(faster), + experimental_vcs: getVcsPreset('default-v2'), + }), + ); + }); + + it('accepts - false', () => { + const faster: Partial = { + gitEagerVcs: false, + }; + expect( + normalizeConfig({ + future: { + experimental_faster: faster, + }, + }), + ).toEqual( + futureContaining({ + experimental_faster: expect.objectContaining(faster), + experimental_vcs: getVcsPreset('default-v1'), + }), + ); + }); + + it('rejects - null', () => { + // @ts-expect-error: invalid + const faster: Partial = {gitEagerVcs: 42}; + expect(() => + normalizeConfig({ + future: { + experimental_faster: faster, + }, + }), + ).toThrowErrorMatchingInlineSnapshot(` + ""future.experimental_faster.gitEagerVcs" must be a boolean + " + `); + }); + + it('rejects - number', () => { + // @ts-expect-error: invalid + const faster: Partial = {gitEagerVcs: 42}; + expect(() => + normalizeConfig({ + future: { + experimental_faster: faster, + }, + }), + ).toThrowErrorMatchingInlineSnapshot(` + ""future.experimental_faster.gitEagerVcs" must be a boolean + " + `); + }); + }); }); describe('v4', () => { diff --git a/packages/docusaurus/src/server/__tests__/htmlTags.test.ts b/packages/docusaurus/src/server/__tests__/htmlTags.test.ts index 717e5ca79e..e46e60d595 100644 --- a/packages/docusaurus/src/server/__tests__/htmlTags.test.ts +++ b/packages/docusaurus/src/server/__tests__/htmlTags.test.ts @@ -189,7 +189,7 @@ describe('loadHtmlTags', () => { }, ]), ).toThrowErrorMatchingInlineSnapshot( - `"Error loading {"tagName":"endiliey","attributes":{"this":"is invalid"}}, "endiliey" is not a valid HTML tag."`, + `"Error loading {"tagName":"endiliey","attributes":{"this":"is invalid"}}, "endiliey" is not a valid HTML tag. Either use a valid "tagName" or set "customElement: true"."`, ); }); diff --git a/packages/docusaurus/src/server/__tests__/i18n.test.ts b/packages/docusaurus/src/server/__tests__/i18n.test.ts index fb075d8b2b..9cc9674569 100644 --- a/packages/docusaurus/src/server/__tests__/i18n.test.ts +++ b/packages/docusaurus/src/server/__tests__/i18n.test.ts @@ -17,21 +17,31 @@ const loadI18nSiteDir = path.resolve( 'load-i18n-site', ); +const siteUrl = 'https://example.com'; + function loadI18nTest({ siteDir = loadI18nSiteDir, + baseUrl = '/', i18nConfig, currentLocale, + automaticBaseUrlLocalizationDisabled, }: { siteDir?: string; + baseUrl?: string; i18nConfig: I18nConfig; currentLocale: string; + automaticBaseUrlLocalizationDisabled?: boolean; }) { return loadI18n({ siteDir, config: { i18n: i18nConfig, + url: siteUrl, + baseUrl, } as DocusaurusConfig, currentLocale, + automaticBaseUrlLocalizationDisabled: + automaticBaseUrlLocalizationDisabled ?? false, }); } @@ -113,9 +123,11 @@ describe('defaultLocaleConfig', () => { }); describe('loadI18n', () => { - const consoleSpy = jest.spyOn(console, 'warn').mockImplementation(() => {}); + const consoleWarnSpy = jest + .spyOn(console, 'warn') + .mockImplementation(() => {}); beforeEach(() => { - consoleSpy.mockClear(); + consoleWarnSpy.mockClear(); }); it('loads I18n for default config', async () => { @@ -133,6 +145,8 @@ describe('loadI18n', () => { en: { ...getDefaultLocaleConfig('en'), translate: false, + url: siteUrl, + baseUrl: '/', }, }, }); @@ -158,14 +172,60 @@ describe('loadI18n', () => { en: { ...getDefaultLocaleConfig('en'), translate: false, + url: siteUrl, + baseUrl: '/en/', }, fr: { ...getDefaultLocaleConfig('fr'), translate: true, + url: siteUrl, + baseUrl: '/', }, de: { ...getDefaultLocaleConfig('de'), translate: true, + url: siteUrl, + baseUrl: '/de/', + }, + }, + }); + }); + + it('loads I18n for multi-lang config - with automaticBaseUrlLocalizationDisabled=true', async () => { + await expect( + loadI18nTest({ + i18nConfig: { + path: 'i18n', + defaultLocale: 'fr', + locales: ['en', 'fr', 'de'], + localeConfigs: {}, + }, + currentLocale: 'fr', + automaticBaseUrlLocalizationDisabled: true, + }), + ).resolves.toEqual({ + defaultLocale: 'fr', + path: 'i18n', + locales: ['en', 'fr', 'de'], + currentLocale: 'fr', + localeConfigs: { + en: { + ...getDefaultLocaleConfig('en'), + translate: false, + url: siteUrl, + baseUrl: '/', + }, + fr: { + ...getDefaultLocaleConfig('fr'), + translate: true, + url: siteUrl, + baseUrl: '/', + }, + de: { + ...getDefaultLocaleConfig('de'), + translate: true, + url: siteUrl, + baseUrl: '/', }, }, }); @@ -191,14 +251,20 @@ describe('loadI18n', () => { en: { ...getDefaultLocaleConfig('en'), translate: false, + url: siteUrl, + baseUrl: '/en/', }, fr: { ...getDefaultLocaleConfig('fr'), translate: true, + url: siteUrl, + baseUrl: '/', }, de: { ...getDefaultLocaleConfig('de'), translate: true, + url: siteUrl, + baseUrl: '/de/', }, }, }); @@ -213,10 +279,11 @@ describe('loadI18n', () => { locales: ['en', 'fr', 'de'], localeConfigs: { fr: {label: 'Français', translate: false}, - en: {translate: true}, - de: {translate: false}, + en: {translate: true, baseUrl: 'en-EN/whatever/else'}, + de: {translate: false, baseUrl: '/de-DE/'}, }, }, + currentLocale: 'de', }), ).resolves.toEqual({ @@ -232,19 +299,96 @@ describe('loadI18n', () => { calendar: 'gregory', path: 'fr', translate: false, + url: siteUrl, + baseUrl: '/', }, en: { ...getDefaultLocaleConfig('en'), translate: true, + url: siteUrl, + baseUrl: '/en-EN/whatever/else/', }, de: { ...getDefaultLocaleConfig('de'), translate: false, + url: siteUrl, + baseUrl: '/de-DE/', }, }, }); }); + it('loads I18n for multi-locale config with baseUrl edge cases', async () => { + await expect( + loadI18nTest({ + baseUrl: 'siteBaseUrl', + i18nConfig: { + path: 'i18n', + defaultLocale: 'fr', + locales: ['en', 'fr', 'de', 'pt'], + localeConfigs: { + fr: {}, + en: {baseUrl: ''}, + de: {baseUrl: '/de-DE/'}, + }, + }, + currentLocale: 'de', + }), + ).resolves.toEqual( + expect.objectContaining({ + localeConfigs: { + fr: expect.objectContaining({ + baseUrl: '/siteBaseUrl/', + }), + en: expect.objectContaining({ + baseUrl: '/', + }), + de: expect.objectContaining({ + baseUrl: '/de-DE/', + }), + pt: expect.objectContaining({ + baseUrl: '/siteBaseUrl/pt/', + }), + }, + }), + ); + }); + + it('loads I18n for multi-locale config with custom urls', async () => { + await expect( + loadI18nTest({ + baseUrl: 'siteBaseUrl', + i18nConfig: { + path: 'i18n', + defaultLocale: 'fr', + locales: ['en', 'fr', 'de', 'pt'], + localeConfigs: { + fr: {url: 'https://fr.example.com'}, + en: {url: 'https://en.example.com'}, + }, + }, + currentLocale: 'de', + }), + ).resolves.toEqual( + expect.objectContaining({ + localeConfigs: { + fr: expect.objectContaining({ + url: 'https://fr.example.com', + }), + en: expect.objectContaining({ + url: 'https://en.example.com', + }), + de: expect.objectContaining({ + url: siteUrl, + }), + pt: expect.objectContaining({ + url: siteUrl, + }), + }, + }), + ); + }); + it('warns when trying to load undeclared locale', async () => { await loadI18nTest({ i18nConfig: { @@ -255,8 +399,67 @@ describe('loadI18n', () => { }, currentLocale: 'it', }); - expect(consoleSpy.mock.calls[0]![0]).toMatch( - /The locale .*it.* was not found in your site configuration/, + expect(consoleWarnSpy.mock.calls[0]![0]).toMatch( + /The locale .*it.* was not found in your Docusaurus site configuration/, ); }); + + it('throws when trying to load undeclared locale that is not a valid locale BCP47 name', async () => { + await expect(() => + loadI18nTest({ + i18nConfig: { + path: 'i18n', + defaultLocale: 'en', + locales: ['en', 'fr', 'de'], + localeConfigs: {}, + }, + currentLocale: 'x1', + }), + ).rejects.toThrowErrorMatchingInlineSnapshot(` + "Docusaurus couldn't infer a default locale config for x1. + Make sure it is a valid BCP 47 locale name (e.g. en, fr, fr-FR, etc.) and/or provide a valid BCP 47 \`siteConfig.i18n.localeConfig['x1'].htmlLang\` attribute." + `); + }); + + it('throws when trying to load declared locale that is not a valid locale BCP47 name', async () => { + await expect(() => + loadI18nTest({ + i18nConfig: { + path: 'i18n', + defaultLocale: 'fr', + locales: ['en', 'fr', 'de'], + localeConfigs: {x1: {}}, + }, + currentLocale: 'x1', + }), + ).rejects.toThrowErrorMatchingInlineSnapshot(` + "Docusaurus couldn't infer a default locale config for x1. + Make sure it is a valid BCP 47 locale name (e.g. en, fr, fr-FR, etc.) and/or provide a valid BCP 47 \`siteConfig.i18n.localeConfig['x1'].htmlLang\` attribute." + `); + }); + + it('loads i18n when trying to load declared locale with invalid BCP47 name but valid BCP47', async () => { + const result = await loadI18nTest({ + i18nConfig: { + path: 'i18n', + defaultLocale: 'en', + locales: ['en', 'fr', 'x1'], + localeConfigs: { + x1: {htmlLang: 'en-US'}, + }, + }, + currentLocale: 'x1', + }); + expect(result.localeConfigs.x1).toEqual({ + baseUrl: '/x1/', + calendar: 'gregory', + direction: 'ltr', + htmlLang: 'en-US', + label: 'American English', + path: 'en-US', + translate: false, + url: 'https://example.com', + }); + expect(consoleWarnSpy).toHaveBeenCalledTimes(0); + }); }); diff --git a/packages/docusaurus/src/server/__tests__/site.test.ts b/packages/docusaurus/src/server/__tests__/site.test.ts index 7ce18bfa4d..355e13555d 100644 --- a/packages/docusaurus/src/server/__tests__/site.test.ts +++ b/packages/docusaurus/src/server/__tests__/site.test.ts @@ -6,40 +6,138 @@ */ import path from 'path'; -import {loadSetup} from './testUtils'; +import {loadSiteFixture} from './testUtils'; -describe('load', () => { - it('loads props for site', async () => { - const site = await loadSetup('custom-i18n-site'); - expect(site.props).toMatchSnapshot(); +describe('loadSite', () => { + describe('simple-site-with-baseUrl', () => { + const siteFixture = 'loadSiteFixtures/simple-site-with-baseUrl'; + + it('loads site', async () => { + const site = await loadSiteFixture(siteFixture); + expect(site.props).toMatchSnapshot(); + }); + + it('loads site - custom outDir', async () => { + const site = await loadSiteFixture(siteFixture, { + outDir: 'custom-out-dir', + }); + expect(site.props).toMatchSnapshot(); + }); + + it('loads site - custom config', async () => { + const site = await loadSiteFixture(siteFixture, { + config: 'docusaurus.config.custom.js', + }); + expect(site.props).toMatchSnapshot(); + }); + + it('loads site - non-existing config', async () => { + await expect(() => + loadSiteFixture(siteFixture, { + config: 'docusaurus.config.doesNotExist.js', + }), + ).rejects.toThrowErrorMatchingInlineSnapshot( + `"Config file at "/packages/docusaurus/src/server/__tests__/__fixtures__/loadSiteFixtures/simple-site-with-baseUrl/docusaurus.config.doesNotExist.js" not found."`, + ); + }); }); - it('loads props for site - custom i18n path', async () => { - const site = await loadSetup('custom-i18n-site', {locale: 'zh-Hans'}); - expect(site.props).toEqual( - expect.objectContaining({ - baseUrl: '/zh-Hans/', - i18n: expect.objectContaining({ - currentLocale: 'zh-Hans', - }), - localizationDir: path.join( - __dirname, - '__fixtures__/custom-i18n-site/i18n/zh-Hans-custom', - ), - outDir: path.join( - __dirname, - '__fixtures__/custom-i18n-site/build/zh-Hans', - ), - routesPaths: ['/zh-Hans/404.html'], - siteConfig: expect.objectContaining({ + describe('simple-site-with-baseUrl-i18n', () => { + const siteFixture = 'loadSiteFixtures/simple-site-with-baseUrl-i18n'; + + it('loads site', async () => { + const site = await loadSiteFixture(siteFixture); + expect(site.props).toMatchSnapshot(); + }); + + it('loads site - custom outDir', async () => { + const site = await loadSiteFixture(siteFixture, { + outDir: 'custom-out-dir', + }); + expect(site.props).toMatchSnapshot(); + }); + + it('loads site - locale en', async () => { + const site = await loadSiteFixture(siteFixture, { + locale: 'en', + }); + expect(site.props).toMatchSnapshot(); + }); + + it('loads site - locale fr', async () => { + const site = await loadSiteFixture(siteFixture, { + locale: 'fr', + }); + expect(site.props).toMatchSnapshot(); + }); + + it('loads site - locale fr + custom outDir', async () => { + const site = await loadSiteFixture(siteFixture, { + outDir: 'custom-out-dir', + locale: 'fr', + }); + expect(site.props).toMatchSnapshot(); + }); + + it('loads site - locale es', async () => { + const site = await loadSiteFixture(siteFixture, { + locale: 'es', + }); + expect(site.props).toMatchSnapshot(); + }); + + it('loads site - locale de', async () => { + const site = await loadSiteFixture(siteFixture, { + locale: 'de', + }); + expect(site.props).toMatchSnapshot(); + }); + + it('loads site - locale it', async () => { + const site = await loadSiteFixture(siteFixture, { + locale: 'it', + }); + expect(site.props).toMatchSnapshot(); + }); + }); + + describe('custom-i18n-site', () => { + it('loads site', async () => { + const site = await loadSiteFixture('custom-i18n-site'); + + expect(site.props).toMatchSnapshot(); + }); + + it('loads site - zh-Hans locale', async () => { + const site = await loadSiteFixture('custom-i18n-site', { + locale: 'zh-Hans', + }); + + expect(site.props).toEqual( + expect.objectContaining({ baseUrl: '/zh-Hans/', + i18n: expect.objectContaining({ + currentLocale: 'zh-Hans', + }), + localizationDir: path.join( + __dirname, + '__fixtures__/custom-i18n-site/i18n/zh-Hans-custom', + ), + outDir: path.join( + __dirname, + '__fixtures__/custom-i18n-site/build/zh-Hans/', + ), + routesPaths: ['/zh-Hans/404.html'], + siteConfig: expect.objectContaining({ + baseUrl: '/zh-Hans/', + }), + siteStorage: { + namespace: '', + type: 'localStorage', + }, + plugins: site.props.plugins, }), - siteStorage: { - namespace: '', - type: 'localStorage', - }, - plugins: site.props.plugins, - }), - ); + ); + }); }); }); diff --git a/packages/docusaurus/src/server/__tests__/testUtils.ts b/packages/docusaurus/src/server/__tests__/testUtils.ts index 178c3c1c24..9f7bbe20c0 100644 --- a/packages/docusaurus/src/server/__tests__/testUtils.ts +++ b/packages/docusaurus/src/server/__tests__/testUtils.ts @@ -6,14 +6,14 @@ */ import path from 'path'; -import {loadSite, type LoadContextParams} from '../site'; -import type {Site} from '@docusaurus/types'; +import {loadSite, type LoadContextParams, type Site} from '../site'; -// Helper methods to setup dummy/fake projects. -export async function loadSetup( +export async function loadSiteFixture( name: string, options?: Partial, ): Promise { - const fixtures = path.join(__dirname, '__fixtures__'); - return loadSite({siteDir: path.join(fixtures, name), ...options}); + return loadSite({ + siteDir: path.join(__dirname, '__fixtures__', name), + ...options, + }); } diff --git a/packages/docusaurus/src/server/configValidation.ts b/packages/docusaurus/src/server/configValidation.ts index d62e7b14c8..e57a7ba45a 100644 --- a/packages/docusaurus/src/server/configValidation.ts +++ b/packages/docusaurus/src/server/configValidation.ts @@ -6,30 +6,60 @@ */ import { + DEFAULT_I18N_DIR_NAME, DEFAULT_PARSE_FRONT_MATTER, DEFAULT_STATIC_DIR_NAME, - DEFAULT_I18N_DIR_NAME, + getVcsPreset, + VcsPresetNames, } from '@docusaurus/utils'; import {Joi, printWarning} from '@docusaurus/utils-validation'; import { - addTrailingSlash, addLeadingSlash, + addTrailingSlash, removeTrailingSlash, } from '@docusaurus/utils-common'; import logger from '@docusaurus/logger'; import type { + DocusaurusConfig, FasterConfig, FutureConfig, FutureV4Config, - StorageConfig, - DocusaurusConfig, I18nConfig, + I18nLocaleConfig, MarkdownConfig, MarkdownHooks, + StorageConfig, + VcsConfig, + VcsPreset, } from '@docusaurus/types'; const DEFAULT_I18N_LOCALE = 'en'; +const SiteUrlSchema = Joi.string() + .custom((value: string, helpers) => { + try { + const {pathname} = new URL(value); + if (pathname !== '/') { + return helpers.error('docusaurus.subPathError', {pathname}); + } + } catch { + return helpers.error('any.invalid'); + } + return removeTrailingSlash(value); + }) + .messages({ + 'any.invalid': + '"{#value}" does not look like a valid URL. Make sure it has a protocol; for example, "https://example.com".', + 'docusaurus.subPathError': + 'The url is not supposed to contain a sub-path like "{#pathname}". Please use the baseUrl field for sub-paths.', + }); + +const BaseUrlSchema = Joi + // Weird Joi trick needed, otherwise value '' is not normalized... + .alternatives() + .try(Joi.string().required().allow('')) + .custom((value: string) => addLeadingSlash(addTrailingSlash(value))); + export const DEFAULT_I18N_CONFIG: I18nConfig = { defaultLocale: DEFAULT_I18N_LOCALE, path: DEFAULT_I18N_DIR_NAME, @@ -51,6 +81,7 @@ export const DEFAULT_FASTER_CONFIG: FasterConfig = { rspackBundler: false, rspackPersistentCache: false, ssgWorkerThreads: false, + gitEagerVcs: false, }; // When using the "faster: true" shortcut @@ -63,6 +94,7 @@ export const DEFAULT_FASTER_CONFIG_TRUE: FasterConfig = { rspackBundler: true, rspackPersistentCache: true, ssgWorkerThreads: true, + gitEagerVcs: true, }; export const DEFAULT_FUTURE_V4_CONFIG: FutureV4Config = { @@ -80,6 +112,7 @@ export const DEFAULT_FUTURE_CONFIG: FutureConfig = { v4: DEFAULT_FUTURE_V4_CONFIG, experimental_faster: DEFAULT_FASTER_CONFIG, experimental_storage: DEFAULT_STORAGE_CONFIG, + experimental_vcs: getVcsPreset('default-v1'), experimental_router: 'browser', }; @@ -220,12 +253,15 @@ const PresetSchema = Joi.alternatives() - A simple string, like \`"classic"\``, }); -const LocaleConfigSchema = Joi.object({ +const LocaleConfigSchema = Joi.object({ label: Joi.string(), htmlLang: Joi.string(), - direction: Joi.string().equal('ltr', 'rtl').default('ltr'), + direction: Joi.string().equal('ltr', 'rtl'), calendar: Joi.string(), path: Joi.string(), + translate: Joi.boolean(), + url: SiteUrlSchema, + baseUrl: BaseUrlSchema, }); const I18N_CONFIG_SCHEMA = Joi.object({ @@ -262,6 +298,7 @@ const FASTER_CONFIG_SCHEMA = Joi.alternatives() ssgWorkerThreads: Joi.boolean().default( DEFAULT_FASTER_CONFIG.ssgWorkerThreads, ), + gitEagerVcs: Joi.boolean().default(DEFAULT_FASTER_CONFIG.gitEagerVcs), }), Joi.boolean() .required() @@ -302,10 +339,41 @@ const STORAGE_CONFIG_SCHEMA = Joi.object({ .optional() .default(DEFAULT_STORAGE_CONFIG); +const VCS_CONFIG_OBJECT_SCHEMA = Joi.object({ + // All the fields are required on purpose + // You either provide a full VCS config or nothing + initialize: Joi.function().maxArity(1).required(), + getFileCreationInfo: Joi.function().arity(1).required(), + getFileLastUpdateInfo: Joi.function().arity(1).required(), +}); + +const VCS_CONFIG_SCHEMA = Joi.custom((input) => { + if (typeof input === 'string') { + const presetName = input as VcsPreset; + if (!VcsPresetNames.includes(presetName)) { + throw new Error(`VCS config preset name '${input}' is not valid.`); + } + return getVcsPreset(presetName); + } + if (typeof input === 'boolean') { + // We return the boolean on purpose + // We'll normalize it to a real VcsConfig later + // This is annoying, but we have to read the future flag to switch to the + // new "default-v2" config (not easy to do it here) + return input; + } + const {error, value} = VCS_CONFIG_OBJECT_SCHEMA.validate(input); + if (error) { + throw error; + } + return value; +}).default(true); + const FUTURE_CONFIG_SCHEMA = Joi.object({ v4: FUTURE_V4_SCHEMA, experimental_faster: FASTER_CONFIG_SCHEMA, experimental_storage: STORAGE_CONFIG_SCHEMA, + experimental_vcs: VCS_CONFIG_SCHEMA, experimental_router: Joi.string() .equal('browser', 'hash') .default(DEFAULT_FUTURE_CONFIG.experimental_router), @@ -313,38 +381,13 @@ const FUTURE_CONFIG_SCHEMA = Joi.object({ .optional() .default(DEFAULT_FUTURE_CONFIG); -const SiteUrlSchema = Joi.string() - .required() - .custom((value: string, helpers) => { - try { - const {pathname} = new URL(value); - if (pathname !== '/') { - return helpers.error('docusaurus.subPathError', {pathname}); - } - } catch { - return helpers.error('any.invalid'); - } - return removeTrailingSlash(value); - }) - .messages({ - 'any.invalid': - '"{#value}" does not look like a valid URL. Make sure it has a protocol; for example, "https://example.com".', - 'docusaurus.subPathError': - 'The url is not supposed to contain a sub-path like "{#pathname}". Please use the baseUrl field for sub-paths.', - }); - // TODO move to @docusaurus/utils-validation export const ConfigSchema = Joi.object({ - baseUrl: Joi - // Weird Joi trick needed, otherwise value '' is not normalized... - .alternatives() - .try(Joi.string().required().allow('')) - .required() - .custom((value: string) => addLeadingSlash(addTrailingSlash(value))), + url: SiteUrlSchema.required(), + baseUrl: BaseUrlSchema.required(), baseUrlIssueBanner: Joi.boolean().default(DEFAULT_CONFIG.baseUrlIssueBanner), favicon: Joi.string().optional(), title: Joi.string().required(), - url: SiteUrlSchema, trailingSlash: Joi.boolean(), // No default value! undefined = retrocompatible legacy behavior! i18n: I18N_CONFIG_SCHEMA, future: FUTURE_CONFIG_SCHEMA, @@ -394,9 +437,14 @@ export const ConfigSchema = Joi.object({ .items( Joi.object({ tagName: Joi.string().required(), - attributes: Joi.object() - .pattern(/[\w-]+/, Joi.string()) - .required(), + attributes: Joi.object().when('customElement', { + is: Joi.valid(true), + then: Joi.optional(), + otherwise: Joi.object() + .pattern(/[\w-]+/, Joi.string()) + .required(), + }), + customElement: Joi.bool().default(false), }).unknown(), ) .messages({ @@ -494,6 +542,17 @@ Please migrate and move this option to code=${'siteConfig.markdown.hooks.onBroke config.onBrokenMarkdownLinks = undefined; } + // We normalize the VCS config when using a boolean value + if (typeof config.future.experimental_vcs === 'boolean') { + const vcsConfig = config.future.experimental_vcs + ? config.future.experimental_faster.gitEagerVcs + ? getVcsPreset('default-v2') + : getVcsPreset('default-v1') + : getVcsPreset('disabled'); + + config.future.experimental_vcs = vcsConfig; + } + if ( config.future.experimental_faster.ssgWorkerThreads && !config.future.v4.removeLegacyPostBuildHeadAttribute diff --git a/packages/docusaurus/src/server/htmlTags.ts b/packages/docusaurus/src/server/htmlTags.ts index 46bd39ab75..52cbee8258 100644 --- a/packages/docusaurus/src/server/htmlTags.ts +++ b/packages/docusaurus/src/server/htmlTags.ts @@ -17,22 +17,27 @@ import type { RouterType, } from '@docusaurus/types'; +// TODO this should be done at config validation time, not here function assertIsHtmlTagObject(val: unknown): asserts val is HtmlTagObject { if (typeof val !== 'object' || !val) { throw new Error(`"${val}" is not a valid HTML tag object.`); } - if (typeof (val as HtmlTagObject).tagName !== 'string') { + const htmlTag = val as HtmlTagObject; + if (typeof htmlTag.tagName !== 'string') { throw new Error( `${JSON.stringify( val, )} is not a valid HTML tag object. "tagName" must be defined as a string.`, ); } - if (!(htmlTags as string[]).includes((val as HtmlTagObject).tagName)) { + if ( + !htmlTag.customElement && + !(htmlTags as string[]).includes(htmlTag.tagName) + ) { throw new Error( `Error loading ${JSON.stringify(val)}, "${ - (val as HtmlTagObject).tagName - }" is not a valid HTML tag.`, + htmlTag.tagName + }" is not a valid HTML tag. Either use a valid "tagName" or set "customElement: true".`, ); } } diff --git a/packages/docusaurus/src/server/i18n.ts b/packages/docusaurus/src/server/i18n.ts index 9d97140b3a..8a80f4e648 100644 --- a/packages/docusaurus/src/server/i18n.ts +++ b/packages/docusaurus/src/server/i18n.ts @@ -9,7 +9,13 @@ import path from 'path'; import fs from 'fs-extra'; import logger from '@docusaurus/logger'; import combinePromises from 'combine-promises'; -import type {I18n, DocusaurusConfig, I18nLocaleConfig} from '@docusaurus/types'; +import {normalizeUrl} from '@docusaurus/utils'; +import type { + I18n, + DocusaurusConfig, + I18nLocaleConfig, + I18nConfig, +} from '@docusaurus/types'; function inferLanguageDisplayName(locale: string) { const tryLocale = (l: string) => { @@ -75,6 +81,7 @@ function getDefaultDirection(localeStr: string) { // see https://github.com/tc39/proposal-intl-locale-info // see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getTextInfo // Node 18.0 implements a former version of the getTextInfo() proposal + // TODO Docusaurus v4: remove the fallback to locale.textInfo // @ts-expect-error: The TC39 proposal was updated const textInto = locale.getTextInfo?.() ?? locale.textInfo; return textInto.direction; @@ -82,7 +89,7 @@ function getDefaultDirection(localeStr: string) { export function getDefaultLocaleConfig( locale: string, -): Omit { +): Omit { try { return { label: getDefaultLocaleLabel(locale), @@ -93,38 +100,60 @@ export function getDefaultLocaleConfig( }; } catch (e) { throw new Error( - `Docusaurus couldn't get default locale config for ${locale}`, + `Docusaurus couldn't infer a default locale config for ${logger.name( + locale, + )}. +Make sure it is a valid BCP 47 locale name (e.g. en, fr, fr-FR, etc.) and/or provide a valid BCP 47 ${logger.code( + `siteConfig.i18n.localeConfig['${locale}'].htmlLang`, + )} attribute.`, {cause: e}, ); } } +export function getLocaleList({ + i18nConfig, + currentLocale, +}: { + i18nConfig: I18nConfig; + currentLocale: string; +}): [string, ...string[]] { + if (!i18nConfig.locales.includes(currentLocale)) { + logger.warn`The locale name=${currentLocale} was not found in your Docusaurus site configuration. +We recommend adding the name=${currentLocale} to your site i18n config, but we will still try to run your site. +Declared site config locales are: ${i18nConfig.locales}`; + return i18nConfig.locales.concat(currentLocale) as [string, ...string[]]; + } + return i18nConfig.locales; +} + export async function loadI18n({ siteDir, config, currentLocale, + automaticBaseUrlLocalizationDisabled, }: { siteDir: string; config: DocusaurusConfig; currentLocale: string; + automaticBaseUrlLocalizationDisabled: boolean; }): Promise { const {i18n: i18nConfig} = config; - if (!i18nConfig.locales.includes(currentLocale)) { - logger.warn`The locale name=${currentLocale} was not found in your site configuration: Available locales are: ${i18nConfig.locales} -Note: Docusaurus only support running one locale at a time.`; - } - - const locales = i18nConfig.locales.includes(currentLocale) - ? i18nConfig.locales - : (i18nConfig.locales.concat(currentLocale) as [string, ...string[]]); + const locales = getLocaleList({ + i18nConfig, + currentLocale, + }); async function getFullLocaleConfig( locale: string, ): Promise { const localeConfigInput = i18nConfig.localeConfigs[locale] ?? {}; - const localeConfig: Omit = { - ...getDefaultLocaleConfig(locale), + const localeConfig: Omit< + I18nLocaleConfig, + 'translate' | 'url' | 'baseUrl' + > = { + ...getDefaultLocaleConfig(localeConfigInput.htmlLang ?? locale), ...localeConfigInput, }; @@ -138,10 +167,36 @@ Note: Docusaurus only support running one locale at a time.`; return fs.pathExists(localizationDir); } + function getInferredBaseUrl(): string { + const addLocaleSegment = + locale !== i18nConfig.defaultLocale && + !automaticBaseUrlLocalizationDisabled; + + return normalizeUrl([ + '/', + config.baseUrl, + addLocaleSegment ? locale : '', + '/', + ]); + } + const translate = localeConfigInput.translate ?? (await inferTranslate()); + + const url = + typeof localeConfigInput.url !== 'undefined' + ? localeConfigInput.url + : config.url; + + const baseUrl = + typeof localeConfigInput.baseUrl !== 'undefined' + ? normalizeUrl(['/', localeConfigInput.baseUrl, '/']) + : getInferredBaseUrl(); + return { ...localeConfig, translate, + url, + baseUrl, }; } diff --git a/packages/docusaurus/src/server/site.ts b/packages/docusaurus/src/server/site.ts index a48e68dd8a..df511c2645 100644 --- a/packages/docusaurus/src/server/site.ts +++ b/packages/docusaurus/src/server/site.ts @@ -7,7 +7,6 @@ import path from 'path'; import { - localizePath, DEFAULT_BUILD_DIR_NAME, GENERATED_FILES_DIR_NAME, getLocaleConfig, @@ -47,13 +46,21 @@ export type LoadContextParams = { config?: string; /** Default is `i18n.defaultLocale` */ locale?: string; + /** - * `true` means the paths will have the locale prepended; `false` means they - * won't (useful for `yarn build -l zh-Hans` where the output should be - * emitted into `build/` instead of `build/zh-Hans/`); `undefined` is like the - * "smart" option where only non-default locale paths are localized + * By default, we try to automatically infer a localized baseUrl. + * We prepend `//` with a `//` path segment, + * except for the default locale. + * + * This option permits opting out of this baseUrl localization process. + * It is mostly useful to simplify config for multi-domain i18n deployments. + * See https://docusaurus.io/docs/i18n/tutorial#multi-domain-deployment + * + * In all cases, this process doesn't happen if an explicit localized baseUrl + * has been provided using `i18n.localeConfigs[].baseUrl`. We always use the + * provided value over the inferred one, letting you override it. */ - localizePath?: boolean; + automaticBaseUrlLocalizationDisabled?: boolean; }; export type LoadSiteParams = LoadContextParams & { @@ -79,6 +86,7 @@ export async function loadContext( outDir: baseOutDir = DEFAULT_BUILD_DIR_NAME, locale, config: customConfigFilePath, + automaticBaseUrlLocalizationDisabled, } = params; const generatedFilesDir = path.resolve(siteDir, GENERATED_FILES_DIR_NAME); @@ -93,6 +101,15 @@ export async function loadContext( }), }); + // Not sure where is the best place to put this VCS initialization call? + // The sooner is probably the better + // Note: we don't await the result on purpose! + // VCS initialization can be slow for large repos, and we don't want to block + // VCS integrations should be carefully designed to avoid blocking + PerfLogger.async('VCS init', () => { + return initialSiteConfig.future.experimental_vcs.initialize({siteDir}); + }); + const currentBundler = await getCurrentBundler({ siteConfig: initialSiteConfig, }); @@ -101,27 +118,39 @@ export async function loadContext( siteDir, config: initialSiteConfig, currentLocale: locale ?? initialSiteConfig.i18n.defaultLocale, + automaticBaseUrlLocalizationDisabled: + automaticBaseUrlLocalizationDisabled ?? false, }); - const baseUrl = localizePath({ - path: initialSiteConfig.baseUrl, - i18n, - options: params, - pathType: 'url', - }); - const outDir = localizePath({ - path: path.resolve(siteDir, baseOutDir), - i18n, - options: params, - pathType: 'fs', - }); + const localeConfig = getLocaleConfig(i18n); + + // We use the baseUrl from the locale config. + // By default, it is inferred as // + // eventually including the // suffix + const baseUrl = localeConfig.baseUrl; + + // TODO not ideal: we should allow configuring a custom outDir for each locale + // The site baseUrl should be 100% decoupled from the file system output shape + // We added this logic to restore v3 retro-compatibility, because by default + // Docusaurus always wrote to ./build for sites having a baseUrl + // See also https://github.com/facebook/docusaurus/issues/11433 + // This logic assumes the locale baseUrl will start with the site baseUrl + // which is the case if an explicit locale baseUrl is not provided + // but in practice a custom locale baseUrl could be anything now + const outDirBaseUrl = baseUrl.replace(initialSiteConfig.baseUrl, '/'); + + const outDir = path.join(path.resolve(siteDir, baseOutDir), outDirBaseUrl); + const localizationDir = path.resolve( siteDir, i18n.path, getLocaleConfig(i18n).path, ); - const siteConfig: DocusaurusConfig = {...initialSiteConfig, baseUrl}; + const siteConfig: DocusaurusConfig = { + ...initialSiteConfig, + baseUrl, + }; const codeTranslations = await loadSiteCodeTranslations({localizationDir}); diff --git a/packages/docusaurus/src/webpack/__tests__/client.test.ts b/packages/docusaurus/src/webpack/__tests__/client.test.ts index 0f4968bfc5..6ed3a660f0 100644 --- a/packages/docusaurus/src/webpack/__tests__/client.test.ts +++ b/packages/docusaurus/src/webpack/__tests__/client.test.ts @@ -8,7 +8,7 @@ import webpack from 'webpack'; import {createBuildClientConfig, createStartClientConfig} from '../client'; -import {loadSetup} from '../../server/__tests__/testUtils'; +import {loadSiteFixture} from '../../server/__tests__/testUtils'; import {createConfigureWebpackUtils} from '../configure'; import { DEFAULT_FASTER_CONFIG, @@ -23,7 +23,7 @@ function createTestConfigureWebpackUtils() { describe('webpack dev config', () => { it('simple start', async () => { - const {props} = await loadSetup('simple-site'); + const {props} = await loadSiteFixture('simple-site'); const {clientConfig} = await createStartClientConfig({ props, faster: DEFAULT_FASTER_CONFIG, @@ -35,7 +35,7 @@ describe('webpack dev config', () => { }); it('simple build', async () => { - const {props} = await loadSetup('simple-site'); + const {props} = await loadSiteFixture('simple-site'); const {config} = await createBuildClientConfig({ props, faster: DEFAULT_FASTER_CONFIG, @@ -47,7 +47,7 @@ describe('webpack dev config', () => { }); it('custom start', async () => { - const {props} = await loadSetup('custom-site'); + const {props} = await loadSiteFixture('custom-site'); const {clientConfig} = await createStartClientConfig({ props, faster: DEFAULT_FASTER_CONFIG, @@ -59,7 +59,7 @@ describe('webpack dev config', () => { }); it('custom build', async () => { - const {props} = await loadSetup('custom-site'); + const {props} = await loadSiteFixture('custom-site'); const {config} = await createBuildClientConfig({ props, faster: DEFAULT_FASTER_CONFIG, diff --git a/packages/docusaurus/src/webpack/__tests__/server.test.ts b/packages/docusaurus/src/webpack/__tests__/server.test.ts index 8f4b750617..2a34183af2 100644 --- a/packages/docusaurus/src/webpack/__tests__/server.test.ts +++ b/packages/docusaurus/src/webpack/__tests__/server.test.ts @@ -9,7 +9,7 @@ import {jest} from '@jest/globals'; import webpack from 'webpack'; import createServerConfig from '../server'; -import {loadSetup} from '../../server/__tests__/testUtils'; +import {loadSiteFixture} from '../../server/__tests__/testUtils'; import {createConfigureWebpackUtils} from '../configure'; import {DEFAULT_FUTURE_CONFIG} from '../../server/configValidation'; @@ -22,7 +22,7 @@ function createTestConfigureWebpackUtils() { describe('webpack production config', () => { it('simple', async () => { jest.spyOn(console, 'log').mockImplementation(() => {}); - const {props} = await loadSetup('simple-site'); + const {props} = await loadSiteFixture('simple-site'); const {config} = await createServerConfig({ props, configureWebpackUtils: await createTestConfigureWebpackUtils(), @@ -32,7 +32,7 @@ describe('webpack production config', () => { it('custom', async () => { jest.spyOn(console, 'log').mockImplementation(() => {}); - const {props} = await loadSetup('custom-site'); + const {props} = await loadSiteFixture('custom-site'); const {config} = await createServerConfig({ props, configureWebpackUtils: await createTestConfigureWebpackUtils(), diff --git a/packages/docusaurus/src/webpack/aliases/__tests__/__fixtures__/theme-2/NavbarItem/SiblingNavbarItem.d.ts b/packages/docusaurus/src/webpack/aliases/__tests__/__fixtures__/theme-2/NavbarItem/SiblingNavbarItem.d.ts new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/docusaurus/src/webpack/aliases/__tests__/__fixtures__/theme-2/NavbarItem/SiblingNavbarItem.test.js b/packages/docusaurus/src/webpack/aliases/__tests__/__fixtures__/theme-2/NavbarItem/SiblingNavbarItem.test.js new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/docusaurus/src/webpack/aliases/__tests__/__fixtures__/theme-2/NavbarItem/SiblingNavbarItem.test.jsx b/packages/docusaurus/src/webpack/aliases/__tests__/__fixtures__/theme-2/NavbarItem/SiblingNavbarItem.test.jsx new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/docusaurus/src/webpack/aliases/__tests__/__fixtures__/theme-2/NavbarItem/SiblingNavbarItem.test.ts b/packages/docusaurus/src/webpack/aliases/__tests__/__fixtures__/theme-2/NavbarItem/SiblingNavbarItem.test.ts new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/docusaurus/src/webpack/aliases/__tests__/__fixtures__/theme-2/NavbarItem/SiblingNavbarItem.test.tsx b/packages/docusaurus/src/webpack/aliases/__tests__/__fixtures__/theme-2/NavbarItem/SiblingNavbarItem.test.tsx new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/docusaurus/src/webpack/aliases/__tests__/__fixtures__/theme-2/NavbarItem/__tests__/index.js b/packages/docusaurus/src/webpack/aliases/__tests__/__fixtures__/theme-2/NavbarItem/__tests__/index.js new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/docusaurus/src/webpack/aliases/index.ts b/packages/docusaurus/src/webpack/aliases/index.ts index dbade3a77e..03e14426b0 100644 --- a/packages/docusaurus/src/webpack/aliases/index.ts +++ b/packages/docusaurus/src/webpack/aliases/index.ts @@ -53,6 +53,13 @@ export async function createAliasesForTheme( const themeComponentFiles = await Globby(['**/*.{js,jsx,ts,tsx}'], { cwd: themePath, + ignore: [ + // Ignore co-located test files + '**/__tests__/**', + '**/*.test.{js,jsx,ts,tsx}', + // Ignore type declaration files + '**/*.d.ts', + ], }); const aliases: ThemeAliases = {}; diff --git a/packages/docusaurus/src/webpack/base.ts b/packages/docusaurus/src/webpack/base.ts index 3479d0041f..1132cb4bb4 100644 --- a/packages/docusaurus/src/webpack/base.ts +++ b/packages/docusaurus/src/webpack/base.ts @@ -13,7 +13,6 @@ import { getCSSExtractPlugin, getMinimizers, } from '@docusaurus/bundler'; - import {getFileLoaderUtils, md5Hash} from '@docusaurus/utils'; import {loadDocusaurusAliases, loadThemeAliases} from './aliases'; import {BundlerCPUProfilerPlugin} from './plugins/BundlerCPUProfilerPlugin'; @@ -28,14 +27,6 @@ const CSS_REGEX = /\.css$/i; const CSS_MODULE_REGEX = /\.module\.css$/i; export const clientDir = path.join(__dirname, '..', 'client'); -const LibrariesToTranspile = [ - 'copy-text-to-clipboard', // Contains optional catch binding, incompatible with recent versions of Edge -]; - -const LibrariesToTranspileRegex = new RegExp( - LibrariesToTranspile.map((libName) => `(node_modules/${libName})`).join('|'), -); - function getReactAliases(siteDir: string): Record { // Escape hatch if (process.env.DOCUSAURUS_NO_REACT_ALIASES) { @@ -58,8 +49,7 @@ export function excludeJS(modulePath: string): boolean { // Don't transpile node_modules except any docusaurus npm package return ( modulePath.includes('node_modules') && - !/docusaurus(?:(?!node_modules).)*\.jsx?$/.test(modulePath) && - !LibrariesToTranspileRegex.test(modulePath) + !/docusaurus(?:(?!node_modules).)*\.jsx?$/.test(modulePath) ); } @@ -181,9 +171,14 @@ export async function createBaseConfig({ experiments.incremental = false; } - if (process.env.ENABLE_RSPACK_LAZY_COMPILATION) { - console.log('Rspack lazyCompilation enabled'); - experiments.lazyCompilation = true; + // See https://rspack.rs/blog/announcing-1-5#barrel-file-optimization + if (process.env.DISABLE_RSPACK_LAZY_BARREL) { + console.log('Rspack lazyBarrel disabled'); + experiments.lazyBarrel = false; + } else { + // TODO remove after we upgrade to Rspack 1.6+ + // Enabled by default for Rspack >= 1.6 + experiments.lazyBarrel = true; } // TODO re-enable later, there's an Rspack performance issue diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json index 3a0548254a..8f7278644e 100644 --- a/packages/eslint-plugin/package.json +++ b/packages/eslint-plugin/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/eslint-plugin", - "version": "3.8.1", + "version": "3.9.2", "description": "ESLint plugin to enforce best Docusaurus practices.", "main": "lib/index.js", "keywords": [ @@ -31,6 +31,6 @@ "eslint": ">=6" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" } } diff --git a/packages/eslint-plugin/src/rules/no-untranslated-text.ts b/packages/eslint-plugin/src/rules/no-untranslated-text.ts index cdf416069a..a430425193 100644 --- a/packages/eslint-plugin/src/rules/no-untranslated-text.ts +++ b/packages/eslint-plugin/src/rules/no-untranslated-text.ts @@ -30,6 +30,9 @@ export default createRule({ properties: { ignoredStrings: { type: 'array', + items: { + type: 'string', + }, }, }, additionalProperties: false, diff --git a/packages/lqip-loader/package.json b/packages/lqip-loader/package.json index 8f9fc307bd..b501fb9ae6 100644 --- a/packages/lqip-loader/package.json +++ b/packages/lqip-loader/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/lqip-loader", - "version": "3.8.1", + "version": "3.9.2", "description": "Low Quality Image Placeholders (LQIP) loader for webpack.", "main": "lib/index.js", "publishConfig": { @@ -17,14 +17,14 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "3.8.1", + "@docusaurus/logger": "3.9.2", "file-loader": "^6.2.0", "lodash": "^4.17.21", "sharp": "^0.32.3", "tslib": "^2.6.0" }, "engines": { - "node": ">=18.0" + "node": ">=20.0" }, "devDependencies": { "@types/file-loader": "^5.0.1" diff --git a/packages/stylelint-copyright/package.json b/packages/stylelint-copyright/package.json index dfe3ef7603..ad120b3f7b 100644 --- a/packages/stylelint-copyright/package.json +++ b/packages/stylelint-copyright/package.json @@ -1,6 +1,6 @@ { "name": "stylelint-copyright", - "version": "3.8.1", + "version": "3.9.2", "description": "Stylelint plugin to check CSS files for a copyright header.", "main": "lib/index.js", "license": "MIT", diff --git a/project-words.txt b/project-words.txt index 467a8d0a2d..ffc0f083fc 100644 --- a/project-words.txt +++ b/project-words.txt @@ -27,6 +27,7 @@ Blockquotes blockquotes Bokmål bunx +BYOLLM caabernathy Candillon cdabcdab @@ -48,6 +49,8 @@ Csapo Csvg Dabit dabit +Dagre +dagre Daishi Datagit datagit @@ -84,6 +87,7 @@ Fienny flac Flightcontrol Flightcontrol's +forwardable FOUC Français froms @@ -136,6 +140,7 @@ lifecycles lightningcss Linkify linkify +longlonglonglonglonglonglonglonglonglonglonglong Lorber lorber Lorber's @@ -309,6 +314,7 @@ Sucipto sunsetting Supabase supabase +superproject svgs swizzlable Sébastien @@ -330,11 +336,11 @@ twoslash typesafe Typesense typesense +Udeadbeefcafe Unavatar unlinkable Unlisteds unlisteds -Unlocalized unlocalized unswizzle upvotes diff --git a/website/_dogfooding/_blog tests/2024-07-03-multiple-authors.mdx b/website/_dogfooding/_blog tests/2024-07-03-multiple-authors.mdx index b13b5215bd..59446635e7 100644 --- a/website/_dogfooding/_blog tests/2024-07-03-multiple-authors.mdx +++ b/website/_dogfooding/_blog tests/2024-07-03-multiple-authors.mdx @@ -11,6 +11,7 @@ authors: linkedin: https://www.linkedin.com/in/sebastienlorber/ instagram: https://www.instagram.com/thisweekinreact/ newsletter: https://thisweekinreact.com/newsletter + email: seb@example.com - name: Sébastien Lorber imageURL: https://github.com/slorber.png socials: diff --git a/website/_dogfooding/_blog tests/authors.yml b/website/_dogfooding/_blog tests/authors.yml index a7dac6a959..987c70a2c9 100644 --- a/website/_dogfooding/_blog tests/authors.yml +++ b/website/_dogfooding/_blog tests/authors.yml @@ -6,6 +6,7 @@ slorber: page: true socials: x: sebastienlorber + email: seb@example.com ozaki: name: ozaki diff --git a/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/_category_.json b/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/_category_.json new file mode 100644 index 0000000000..5367547df3 --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Category Index Name conflict 2", + "link": { + "type": "generated-index", + "title": "Category Index Name conflict 2", + "description": "Testing what happens when 2 categories with index docs have the same label" + } +} diff --git a/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/alpha/test/doc.md b/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/alpha/test/doc.md new file mode 100644 index 0000000000..3050004e61 --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/alpha/test/doc.md @@ -0,0 +1,3 @@ +# Doc + +This extra category doc is important, otherwise the category would be empty and the index would be converted to a regular doc. diff --git a/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/alpha/test/index.md b/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/alpha/test/index.md new file mode 100644 index 0000000000..36820bbea6 --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/alpha/test/index.md @@ -0,0 +1,6 @@ +--- +sidebar_label: 'Test' +sidebar_key: 'category-index-name-2.alpha.test' +--- + +# Test diff --git a/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/beta/test/doc.md b/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/beta/test/doc.md new file mode 100644 index 0000000000..3050004e61 --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/beta/test/doc.md @@ -0,0 +1,3 @@ +# Doc + +This extra category doc is important, otherwise the category would be empty and the index would be converted to a regular doc. diff --git a/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/beta/test/index.md b/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/beta/test/index.md new file mode 100644 index 0000000000..e076d71a69 --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/Conflicts/category-index-name-2/beta/test/index.md @@ -0,0 +1,6 @@ +--- +sidebar_label: 'Test' +sidebar_key: 'category-index-name-2.beta.test' +--- + +# Test diff --git a/website/_dogfooding/_docs tests/tests/footnotes.mdx b/website/_dogfooding/_docs tests/tests/footnotes.mdx new file mode 100644 index 0000000000..da28ea2d66 --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/footnotes.mdx @@ -0,0 +1,146 @@ +# Footnotes + +Lorem ipsum dolor sit amet [^1] [^2] + +Lorem ipsum dolor sit amet [^3] + +Lorem ipsum dolor sit amet [^4] + +Lorem ipsum dolor sit amet [^5] + +Lorem ipsum dolor sit amet [^6] + +Lorem ipsum dolor sit amet [^7] + +Lorem ipsum dolor sit amet [^8] + +Lorem ipsum dolor sit amet [^9] + +Lorem ipsum dolor sit amet [^10] + +Lorem ipsum dolor sit amet [^11] + +Lorem ipsum dolor sit amet [^12] + +Lorem ipsum dolor sit amet [^13] + +Lorem ipsum dolor sit amet [^14] + +Lorem ipsum dolor sit amet [^15] + +Lorem ipsum dolor sit amet [^16] + +Lorem ipsum dolor sit amet [^17] + +Lorem ipsum dolor sit amet [^18] + +Lorem ipsum dolor sit amet [^19] + +Lorem ipsum dolor sit amet [^20] + +Lorem ipsum dolor sit amet [^21] [^22] + +Lorem ipsum dolor sit amet [^23] + +Lorem ipsum dolor sit amet [^24] + +Lorem ipsum dolor sit amet [^25] + +Lorem ipsum dolor sit amet [^26] + +Lorem ipsum dolor sit amet [^27] + +Lorem ipsum dolor sit amet [^28] + +Lorem ipsum dolor sit amet [^29] + +Lorem ipsum dolor sit amet [^30] + +Lorem ipsum dolor sit amet [^31] + +Lorem ipsum dolor sit amet [^32] + +Lorem ipsum dolor sit amet [^33] + +Lorem ipsum dolor sit amet [^34] + +Lorem ipsum dolor sit amet [^35] + +Lorem ipsum dolor sit amet [^36] + +Lorem ipsum dolor sit amet [^37] + +Lorem ipsum dolor sit amet [^38] + +Lorem ipsum dolor sit amet [^39] + +Lorem ipsum dolor sit amet [^40] + +Lorem ipsum dolor sit amet [^41] + +Lorem ipsum dolor sit amet [^42] + +Lorem ipsum dolor sit amet [^43] + +Lorem ipsum dolor sit amet [^44] + +Lorem ipsum dolor sit amet [^45] + +Lorem ipsum dolor sit amet [^46] + +Lorem ipsum dolor sit amet [^47] + +Lorem ipsum dolor sit amet [^48] + +Lorem ipsum dolor sit amet [^49] [^50] + +[^1]: footnote 1 +[^2]: footnote 2 +[^3]: footnote 3 +[^4]: footnote 4 +[^5]: footnote 5 +[^6]: footnote 6 +[^7]: footnote 7 +[^8]: footnote 8 +[^9]: footnote 9 +[^10]: footnote 10 +[^11]: footnote 11 +[^12]: footnote 12 +[^13]: footnote 13 +[^14]: footnote 14 +[^15]: footnote 15 +[^16]: footnote 16 +[^17]: footnote 17 +[^18]: footnote 18 +[^19]: footnote 19 +[^20]: footnote 20 +[^21]: footnote 21 +[^22]: footnote 22 +[^23]: footnote 23 +[^24]: footnote 24 +[^25]: footnote 25 +[^26]: footnote 26 +[^27]: footnote 27 +[^28]: footnote 28 +[^29]: footnote 29 +[^30]: footnote 30 +[^31]: footnote 31 +[^32]: footnote 32 +[^33]: footnote 33 +[^34]: footnote 34 +[^35]: footnote 35 +[^36]: footnote 36 +[^37]: footnote 37 +[^38]: footnote 38 +[^39]: footnote 39 +[^40]: footnote 40 +[^41]: footnote 41 +[^42]: footnote 42 +[^43]: footnote 43 +[^44]: footnote 44 +[^45]: footnote 45 +[^46]: footnote 46 +[^47]: footnote 47 +[^48]: footnote 48 +[^49]: footnote 49 +[^50]: footnote 50 diff --git a/website/_dogfooding/_docs tests/tests/links/resolution/index.mdx b/website/_dogfooding/_docs tests/tests/links/resolution/index.mdx new file mode 100644 index 0000000000..7b842a7c02 --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/links/resolution/index.mdx @@ -0,0 +1,19 @@ +# Link resolution tests + +## Test for issue [#11099](https://github.com/facebook/docusaurus/issues/11099) + +These links should target the root `index.mdx` file: + +[`/index.mdx`](/index.mdx) + +[`@site/_dogfooding/_docs tests/index.mdx`](@site/_dogfooding/_docs%20tests/index.mdx) + +These links should target the current `index.mdx` file: + +[`/tests/links/index.mdx`](/tests/links/resolution/index.mdx) + +[`@site/_dogfooding/_docs tests/tests/links/resolution/index.mdx`](@site/_dogfooding/_docs%20tests/tests/links/resolution/index.mdx) + +[`index.mdx`](index.mdx) + +[`./index.mdx`](./index.mdx) diff --git a/website/_dogfooding/_docs tests/tests/sidebar-display/Category 2 Long Long Long Long Long Long Long Long Long Long Long/doc1.mdx b/website/_dogfooding/_docs tests/tests/sidebar-display/Category 2 Long Long Long Long Long Long Long Long Long Long Long/doc1.mdx new file mode 100644 index 0000000000..02823ef8d5 --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/sidebar-display/Category 2 Long Long Long Long Long Long Long Long Long Long Long/doc1.mdx @@ -0,0 +1 @@ +# Doc 1 diff --git a/website/_dogfooding/_docs tests/tests/sidebar-display/Category1LongLongLongLongLongLongLongLongLongLong/doc1.mdx b/website/_dogfooding/_docs tests/tests/sidebar-display/Category1LongLongLongLongLongLongLongLongLongLong/doc1.mdx new file mode 100644 index 0000000000..02823ef8d5 --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/sidebar-display/Category1LongLongLongLongLongLongLongLongLongLong/doc1.mdx @@ -0,0 +1 @@ +# Doc 1 diff --git a/website/_dogfooding/_docs tests/tests/sidebar-display/Category1LongLongLongLongLongLongLongLongLongLong/doc2 long long long long long long long long long long long long.mdx b/website/_dogfooding/_docs tests/tests/sidebar-display/Category1LongLongLongLongLongLongLongLongLongLong/doc2 long long long long long long long long long long long long.mdx new file mode 100644 index 0000000000..816e33bf62 --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/sidebar-display/Category1LongLongLongLongLongLongLongLongLongLong/doc2 long long long long long long long long long long long long.mdx @@ -0,0 +1 @@ +# Doc 2 long long long long long long long long long long long long diff --git a/website/_dogfooding/_docs tests/tests/sidebar-display/Category1LongLongLongLongLongLongLongLongLongLong/doc3longlonglonglonglonglonglonglonglonglonglonglong.mdx b/website/_dogfooding/_docs tests/tests/sidebar-display/Category1LongLongLongLongLongLongLongLongLongLong/doc3longlonglonglonglonglonglonglonglonglonglonglong.mdx new file mode 100644 index 0000000000..0d0eb1de3d --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/sidebar-display/Category1LongLongLongLongLongLongLongLongLongLong/doc3longlonglonglonglonglonglonglonglonglonglonglong.mdx @@ -0,0 +1 @@ +# Doc 3 longlonglonglonglonglonglonglonglonglonglonglong diff --git a/website/_dogfooding/_docs tests/tests/sidebar-display/_category_.json b/website/_dogfooding/_docs tests/tests/sidebar-display/_category_.json new file mode 100644 index 0000000000..8dcbb76c67 --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/sidebar-display/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "Sidebar Display", + "link": { + "type": "generated-index", + "title": "Sidebar Display", + "description": "Testing edge cases of how the docs sidebar is displayed" + }, + "position": 1 +} diff --git a/website/_dogfooding/_docs tests/tests/visibility/unlisted-except-index/index.mdx b/website/_dogfooding/_docs tests/tests/visibility/unlisted-except-index/index.mdx new file mode 100644 index 0000000000..84cb0f1feb --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/visibility/unlisted-except-index/index.mdx @@ -0,0 +1,7 @@ +# Unlisted Except Index + +This index page is listed, but the other pages are unlisted. + +import DocCardList from '@theme/DocCardList'; + + diff --git a/website/_dogfooding/_docs tests/tests/visibility/unlisted-except-index/unlisted1.mdx b/website/_dogfooding/_docs tests/tests/visibility/unlisted-except-index/unlisted1.mdx new file mode 100644 index 0000000000..e6ef3a75fe --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/visibility/unlisted-except-index/unlisted1.mdx @@ -0,0 +1,7 @@ +--- +unlisted: true +--- + +# Unlisted 1 + +This page is unlisted. diff --git a/website/_dogfooding/_docs tests/tests/visibility/unlisted-except-index/unlisted2.mdx b/website/_dogfooding/_docs tests/tests/visibility/unlisted-except-index/unlisted2.mdx new file mode 100644 index 0000000000..78a643b1c8 --- /dev/null +++ b/website/_dogfooding/_docs tests/tests/visibility/unlisted-except-index/unlisted2.mdx @@ -0,0 +1,7 @@ +--- +unlisted: true +--- + +# Unlisted 2 + +This page is unlisted. diff --git a/website/_dogfooding/_pages tests/code-block-tests.mdx b/website/_dogfooding/_pages tests/code-block-tests.mdx index dfff4af5a3..69034fdac4 100644 --- a/website/_dogfooding/_pages tests/code-block-tests.mdx +++ b/website/_dogfooding/_pages tests/code-block-tests.mdx @@ -226,6 +226,13 @@ function PageLayout(props) { } ``` +```jsx showLineNumbers=4 +function PageLayout(props) { + // highlight-next-line + return ; +} +``` + ```jsx {1,3,6} showLineNumbers function PageLayout(props) { console.log( diff --git a/website/_dogfooding/_pages tests/diagrams.mdx b/website/_dogfooding/_pages tests/diagrams.mdx index 1b11aa8d37..aba7585578 100644 --- a/website/_dogfooding/_pages tests/diagrams.mdx +++ b/website/_dogfooding/_pages tests/diagrams.mdx @@ -447,3 +447,88 @@ architecture-beta disk1:T -- B:server disk2:T -- B:db ``` + +## ELK Styling + +Mermaid provides an [ELK layout](https://mermaid.js.org/syntax/entityRelationshipDiagram.html#layout) + +### Dagre + +This is a "classical" Mermaid diagram, using the default Dagre layout. + +```mermaid +erDiagram + + COMPANY ||--o{ DEPARTMENT : has + COMPANY ||--o{ PROJECT : undertakes + COMPANY ||--o{ LOCATION : operates_in + COMPANY ||--o{ CLIENT : serves + + DEPARTMENT ||--o{ EMPLOYEE : employs + DEPARTMENT ||--o{ PROJECT : manages + DEPARTMENT ||--o{ BUDGET : allocated + + EMPLOYEE }o--o{ PROJECT : works_on + EMPLOYEE ||--|| ADDRESS : lives_at + EMPLOYEE }o--o{ SKILL : has + EMPLOYEE ||--o{ DEPENDENT : supports + + PROJECT ||--o{ CLIENT : for + PROJECT ||--o{ TASK : contains + +``` + +### ELK er diagram layout + +This ER diagram should look different, using the ELK layout. + +```mermaid +--- +config: + layout: elk +--- +erDiagram + + COMPANY ||--o{ DEPARTMENT : has + COMPANY ||--o{ PROJECT : undertakes + COMPANY ||--o{ LOCATION : operates_in + COMPANY ||--o{ CLIENT : serves + + DEPARTMENT ||--o{ EMPLOYEE : employs + DEPARTMENT ||--o{ PROJECT : manages + DEPARTMENT ||--o{ BUDGET : allocated + + EMPLOYEE }o--o{ PROJECT : works_on + EMPLOYEE ||--|| ADDRESS : lives_at + EMPLOYEE }o--o{ SKILL : has + EMPLOYEE ||--o{ DEPENDENT : supports + + PROJECT ||--o{ CLIENT : for + PROJECT ||--o{ TASK : contains + +``` + +Mermaid also provides a way of setting config parameters using a directive `%%{init:{"layout":"elk"}}%%` + +```mermaid +%%{init:{"layout":"elk"}}%% +erDiagram + + COMPANY ||--o{ DEPARTMENT : has + COMPANY ||--o{ PROJECT : undertakes + COMPANY ||--o{ LOCATION : operates_in + COMPANY ||--o{ CLIENT : serves + + DEPARTMENT ||--o{ EMPLOYEE : employs + DEPARTMENT ||--o{ PROJECT : manages + DEPARTMENT ||--o{ BUDGET : allocated + + EMPLOYEE }o--o{ PROJECT : works_on + EMPLOYEE ||--|| ADDRESS : lives_at + EMPLOYEE }o--o{ SKILL : has + EMPLOYEE ||--o{ DEPENDENT : supports + + PROJECT ||--o{ CLIENT : for + PROJECT ||--o{ TASK : contains + +``` diff --git a/website/_dogfooding/_pages tests/markdown-tests-mdx.mdx b/website/_dogfooding/_pages tests/markdown-tests-mdx.mdx index ec3a7534af..55153cd3ca 100644 --- a/website/_dogfooding/_pages tests/markdown-tests-mdx.mdx +++ b/website/_dogfooding/_pages tests/markdown-tests-mdx.mdx @@ -360,15 +360,10 @@ This is a test page to see if Docusaurus Markdown features are working properly See [#3337](https://github.com/facebook/docusaurus/issues/3337) - [/someFile.pdf](/someFile.pdf) - - [/someFile.xyz](/someFile.xyz) - - [/image with space.png]() - - [@site/\_dogfooding/\_asset-tests/someFile.pdf](@site/_dogfooding/_asset-tests/someFile.pdf) - - [@site/\_dogfooding/\_asset-tests/someFile.xyz](@site/_dogfooding/_asset-tests/someFile.xyz) - - [@site/\_dogfooding/\_asset-tests/image with space.png](<@site/_dogfooding/_asset-tests/image with spaces.png>) ### Linking to non-SPA page hosted within website @@ -376,13 +371,16 @@ See [#3337](https://github.com/facebook/docusaurus/issues/3337) See [#3309](https://github.com/facebook/docusaurus/issues/3309) - [pathname:///dogfooding/javadoc](pathname:///dogfooding/javadoc) - - [pathname:///dogfooding/javadoc/index.html](pathname:///dogfooding/javadoc/index.html) - - [pathname://../dogfooding/javadoc](pathname://../dogfooding/javadoc) - - [pathname://../dogfooding/javadoc/index.html](pathname://../dogfooding/javadoc/index.html) +### Linking to non-SPA paths with custom schemes + +- [customScheme://whatever](customScheme://whatever) +- [custom-scheme://whatever](custom-scheme://whatever) +- [custom-sch.eme+-.://whatever](custom-sch.eme+-.://whatever) + ### Linking to non-SPA page with Link component See [#9758](https://github.com/facebook/docusaurus/issues/9758), these external urls should not be reported by the broken links checker: diff --git a/website/blog/releases/3.9/img/askai.png b/website/blog/releases/3.9/img/askai.png new file mode 100644 index 0000000000..1c88b5f101 Binary files /dev/null and b/website/blog/releases/3.9/img/askai.png differ diff --git a/website/blog/releases/3.9/img/social-card.png b/website/blog/releases/3.9/img/social-card.png new file mode 100644 index 0000000000..1d40a2bdac Binary files /dev/null and b/website/blog/releases/3.9/img/social-card.png differ diff --git a/website/blog/releases/3.9/index.mdx b/website/blog/releases/3.9/index.mdx new file mode 100644 index 0000000000..d1631588f8 --- /dev/null +++ b/website/blog/releases/3.9/index.mdx @@ -0,0 +1,158 @@ +--- +title: Docusaurus 3.9 +authors: [slorber] +tags: [release] +image: ./img/social-card.png +date: 2025-09-25 +--- + +We are happy to announce **Docusaurus 3.9**. + +This release drops support for Node.js 18, adds support for Algolia DocSearch v4 with AskAI, improves i18n support, adds Mermaid ELK layout support, and comes with various other improvements and bug fixes. + +Upgrading is easy. We follow [Semantic Versioning](https://semver.org/), and minor version updates have **no breaking changes**, accordingly to our [release process](/community/release-process). Note that **we consider dropping End-of-Life Node.js versions as non-breaking changes**. + +![Docusaurus blog post social card](./img/social-card.png) + +{/* truncate */} + +```mdx-code-block +import BrowserWindow from '@site/src/components/BrowserWindow'; +``` + +## Dropping Node.js 18 + +In [#11408](https://github.com/facebook/docusaurus/pull/11408), we have dropped support for Node.js 18, and the new minimum required Node.js version is now v20.0. + +Although it may look like a runtime requirement breaking change, Node.js 18 reached [End-of-Life](https://nodejs.org/en/about/releases/). It [won't receive security updates](https://nodejs.org/en/blog/announcements/node-18-eol-support), and you shouldn't use it anymore. Dropping End-of-Life versions of Node.js on minor version releases is a common practice in the Node.js ecosystem, that we now officially endorse and document on our [release process](/community/release-process#nodejs-support). + +This upgrade is further motivated by our dependencies: + +- Some of our dependencies now only receive security patches on newer versions that do not support Node.js 18 anymore. See, for example, this [`webpack-dev-server@4` security warning](https://github.com/facebook/docusaurus/pull/11410). To keep the Docusaurus v3 release line secure for our users, for both the runtime and third-party dependencies, the upgrade is necessary. +- Some of our dependencies are also dropping support for Node.js 18 in minor releases, transitively impacting Docusaurus runtime requirements. For example, [Rspack 1.5 now requires Node.js 18.12](https://rspack.rs/blog/announcing-1-5), while Docusaurus v3 initially supported Node.js 18.0. + +## DocSearch v4 + +In [#11327](https://github.com/facebook/docusaurus/pull/11327) and [#11421](https://github.com/facebook/docusaurus/pull/11421), we added support for Algolia DocSearch v4. This new version comes with [AskAI](https://docsearch.algolia.com/docs/v4/askai) support, letting you add an AI-powered search assistant to your Docusaurus site that can answer questions based on what's in your documentation with a conversational experience. + +```mdx-code-block + + <>![Algolia DocSearch v4 - Ask AI screenshot](./img/askai.png) + +``` + +:::tip DocSearch v4 is opt-in + +Docusaurus v3 adds support for DocSearch v4 while keeping support for DocSearch v3. + +Existing sites using DocSearch v3 can either stay on v3 or upgrade to v4 using their package manager (npm command: `npm update @docsearch/react`). + +When using DocSearch v4, the new AskAI feature is not enabled by default: you also need to [create an AskAI assistant](https://docsearch.algolia.com/docs/v4/askai/) and add it to the [`themeConfig.algolia.askAi` config attribute](/docs/search#ask-ai). + +::: + +## i18n improvements + +In [#11316](https://github.com/facebook/docusaurus/pull/11316), we added new `i18n.localeConfigs[locale].{url,baseUrl}` config options to better support complex and multi-domain i18n deployments. Previously, Docusaurus relied on hard-coded heuristics that made sense for most i18n projects, but weren't flexible enough to accommodate all use cases, leading UX and SEO issues. It is now possible to configure each locale's deployment URL and base URL independently, overriding the default values inferred by Docusaurus: + +```ts title="docusaurus.config.js" +export default { + i18n: { + defaultLocale: 'en', + locales: ['en', 'fr'], + localeConfigs: { + en: { + // highlight-start + url: 'https://en.docusaurus.io', + baseUrl: '/', + // highlight-end + }, + fr: { + // highlight-start + url: 'https://fr.docusaurus.io', + baseUrl: '/', + // highlight-end + }, + }, + }, +}; +``` + +In [#11304](https://github.com/facebook/docusaurus/pull/11304), we optimized our i18n infrastructure with a new `i18n.localeConfigs[locale].translate` flag that is now `false` by default for sites that do not use any translations. This leads to an improved dev experience and faster builds for non-i18n sites by avoiding unnecessary file system read attempts of the `i18n` directory. + +In [#11228](https://github.com/facebook/docusaurus/pull/11228), we added a new `key` attribute to the docs sidebar items, allowing to assign explicit translation keys to each sidebar item that use the same label and would otherwise lead to translation key conflicts: + +```ts title="sidebars.js" +export default { + sidebar: [ + { + type: 'category', + label: 'API', + // highlight-next-line + key: 'api-for-feature-1', + items: [], + }, + { + type: 'category', + label: 'API', + // highlight-next-line + key: 'api-for-feature-2', + items: [], + }, + ], +}; +``` + +## Mermaid ELK layouts + +In [#11357](https://github.com/facebook/docusaurus/pull/11357), we added support for [Mermaid ELK layout algorithm](https://mermaid.js.org/intro/syntax-reference.html#supported-layout-algorithms), based on the [Eclipse Layout Kernel (ELK)](https://www.eclipse.org/elk/). Compared to the default Dagre layout, it provides more sophisticated layout capabilities and configuration options, especially useful when working with large or intricate diagrams. + +You can enable it by adding the extra `@mermaid-js/layout-elk` npm dependency, making it possible to use the `layout: elk` Mermaid diagram metadata: + +````md +```mermaid +--- +config: +# highlight-next-line + layout: elk +--- +erDiagram + CUSTOMER ||--o{ ORDER : places + ORDER ||--|{ LINE-ITEM : contains + CUSTOMER }|..|{ DELIVERY-ADDRESS : uses +``` +```` + +```mermaid +--- +config: + layout: elk +--- +erDiagram + CUSTOMER ||--o{ ORDER : places + ORDER ||--|{ LINE-ITEM : contains + CUSTOMER }|..|{ DELIVERY-ADDRESS : uses +``` + +## Translations + +- 🇧🇷 [#11315](https://github.com/facebook/docusaurus/pull/11315): Add missing Brazilian Portuguese theme translations. +- 🇺🇦 [#11305](https://github.com/facebook/docusaurus/pull/11305): Add missing Ukrainian theme translations. + +## Other changes + +Other notable changes include: + +- In [#11283](https://github.com/facebook/docusaurus/pull/11283), we added `siteConfig.markdown.hooks.{onBrokenMarkdownLinks,onBrokenMarkdownImages}` and deprecated `siteConfig.onBrokenMarkdownLinks`. The new callback hooks also let you recover from broken links/images by returning a fallback URL. +- In [#11282](https://github.com/facebook/docusaurus/pull/11282), we added the `siteConfig.markdown.emoji` config option to disable the previously hard-coded `remark-emoji` behavior. +- In [#11397](https://github.com/facebook/docusaurus/pull/11397), we can now resolve site-aliased Markdown links starting with `@site/*`, that we already supported for ES imports. +- In [#11294](https://github.com/facebook/docusaurus/pull/11294) and [#11415](https://github.com/facebook/docusaurus/pull/11415), we upgraded to Rspack 1.5 and leveraging new Rspack config options to make Docusaurus build faster. +- In [#11356](https://github.com/facebook/docusaurus/pull/11356), we improved the display of docs sidebar items with long labels. +- In [#11405](https://github.com/facebook/docusaurus/pull/11405), we improved visual glitches caused by the `useColorMode()` hook when switching color modes, glitches that also affected your site's logo in the navbar. +- In [#11383](https://github.com/facebook/docusaurus/pull/11383), we disabled a Docusaurus Faster HTML minifier optimization that prevents your site's social card from displaying properly on some social platforms (e.g., LinkedIn). +- In [#11425](https://github.com/facebook/docusaurus/pull/11425), we added the ability for blog authors to display an email icon with a `mailto:` link (`author.socials.email`). +- In [#11422](https://github.com/facebook/docusaurus/pull/11422), we removed the `copy-text-to-clipboard` in favor of the native `navigator.clipboard` API. + +Check the **[3.9.0 changelog entry](/changelog/3.9.0)** for an exhaustive list of changes. diff --git a/website/community/2-resources.mdx b/website/community/2-resources.mdx index beaef3be10..25b8362bf8 100644 --- a/website/community/2-resources.mdx +++ b/website/community/2-resources.mdx @@ -70,7 +70,9 @@ See the
    showcase - [docusaurus-openapi-docs](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs) - A Docusaurus plugin and theme for generating interactive OpenAPI docs - [docusaurus-post-generator](https://github.com/moojing/docusaurus-post-generator) - A command line tool for user to add a blog/doc file quickly by command like `yarn gen-post new [template] [post_name]`. - [docusaurus-graph](https://github.com/Arsero/docusaurus-graph) - A Docusaurus plugin for generating a graph view showing links between documentation files. -- [docusaurus-i18n](https://github.com/moonrailgun/docusaurus-i18n) - Auto translate docusaurus documents with openai. +- [docusaurus-i18n](https://github.com/moonrailgun/docusaurus-i18n) - Auto-translate docusaurus documents with openai. +- [docusaurus-plugin-glossary](https://github.com/mcclowes/docusaurus-plugin-glossary) - A docusaurus plugin for helping users understand key terms. +- [docusaurus-plugin-cookie-consent](https://github.com/mcclowes/docusaurus-plugin-cookie-consent) - A Docusaurus plugin for allowing users to opt in/out of cookies, and accessing those settings in code. ## Enterprise usage {#enterprise-usage} diff --git a/website/community/5-release-process.mdx b/website/community/5-release-process.mdx index 5377f3dd65..a30cdaaddc 100644 --- a/website/community/5-release-process.mdx +++ b/website/community/5-release-process.mdx @@ -49,6 +49,12 @@ If you only use our [public API surface](#public-api-surface), you should be abl ::: +:::caution About End-of-Life Node.js versions + +We may drop support for End-of-Life Node.js versions in minor Docusaurus versions. Check the [Node.js support policy](#nodejs-support) section for more details. + +::: + ### Patch versions {#patch-versions} The `patch` version number is incremented on bugfixes releases. @@ -57,6 +63,16 @@ Whenever a new patch version is released, we publish: - an exhaustive changelog entry +## Node.js support policy {#nodejs-support} + +Each major version of Docusaurus supports a minimum Node.js version. This retro-compatibility will be preserved all along that release line. This runtime backward compatibility will be preserved throughout all the minor versions of the release line, except for End-of-Life Node.js versions. + +:::caution Support for End-of-Life versions + +On minor releases, we reserve the right to drop support for Node.js versions that reached End-of-Life ([Node.js release process and schedule](https://nodejs.org/en/about/previous-releases). **We do not consider it a Docusaurus breaking change**. We highly recommend using a maintained Node.js version. Beware that [End-of-Life Node.js versions do not receive security updates anymore](https://nodejs.org/en/blog/announcements/node-18-eol-support). + +::: + ## Versions {#versions} ```mdx-code-block diff --git a/website/docs/api/docusaurus.config.js.mdx b/website/docs/api/docusaurus.config.js.mdx index 351da0421a..a21ebbcf17 100644 --- a/website/docs/api/docusaurus.config.js.mdx +++ b/website/docs/api/docusaurus.config.js.mdx @@ -84,11 +84,24 @@ export default { }; ``` +:::info Special case for i18n sites + +If your site uses multiple locales, it is possible to provide a distinct `url` for each locale thanks to the [`siteConfig.i18n.localeConfigs[].url`](#i18n) attribute. This makes it possible to deploy a localized Docusaurus site [deploy a localized Docusaurus site over multiple domains](../i18n/i18n-tutorial.mdx#multi-domain-deployment). + +::: + ### `baseUrl` {#baseUrl} - Type: `string` -Base URL for your site. Can be considered as the path after the host. For example, `/metro/` is the base URL of https://facebook.github.io/metro/. For URLs that have no path, the baseUrl should be set to `/`. This field is related to the [`url`](#url) field. Always has both leading and trailing slash. +The base URL of your site is the path segment appearing just after the [`url`](#url), letting you eventually host your site under a subpath instead of at the root of the domain. + +For example, let's consider you want to host a site at https://facebook.github.io/metro/, then you must configure it accordingly: + +- [`url`](#url) should be `'https://facebook.github.io'` +- `baseUrl` should be `'/metro/'` + +By default, a Docusaurus site is hosted at the root of the domain: ```js title="docusaurus.config.js" export default { @@ -96,6 +109,18 @@ export default { }; ``` +:::info Special case for i18n sites + +If your site uses multiple locales, then Docusaurus will automatically localize the `baseUrl` of your site based on smart heuristics: + +- For the default locale, `baseUrl` will be `//` +- For other locales, `baseUrl` will be `///` +- When building a single locale at a time (with `docusaurus build --locale `), `baseUrl` will be `//`, assuming the intent is to [deploy each locale on distinct domains](../i18n/i18n-tutorial.mdx#multi-domain-deployment). + +When the localized `baseUrl` Docusaurus computes doesn't satisfy you, it's always possible to override it by providing an explicit localized `baseUrl` thanks to the [`siteConfig.i18n.localeConfigs[].baseUrl`](#i18n) attribute. + +::: + ## Optional fields {#optional-fields} ### `favicon` {#favicon} @@ -152,6 +177,8 @@ export default { calendar: 'gregory', path: 'en', translate: false, + url: 'https://en.example.com', + baseUrl: '/', }, fa: { label: 'فارسی', @@ -160,6 +187,8 @@ export default { calendar: 'persian', path: 'fa', translate: true, + url: 'https://fa.example.com', + baseUrl: '/', }, }, }, @@ -176,6 +205,8 @@ export default { - `calendar`: the [calendar](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/calendar) used to calculate the date era. Note that it doesn't control the actual string displayed: `MM/DD/YYYY` and `DD/MM/YYYY` are both `gregory`. To choose the format (`DD/MM/YYYY` or `MM/DD/YYYY`), set your locale name to `en-GB` or `en-US` (`en` means `en-US`). - `path`: Root folder that all plugin localization folders of this locale are relative to. Will be resolved against `i18n.path`. Defaults to the locale's name (`i18n/`). Note: this has no effect on the locale's `baseUrl`—customization of base URL is a work-in-progress. - `translate`: Should we run the translation process for this locale? By default, it is enabled if the `i18n/` folder exists + - `url`: This lets you override the [`siteConfig.url`](#url), particularly useful if your site is [deployed over multiple domains](../i18n/i18n-tutorial.mdx#multi-domain-deployment). + - `baseUrl`: This lets you override the default localized `baseUrl` Docusaurus infers from your [`siteConfig.baseUrl`](#baseUrl), giving you more control to host your localized site in less common ways, in particularly [deployments over multi-domains](../i18n/i18n-tutorial.mdx#multi-domain-deployment) ### `future` {#future} @@ -235,10 +266,100 @@ export default { - [`rspackPersistentCache`](https://github.com/facebook/docusaurus/pull/10931): Use [Rspack Persistent Cache](https://rspack.dev/config/cache) to re-build your app faster on subsequent builds. Requires `rspackBundler: true`. Requires persisting `./node_modules/.cache` across rebuilds. - [`mdxCrossCompilerCache`](https://github.com/facebook/docusaurus/pull/10479): Compile MDX files only once for both browser/Node.js environments instead of twice. - [`ssgWorkerThreads`](https://github.com/facebook/docusaurus/pull/10826): Using a Node.js worker thread pool to execute the static site generation phase faster. Requires `future.v4.removeLegacyPostBuildHeadAttribute` to be turned on. + - [`gitEagerVcs`](https://github.com/facebook/docusaurus/pull/11512): Upgrades the default [VCS strategy](#vcs) to `default-v2`, that reads your whole Git repository at once instead of per-file, making Git operations faster on large repositories. - `experimental_storage`: Site-wide browser storage options that theme authors should strive to respect. - `type`: The browser storage theme authors should use. Possible values are `localStorage` and `sessionStorage`. Defaults to `localStorage`. - `namespace`: Whether to namespace the browser storage keys to avoid storage key conflicts when Docusaurus sites are hosted under the same domain, or on localhost. Possible values are `string | boolean`. The namespace is appended at the end of the storage keys `key-namespace`. Use `true` to automatically generate a random namespace from your site `url + baseUrl`. Defaults to `false` (no namespace, historical behavior). - `experimental_router`: The router type to use. Possible values are `browser` and `hash`. Defaults to `browser`. The `hash` router is only useful for rare cases where you want to opt-out of static site generation, have a fully client-side app with a single `index.html` entrypoint file. This can be useful to distribute a Docusaurus site as a `.zip` archive that you can [browse locally without running a web server](https://github.com/facebook/docusaurus/issues/3825). +- [`experimental_vcs`](#vcs): The Version Control System (VCS) implementation to use to read file info (creation/last update date/author). Read the [dedicated section](#vcs) below for details. + +#### `experimental_vcs` {#vcs} + +This exposes an API that lets you provide your own Version Control System (VCS) implementation to read file info (creation/last update date/author). + +```ts +export default { + future: { + experimental_vcs: { + initialize: ({siteDir}) => { + // Initialize your VCS client here. + // If you want to read your VCS eagerly/incrementally on startup, + // this is the place to do it. + // This function is synchronous on purpose and not awaited + // It should not delay Docusaurus startup, but be run in parallel. + }, + getFileCreationInfo: async (filePath: string) => { + // Provide your own implementation to read file creation info. + return getFileCreationInfo(filePath); + }, + getFileLastUpdateInfo: async (filePath: string) => { + // Provide your own implementation to read file creation info. + return getFileLastUpdateInfo(filePath); + }, + }, + }, +}; +``` + +##### VCS Presets {#vcs-presets} + +It is possible to pass a boolean VCS value: + +- `true`: enables the default VCS preset (`default-v1` or `default-v2`, depending on the Docusaurus Faster `gitEagerVcs` flag value) +- `false`: disables the VCS, always returns `null` for all files + +```ts +export default { + future: { + experimental_vcs: true, // Enables the default VCS preset + }, +}; +``` + +It is also possible to choose VCS preset we provide out of the box by its name. + +```ts +export default { + future: { + experimental_vcs: 'presetName', + }, +}; +``` + +The available preset names are: + +- `git-ad-hoc`: the historical `git log ` based strategy. +- `git-eager`: the new Git strategy that reads your whole repository upfront. +- `hardcoded`: returns hardcoded value, useful in dev/tests to speed up developer experience. +- `disabled`: returns `null` for all files, considering them untracked. +- `default-v1`: the historical default (`git-ad-hoc` in prod, `hardcoded` in dev) +- `default-v2`: the upcoming default (`git-eager` in prod, `hardcoded` in dev) + +Unless you have specific needs, we recommend using the default presets (`default-v1` or `default-v2`), that skip reading file info in development mode for better performance. + +##### VCS Types {#vcs-types} + +```ts +type VcsChangeInfo = {timestamp: number; author: string}; + +type VscInitializeParams = { + siteDir: string; +}; + +type VcsConfig = { + initialize: (params: VscInitializeParams) => void; + getFileCreationInfo: (filePath: string) => Promise; + getFileLastUpdateInfo: (filePath: string) => Promise; +}; + +type VcsPreset = + | 'git-ad-hoc' + | 'git-eager' + | 'hardcoded' + | 'disabled' + | 'default-v1' + | 'default-v2'; +``` ### `noIndex` {#noIndex} @@ -509,7 +630,7 @@ type MDX1CompatOptions = headingIds: boolean; }; -export type ParseFrontMatter = (params: { +type ParseFrontMatter = (params: { filePath: string; fileContent: string; defaultParseFrontMatter: ParseFrontMatter; @@ -603,7 +724,7 @@ export default { | `remarkRehypeOptions` | `object` | `undefined` | Makes it possible to pass custom [`remark-rehype` options](https://github.com/remarkjs/remark-rehype#options). | | `hooks` | `MarkdownHooks` | `object` | Make it possible to customize the MDX loader behavior with callbacks or built-in options. | | `hooks.onBrokenMarkdownLinks` | `ReportingSeverity \| OnBrokenMarkdownLinksFunction` | `'warn'` | Hook to customize the behavior when encountering a broken Markdown link URL. With the callback function, you can return a new link URL, or alter the link [mdast node](https://github.com/syntax-tree/mdast). | -| `hooks.onBrokenMarkdownLinks` | `ReportingSeverity \| OnBrokenMarkdownImagesFunction` | `'throw'` | Hook to customize the behavior when encountering a broken Markdown image URL. With the callback function, you can return a new image URL, or alter the image [mdast node](https://github.com/syntax-tree/mdast). | +| `hooks.onBrokenMarkdownImages` | `ReportingSeverity \| OnBrokenMarkdownImagesFunction` | `'throw'` | Hook to customize the behavior when encountering a broken Markdown image URL. With the callback function, you can return a new image URL, or alter the image [mdast node](https://github.com/syntax-tree/mdast). | ```mdx-code-block @@ -646,9 +767,9 @@ export default { ### `headTags` {#headTags} -An array of tags that will be inserted in the HTML ``. The values must be objects that contain two properties; `tagName` and `attributes`. `tagName` must be a string that determines the tag being created; eg `"link"`. `attributes` must be an attribute-value map. +An array of tags that will be inserted in the HTML ``. The values must be objects that contain two properties; `tagName` and `attributes`. `tagName` must be a string that determines the tag being created; eg `"link"`. `attributes` must be an attribute-value map. When custom html elements are needed, set `customElement: true`. -- Type: `{ tagName: string; attributes: Object; }[]` +- Type: `{ tagName: string; attributes: Object; customElement?: boolean; }[]` Example: diff --git a/website/docs/api/plugins/overview.mdx b/website/docs/api/plugins/overview.mdx index 6109d4eb20..94ecbed65c 100644 --- a/website/docs/api/plugins/overview.mdx +++ b/website/docs/api/plugins/overview.mdx @@ -31,4 +31,4 @@ These plugins will add a useful behavior to your Docusaurus site. - [@docusaurus/plugin-google-analytics](./plugin-google-analytics.mdx) - [@docusaurus/plugin-google-gtag](./plugin-google-gtag.mdx) - [@docusaurus/plugin-google-tag-manager](./plugin-google-tag-manager.mdx) -- [@docusaurus/plugin-css-cascade-layers](./plugin-css-cascade-layers.mdx) u +- [@docusaurus/plugin-css-cascade-layers](./plugin-css-cascade-layers.mdx) diff --git a/website/docs/api/plugins/plugin-content-blog.mdx b/website/docs/api/plugins/plugin-content-blog.mdx index 8dee6fdcda..f8a17e4347 100644 --- a/website/docs/api/plugins/plugin-content-blog.mdx +++ b/website/docs/api/plugins/plugin-content-blog.mdx @@ -281,7 +281,7 @@ type AuthorKey = string; // Social platform name -> Social platform link // Example: {MyPlatform: 'https://myplatform.com/myusername'} // Pre-defined platforms -// ("x", "github", "twitter", "linkedin", "stackoverflow", "instagram", "bluesky", "mastodon", "threads", "twitch", "youtube") accept handles: +// ("x", "github", "twitter", "linkedin", "stackoverflow", "instagram", "bluesky", "mastodon", "threads", "twitch", "youtube", "email") accept handles: // Example: {github: 'slorber'} type AuthorSocials = Record; @@ -368,6 +368,7 @@ slorber: socials: x: sebastienlorber github: slorber + email: seb@example.com jmarcey: name: Joel Marcey diff --git a/website/docs/api/plugins/plugin-content-docs.mdx b/website/docs/api/plugins/plugin-content-docs.mdx index fa9ddbf53e..324e2f5004 100644 --- a/website/docs/api/plugins/plugin-content-docs.mdx +++ b/website/docs/api/plugins/plugin-content-docs.mdx @@ -282,6 +282,7 @@ Accepted fields: | `sidebar_label` | `string` | `title` | The text shown in the document sidebar for this document. | | `sidebar_position` | `number` | Default ordering | Controls the position of a doc inside the generated sidebar slice when using `autogenerated` sidebar items. See also [Autogenerated sidebar metadata](/docs/sidebar/autogenerated#autogenerated-sidebar-metadata). | | `sidebar_class_name` | `string` | `undefined` | Gives the corresponding sidebar label a special class name when using autogenerated sidebars. | +| `sidebar_key` | `string` | `undefined` | Gives the corresponding sidebar item a key to uniquely identify the sidebar item. This is mostly useful for i18n sites to generate unique translation keys for categories sharing the same labels. An error will tell you when this extra metadata is needed. | | `sidebar_custom_props` | `object` | `undefined` | Assign [custom props](../../guides/docs/sidebar/index.mdx#passing-custom-props) to the sidebar item referencing this doc | | `displayed_sidebar` | `string` | `undefined` | Force the display of a given sidebar when browsing the current document. Read the [multiple sidebars guide](../../guides/docs/sidebar/multiple-sidebars.mdx) for details. | | `hide_title` | `boolean` | `false` | Whether to hide the title at the top of the doc. It only hides a title declared through the front matter, and have no effect on a Markdown title at the top of your document. | diff --git a/website/docs/blog.mdx b/website/docs/blog.mdx index aec3c7b3a9..92a9551150 100644 --- a/website/docs/blog.mdx +++ b/website/docs/blog.mdx @@ -62,6 +62,7 @@ authors: socials: x: sebastienlorber github: slorber + email: seb@example.com tags: [hello, docusaurus-v2] image: https://i.imgur.com/mErPwqL.png hide_table_of_contents: false @@ -303,6 +304,7 @@ slorber: socials: x: sebastienlorber github: slorber + email: seb@example.com ``` :::tip diff --git a/website/docs/deployment.mdx b/website/docs/deployment.mdx index 98f8f02cfa..18b79e86e3 100644 --- a/website/docs/deployment.mdx +++ b/website/docs/deployment.mdx @@ -401,7 +401,7 @@ jobs: fetch-depth: 0 - uses: actions/setup-node@v4 with: - node-version: 18 + node-version: 20 cache: npm - name: Install dependencies @@ -455,7 +455,7 @@ jobs: fetch-depth: 0 - uses: actions/setup-node@v4 with: - node-version: 18 + node-version: 20 cache: npm - name: Install dependencies @@ -487,7 +487,7 @@ jobs: fetch-depth: 0 - uses: actions/setup-node@v4 with: - node-version: 18 + node-version: 20 cache: yarn - name: Install dependencies @@ -541,7 +541,7 @@ jobs: fetch-depth: 0 - uses: actions/setup-node@v4 with: - node-version: 18 + node-version: 20 cache: yarn - name: Install dependencies @@ -608,7 +608,7 @@ jobs: fetch-depth: 0 - uses: actions/setup-node@v4 with: - node-version: 18 + node-version: 20 cache: yarn - name: Install dependencies run: yarn install --frozen-lockfile @@ -623,7 +623,7 @@ jobs: fetch-depth: 0 - uses: actions/setup-node@v4 with: - node-version: 18 + node-version: 20 cache: yarn - uses: webfactory/ssh-agent@v0.5.0 with: @@ -675,7 +675,7 @@ Continuous integration (CI) services are typically used to perform routine tasks ```yml title=".travis.yml" language: node_js node_js: - - 18 + - 20 branches: only: - main @@ -734,7 +734,7 @@ steps: - task: NodeTool@0 inputs: - versionSpec: '18' + versionSpec: '20' displayName: Install Node.js - script: | diff --git a/website/docs/guides/docs/docs-create-doc.mdx b/website/docs/guides/docs/docs-create-doc.mdx index caf8e2ea77..b45cf6d331 100644 --- a/website/docs/guides/docs/docs-create-doc.mdx +++ b/website/docs/guides/docs/docs-create-doc.mdx @@ -128,13 +128,15 @@ The ID is used to refer to a document when hand-writing sidebars, or when using ### Doc URLs {#doc-urls} -By default, a document's URL location is its file path relative to the `docs` folder, with a few exceptions. Namely, if a file is named one the following, the file name won't be included in the URL: +By default, the document's URL location is derived from the [document `id`](#document-id), which in turn is based on the document's file path. + +If a file is named one of the following, the file name won't be included in the URL: - Named as `index` (case-insensitive): `docs/Guides/index.md` - Named as `README` (case-insensitive): `docs/Guides/README.mdx` - Same name as parent folder: `docs/Guides/Guides.md` -In all cases, the default slug would only be `/Guides`, without the `/index`, `/README`, or duplicate `/Guides` segment. +In all cases, the default `slug` would only be `/Guides`, without the `/index`, `/README`, or duplicate `/Guides` segment. :::note @@ -142,7 +144,7 @@ This convention is exactly the same as [the category index convention](./sidebar ::: -Use the `slug` front matter to change a document's URL. +Use the `slug` front matter to provide an explicit document URL and override the default one. For example, suppose your site structure looks like this: @@ -153,7 +155,7 @@ website # Root directory of your site └── hello.md ``` -By default `hello.md` will be available at `/docs/guide/hello`. You can change its URL location to `/docs/bonjour`: +By default, `hello.md` will be available at `/docs/guide/hello`. You can change its URL location to `/docs/bonjour`: ```md --- @@ -174,6 +176,14 @@ It is possible to use: ::: +:::tip + +Changing a document's filename or `id`, will change its default URL. To prevent breaking permalinks when renaming files, we recommend setting an explicit `slug` to keep your URLs stable. + +::: + +#### Making a document available at the root + If you want a document to be available at the root, and have a path like `https://docusaurus.io/docs/`, you can use the slug front matter: ```md diff --git a/website/docs/guides/docs/sidebar/autogenerated.mdx b/website/docs/guides/docs/sidebar/autogenerated.mdx index 7e3bfcf0a0..f59ae806dc 100644 --- a/website/docs/guides/docs/sidebar/autogenerated.mdx +++ b/website/docs/guides/docs/sidebar/autogenerated.mdx @@ -310,7 +310,7 @@ For handwritten sidebar definitions, you would provide metadata to sidebar items ### Doc item metadata {#doc-item-metadata} -The `label`, `className`, and `customProps` attributes are declared in front matter as `sidebar_label`, `sidebar_class_name`, and `sidebar_custom_props`, respectively. Position can be specified in the same way, via `sidebar_position` front matter. +The `label`, `className`, `key`, and `customProps` attributes are declared in front matter as `sidebar_label`, `sidebar_class_name`, `sidebar_key` and `sidebar_custom_props`, respectively. Position can be specified in the same way, via `sidebar_position` front matter. ```md title="docs/tutorials/tutorial-easy.md" --- @@ -318,6 +318,7 @@ The `label`, `className`, and `customProps` attributes are declared in front mat sidebar_position: 2 sidebar_label: Easy sidebar_class_name: green +sidebar_key: unique-sidebar-item-key # highlight-end --- @@ -328,7 +329,7 @@ This is the easy tutorial! ### Category item metadata {#category-item-metadata} -Add a `_category_.json` or `_category_.yml` file in the respective folder. You can specify any category metadata and also the `position` metadata. `label`, `className`, `position`, and `customProps` will default to the respective values of the category's linked doc, if there is one. +Add a `_category_.json` or `_category_.yml` file in the respective folder. You can specify any category metadata and also the `position` metadata. `label`, `className`, `key`, `position`, and `customProps` will default to the respective values of the category's linked doc, if there is one. @@ -337,6 +338,7 @@ Add a `_category_.json` or `_category_.yml` file in the respective folder. You c { "position": 2.5, "label": "Tutorial", + "key": "unique-sidebar-item-key", "collapsible": true, "collapsed": false, "className": "red", diff --git a/website/docs/guides/markdown-features/markdown-features-diagrams.mdx b/website/docs/guides/markdown-features/markdown-features-diagrams.mdx index b8d652c0a3..829f971eeb 100644 --- a/website/docs/guides/markdown-features/markdown-features-diagrams.mdx +++ b/website/docs/guides/markdown-features/markdown-features-diagrams.mdx @@ -99,3 +99,36 @@ import Mermaid from '@theme/Mermaid'; C-->D;`} /> ``` + +## Layouts + +Mermaid supports different [layout engines](https://mermaid.js.org/intro/syntax-reference.html#layout-and-look): + +- The `dagre` layout engine is supported by default in Docusaurus. +- The `elk` layout engine is heavier and can be enabled by installing the optional `@mermaid-js/layout-elk` dependency. + +````md +```mermaid +--- +config: + layout: elk +--- +graph TD; + A-->B; + A-->C; + B-->D; + C-->D; +``` +```` + +```mermaid +--- +config: + layout: elk +--- +graph TD; + A-->B; + A-->C; + B-->D; + C-->D; +``` diff --git a/website/docs/guides/markdown-features/markdown-features-links.mdx b/website/docs/guides/markdown-features/markdown-features-links.mdx index 47a37100ca..5bd0127855 100644 --- a/website/docs/guides/markdown-features/markdown-features-links.mdx +++ b/website/docs/guides/markdown-features/markdown-features-links.mdx @@ -29,13 +29,17 @@ Reference to another [document in a subfolder](subfolder/doc3.mdx). Relative file paths are resolved against the current file's directory. Absolute file paths, on the other hand, are resolved relative to the **content root**, usually `docs/`, `blog/`, or [localized ones](../../i18n/i18n-tutorial.mdx) like `i18n/zh-Hans/plugin-content-docs/current`. -Absolute file paths can also be relative to the site directory. However, beware that links that begin with `/docs/` or `/blog/` are **not portable** as you would need to manually update them if you create new doc versions or localize them. +Here are some examples of file path links and how they get resolved, assuming the current file is `website/docs/category/source.mdx`: -```md -You can write [links](/otherFolder/doc4.mdx) relative to the content root (`/docs/`). +- `[link](./target.mdx)` is resolved from the current file's directory `website/docs/category`. +- `[link](../target.mdx)` is resolved from the parent file's directory `website/docs`. +- `[link](/target.mdx)` is resolved from the docs content root `website/docs`, using in priority the localized docs. +- `[link](target.mdx)` is resolved from the current directory `website/docs/category`, then from the docs content roots, then from the site root. -You can also write [links](/docs/otherFolder/doc4.mdx) relative to the site directory, but it's not recommended. -``` +Absolute file paths can also be relative to the site directory. However, beware that links that begin with `/docs/`, `/blog/` or `@site/` are **not portable** as you would need to manually update them if you create new doc versions or localize them: + +- `[link](/docs/target.mdx)` is resolved from the site root `website` (⚠️ less portable). +- `[link](@site/docs/target.mdx)` is relative to the site root `website` (⚠️ less portable). Using relative _file_ paths (with `.md` extensions) instead of relative _URL_ links provides the following benefits: diff --git a/website/docs/i18n/i18n-tutorial.mdx b/website/docs/i18n/i18n-tutorial.mdx index a88e2f0a38..b76768fae5 100644 --- a/website/docs/i18n/i18n-tutorial.mdx +++ b/website/docs/i18n/i18n-tutorial.mdx @@ -453,6 +453,14 @@ For localized sites, it is recommended to use **[explicit heading IDs](../guides You can choose to deploy your site under a **single domain** or use **multiple (sub)domains**. +:::tip About localized baseUrls + +Docusaurus will automatically add a `//` path segment to your site for locales except the default one. This heuristic works well for most sites but can be configured on a per-locale basis depending on your deployment requirements. + +Read more on the [`siteConfig.baseUrl`](../api/docusaurus.config.js.mdx#baseUrl) docs. + +::: + ### Single-domain deployment {#single-domain-deployment} Run the following command: @@ -495,7 +503,7 @@ You can also build your site for a single locale: npm run build -- --locale fr ``` -Docusaurus will not add the `/fr/` URL prefix. +When building a single locale at a time, Docusaurus will not add the `/fr/` URL prefix automatically, assuming you want to deploy each locale to a distinct domain. On your [static hosting provider](../deployment.mdx): @@ -503,6 +511,37 @@ On your [static hosting provider](../deployment.mdx): - configure the appropriate build command, using the `--locale` option - configure the (sub)domain of your choice for each deployment +:::tip Configuring URLs for each locale + +Use the [`siteConfig.i18n.localeConfigs[].url`](./../api/docusaurus.config.js.mdx#i18n) attribute to configure a distinct site URL for each locale: + +```ts title=docusaurus.config.js +const config = { + i18n: { + localeConfigs: { + // highlight-start + en: { + url: 'https://en.docusaurus.io', + baseUrl: '/', + }, + fr: { + url: 'https://fr.docusaurus.io', + baseUrl: '/', + }, + // highlight-end + }, + }, +}; +``` + +This helps [search engines like Google know about localized versions of your page](https://developers.google.com/search/docs/specialty/international/localized-versions) thanks to `` meta tags. + +This also permits Docusaurus themes to redirect users to the appropriate URL when they switch locale, usually through the [Navbar locale dropdown](../api/themes/theme-configuration.mdx#navbar-locale-dropdown). + +Read more on the [`siteConfig.url`](../api/docusaurus.config.js.mdx#baseUrl) and [`siteConfig.baseUrl`](../api/docusaurus.config.js.mdx#baseUrl) docs. + +::: + :::warning This strategy is **not possible** with GitHub Pages, as it is only possible to **have a single deployment**. diff --git a/website/docs/installation.mdx b/website/docs/installation.mdx index 1295709b94..df6ffa3d7d 100644 --- a/website/docs/installation.mdx +++ b/website/docs/installation.mdx @@ -21,7 +21,7 @@ Use **[docusaurus.new](https://docusaurus.new)** to test Docusaurus immediately ## Requirements {#requirements} -- [Node.js](https://nodejs.org/en/download/) version 18.0 or above (which can be checked by running `node -v`). You can use [nvm](https://github.com/nvm-sh/nvm) to manage multiple Node.js versions on a single machine. +- [Node.js](https://nodejs.org/en/download/) version 20.0 or above (which can be checked by running `node -v`). You can use [nvm](https://github.com/nvm-sh/nvm) to manage multiple Node.js versions on a single machine. - When installing Node.js, it is recommended to check all checkboxes related to dependencies. ## Scaffold project website {#scaffold-project-website} diff --git a/website/docs/search.mdx b/website/docs/search.mdx index c3264f62ca..905b6b9a52 100644 --- a/website/docs/search.mdx +++ b/website/docs/search.mdx @@ -127,6 +127,9 @@ export default { // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default) insights: false, + // Optional: whether you want to use the new Ask AI feature (undefined by default) + askAi: 'YOUR_ALGOLIA_ASK_AI_ASSISTANT_ID', + //... other Algolia params }, // highlight-end @@ -214,6 +217,54 @@ If you only get search results when Contextual Search is disabled, this is very ::: +### Ask AI {#ask-ai} + +Ask AI is a new feature that allows you to ask questions about your documentation. + +Ask AI brings the power of AI to your documentation: + +- **Conversational search:** Users can ask questions in natural language and get context-aware answers. +- **Completely free:** Ask AI is available at no additional cost. You'll pay only for the LLM usage to your provider. +- **BYOLLM (Bring Your Own LLM):** You can use your own language model provider, giving you full control over the AI experience. +- **Direct Algolia index integration:** The provider/models retrieve relevant context directly from your Algolia index, ensuring accurate and up-to-date answers. +- **Recently asked & conversation history:** Easily revisit your recent questions and jump back into previous Ask AI conversations. +- **Seamless integration:** Ask AI is available directly from the search modal. + +To enable it, add an `askAi` field in your `algolia` config: + +```js title="docusaurus.config.js" +export default { + // ... + themeConfig: { + // ... + algolia: { + // highlight-start + askAi: 'YOUR_ALGOLIA_ASK_AI_ASSISTANT_ID', + // highlight-end + + // highlight-start + // OR with custom parameters + askAi: { + assistantId: 'YOUR_ALGOLIA_ASK_AI_ASSISTANT_ID', + indexName: 'YOUR_ALGOLIA_INDEX_NAME', + apiKey: 'YOUR_ALGOLIA_API_KEY', + appId: 'YOUR_ALGOLIA_APP_ID', + suggestedQuestions: true, // Optional: enable suggested questions (default: false) + }, + // highlight-end + + //... other Algolia params + }, + }, +}; +``` + +:::info + +To use Ask AI, you need to have an Algolia index with the Ask AI assistant enabled. Learn more about [how to setup Ask AI](https://docsearch.algolia.com/docs/v4/askai). + +::: + ### Styling your Algolia search {#styling-your-algolia-search} By default, DocSearch comes with a fine-tuned theme that was designed for accessibility, making sure that colors and contrasts respect standards. diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 7ed001e3e0..a2639973ca 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -25,7 +25,7 @@ import ConfigLocalized from './docusaurus.config.localized.json'; import PrismLight from './src/utils/prismLight'; import PrismDark from './src/utils/prismDark'; -import type {Config, DocusaurusConfig} from '@docusaurus/types'; +import type {Config, DocusaurusConfig, VcsPreset} from '@docusaurus/types'; import type * as Preset from '@docusaurus/preset-classic'; import type {Options as DocsOptions} from '@docusaurus/plugin-content-docs'; @@ -108,6 +108,8 @@ if (isSlower) { const router = process.env .DOCUSAURUS_ROUTER as DocusaurusConfig['future']['experimental_router']; +const vcs = process.env.DOCUSAURUS_SITE_VCS as VcsPreset; + const isDev = process.env.NODE_ENV === 'development'; // See https://docs.netlify.com/configure-builds/environment-variables/ @@ -160,7 +162,8 @@ function getLocalizedConfigValue(key: keyof typeof ConfigLocalized) { // By default, we don't want to run "git log" commands on i18n sites // This makes localized sites build much slower on Netlify // See also https://github.com/facebook/docusaurus/issues/11208 -const showLastUpdate = process.env.DOCUSAURUS_CURRENT_LOCALE === defaultLocale; +// const showLastUpdate = process.env.DOCUSAURUS_CURRENT_LOCALE === defaultLocale; +const showLastUpdate = true; export default async function createConfigAsync() { return { @@ -185,10 +188,12 @@ export default async function createConfigAsync() { rspackBundler: true, rspackPersistentCache: true, ssgWorkerThreads: true, + gitEagerVcs: true, }, experimental_storage: { namespace: true, }, + experimental_vcs: vcs, experimental_router: router, }, // Dogfood both settings: @@ -204,6 +209,14 @@ export default async function createConfigAsync() { i18n: { defaultLocale, + localeConfigs: { + [defaultLocale]: { + // Forces the translation process to run for default locale + // Permits to dogfood translation key conflicts detection + translate: true, + }, + }, + locales: isDeployPreview || isBranchDeploy ? // Deploy preview and branch deploys: keep them fast! @@ -655,6 +668,22 @@ export default async function createConfigAsync() { appId: 'X1Z85QJPUV', apiKey: 'bf7211c161e8205da2f933a02534105a', indexName: 'docusaurus-2', + + // TODO Docusaurus v4: remove after we drop DocSearch v3 + // temporary, for DocSearch v3/v4 conditional Ask AI integration + // see https://github.com/facebook/docusaurus/pull/11327 + // eslint-disable-next-line @typescript-eslint/no-var-requires,global-require + ...(require('@docsearch/react').version.startsWith('4.') + ? { + askAi: { + // cSpell:ignore IMYF + assistantId: 'RgIMYFUmTfrN', + indexName: 'docusaurus-markdown', + suggestedQuestions: true, + }, + } + : {}), + replaceSearchResultPathname: isDev || isDeployPreview ? { diff --git a/website/netlify.toml b/website/netlify.toml index c2e4762e96..2e2e8fec7d 100644 --- a/website/netlify.toml +++ b/website/netlify.toml @@ -11,21 +11,26 @@ [build.environment] NETLIFY_USE_YARN = "true" YARN_VERSION = "1.22.19" - NODE_VERSION = "22" + NODE_VERSION = "24" NODE_OPTIONS = "--max_old_space_size=8192" + +# Note, we run build:packages and git backfill in parallel to speed up builds +# We run "git backfill" here to ensure the full Git history is available fast +# See https://github.com/facebook/docusaurus/pull/11553 + [context.production] - command = "yarn --cwd .. build:packages && yarn netlify:build:production" + command = "(echo 'Build packages start' && yarn --cwd .. build:packages && echo 'Build packages end') & (echo 'Git backfill start' && git backfill && echo 'Git backfill end' ) & wait && yarn netlify:build:production" [context.branch-deploy] - command = "yarn --cwd .. build:packages && yarn netlify:build:branchDeploy" + command = "(echo 'Build packages start' && yarn --cwd .. build:packages && echo 'Build packages end') & (echo 'Git backfill start' && git backfill && echo 'Git backfill end' ) & wait && yarn netlify:build:branchDeploy" [context.deploy-preview] - command = "yarn --cwd .. build:packages && yarn netlify:build:deployPreview" + command = "(echo 'Build packages start' && yarn --cwd .. build:packages && echo 'Build packages end') & (echo 'Git backfill start' && git backfill && echo 'Git backfill end' ) & wait && yarn netlify:build:deployPreview" [[plugins]] package = "netlify-plugin-cache" [plugins.inputs] paths = [ - "node_modules/.cache/webpack", + "node_modules/.cache", ] diff --git a/website/package.json b/website/package.json index 15fe623c78..2578d4964f 100644 --- a/website/package.json +++ b/website/package.json @@ -1,6 +1,6 @@ { "name": "website", - "version": "3.8.1", + "version": "3.9.2", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -39,22 +39,24 @@ "dependencies": { "@crowdin/cli": "^3.13.0", "@crowdin/crowdin-api-client": "^1.29.5", - "@docusaurus/core": "3.8.1", - "@docusaurus/logger": "3.8.1", - "@docusaurus/plugin-client-redirects": "3.8.1", - "@docusaurus/plugin-ideal-image": "3.8.1", - "@docusaurus/plugin-pwa": "3.8.1", - "@docusaurus/plugin-rsdoctor": "3.8.1", - "@docusaurus/preset-classic": "3.8.1", - "@docusaurus/remark-plugin-npm2yarn": "3.8.1", - "@docusaurus/theme-classic": "3.8.1", - "@docusaurus/theme-common": "3.8.1", - "@docusaurus/theme-live-codeblock": "3.8.1", - "@docusaurus/theme-mermaid": "3.8.1", - "@docusaurus/utils": "3.8.1", - "@docusaurus/utils-common": "3.8.1", + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/plugin-client-redirects": "3.9.2", + "@docusaurus/plugin-ideal-image": "3.9.2", + "@docusaurus/plugin-pwa": "3.9.2", + "@docusaurus/plugin-rsdoctor": "3.9.2", + "@docusaurus/preset-classic": "3.9.2", + "@docusaurus/remark-plugin-npm2yarn": "3.9.2", + "@docusaurus/theme-classic": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/theme-live-codeblock": "3.9.2", + "@docusaurus/theme-mermaid": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@mermaid-js/layout-elk": "^0.1.9", "clsx": "^2.0.0", "color": "^4.2.3", + "execa": "^5.1.1", "fs-extra": "^11.1.1", "netlify-plugin-cache": "^1.0.3", "raw-loader": "^4.0.2", @@ -83,8 +85,8 @@ ] }, "devDependencies": { - "@docusaurus/eslint-plugin": "3.8.1", - "@docusaurus/tsconfig": "3.8.1", + "@docusaurus/eslint-plugin": "3.9.2", + "@docusaurus/tsconfig": "3.9.2", "@types/color": "^3.0.4", "@types/jest": "^29.5.3", "cross-env": "^7.0.3", diff --git a/website/src/data/users.tsx b/website/src/data/users.tsx index b742cd17e9..357989da69 100644 --- a/website/src/data/users.tsx +++ b/website/src/data/users.tsx @@ -158,7 +158,7 @@ const Users: User[] = [ }, { title: 'Blogasaurus', - description: 'A blog written using Docasaurus.', + description: 'A blog written using Docusaurus.', preview: require('./showcase/blogasaurus.png'), website: 'https://blog.palashsh.me/', source: 'https://github.com/BattleOfPlassey/blogasaurus', diff --git a/website/src/pages/styles.module.css b/website/src/pages/styles.module.css index 051294057e..9912eee6ae 100644 --- a/website/src/pages/styles.module.css +++ b/website/src/pages/styles.module.css @@ -58,18 +58,28 @@ display: flex; flex-direction: column; align-items: center; + overflow: hidden; } .topBannerTitle { font-size: 54px; font-weight: bold; margin-bottom: 0.4rem; -} - -@media only screen and (max-width: 768px) { - .topBannerTitle { + @media only screen and (max-width: 768px) { font-size: 40px; } + @media only screen and (max-width: 768px) { + font-size: 40px; + } + @media only screen and (max-width: 450px) { + font-size: 32px; + } + @media only screen and (max-width: 350px) { + font-size: 24px; + } + @media only screen and (max-width: 250px) { + font-size: 16px; + } } .topBannerTitleText { @@ -166,6 +176,7 @@ html[data-theme='dark'] .topBannerTitleText { flex-wrap: wrap; align-items: center; margin-top: 24px; + overflow: hidden; } .indexCtas a, diff --git a/website/src/pages/versions.tsx b/website/src/pages/versions.tsx index 5e453e27d1..a54985643c 100644 --- a/website/src/pages/versions.tsx +++ b/website/src/pages/versions.tsx @@ -12,6 +12,7 @@ import Translate from '@docusaurus/Translate'; import { useVersions, useLatestVersion, + type GlobalVersion, } from '@docusaurus/plugin-content-docs/client'; import Layout from '@theme/Layout'; import Heading from '@theme/Heading'; @@ -49,6 +50,13 @@ export default function Version(): ReactNode { ); const repoUrl = `https://github.com/${organizationName!}/${projectName!}`; + function getReleaseNotesUrl(version: GlobalVersion): string { + if (version.name === '2.x') { + return 'https://github.com/facebook/docusaurus/blob/main/CHANGELOG-v2.md'; + } + return `${repoUrl}/releases/tag/v${version.name}`; + } + return ( - + @@ -142,7 +150,7 @@ export default function Version(): ReactNode { - + diff --git a/website/versioned_docs/version-3.8.1/deployment.mdx b/website/versioned_docs/version-3.8.1/deployment.mdx index 5a6cfb00ee..98f8f02cfa 100644 --- a/website/versioned_docs/version-3.8.1/deployment.mdx +++ b/website/versioned_docs/version-3.8.1/deployment.mdx @@ -407,7 +407,7 @@ jobs: - name: Install dependencies run: npm ci - name: Build website - run: npm build + run: npm run build - name: Upload Build Artifact uses: actions/upload-pages-artifact@v3 @@ -461,7 +461,7 @@ jobs: - name: Install dependencies run: npm ci - name: Test build website - run: npm build + run: npm run build ``` diff --git a/website/versioned_docs/version-3.9.2/advanced/architecture.mdx b/website/versioned_docs/version-3.9.2/advanced/architecture.mdx new file mode 100644 index 0000000000..8d1f8bdb2d --- /dev/null +++ b/website/versioned_docs/version-3.9.2/advanced/architecture.mdx @@ -0,0 +1,28 @@ +--- +description: How Docusaurus works to build your app +--- + +# Architecture + +```mdx-code-block +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import Zoom from 'react-medium-image-zoom'; +``` + + + +![Architecture overview](/img/architecture.png) + + + +This diagram shows how Docusaurus works to build your app. Plugins each collect their content and emit JSON data; themes provide layout components which receive the JSON data as route modules. The bundler bundles all the components and emits a server bundle and a client bundle. + +Although you (either plugin authors or site creators) are writing JavaScript all the time, bear in mind that the JS is actually run in different environments: + +- All plugin lifecycle methods are run in Node. Therefore, until we support ES Modules in our codebase, plugin source code must be provided as ES modules that can be imported, or CommonJS that can be `require`'d. +- The theme code is built with Webpack. They can be provided as ESM—following React conventions. + +Plugin code and theme code never directly import each other: they only communicate through protocols (in our case, through JSON temp files and calls to `addRoute`). A useful mental model is to imagine that the plugins are not written in JavaScript, but in another language like Rust. The only way to interact with plugins for the user is through `docusaurus.config.js`, which itself is run in Node (hence you can use `require` and pass callbacks as plugin options). + +During bundling, the config file itself is serialized and bundled, allowing the theme to access config options like `themeConfig` or `baseUrl` through [`useDocusaurusContext()`](../docusaurus-core.mdx#useDocusaurusContext). However, the `siteConfig` object only contains **serializable values** (values that are preserved after `JSON.stringify()`). Functions, regexes, etc. would be lost on the client side. The `themeConfig` is designed to be entirely serializable. diff --git a/website/versioned_docs/version-3.9.2/advanced/client.mdx b/website/versioned_docs/version-3.9.2/advanced/client.mdx new file mode 100644 index 0000000000..f4d37d296d --- /dev/null +++ b/website/versioned_docs/version-3.9.2/advanced/client.mdx @@ -0,0 +1,184 @@ +--- +description: How the Docusaurus client is structured +--- + +# Client architecture + +## Theme aliases {#theme-aliases} + +A theme works by exporting a set of components, e.g. `Navbar`, `Layout`, `Footer`, to render the data passed down from plugins. Docusaurus and users use these components by importing them using the `@theme` webpack alias: + +```js +import Navbar from '@theme/Navbar'; +``` + +The alias `@theme` can refer to a few directories, in the following priority: + +1. A user's `website/src/theme` directory, which is a special directory that has the higher precedence. +2. A Docusaurus theme package's `theme` directory. +3. Fallback components provided by Docusaurus core (usually not needed). + +This is called a _layered architecture_: a higher-priority layer providing the component would shadow a lower-priority layer, making swizzling possible. Given the following structure: + +``` +website +├── node_modules +│ └── @docusaurus/theme-classic +│ └── theme +│ └── Navbar.js +└── src + └── theme + └── Navbar.js +``` + +`website/src/theme/Navbar.js` takes precedence whenever `@theme/Navbar` is imported. This behavior is called component swizzling. If you are familiar with Objective C where a function's implementation can be swapped during runtime, it's the exact same concept here with changing the target `@theme/Navbar` is pointing to! + +We already talked about how the "userland theme" in `src/theme` can re-use a theme component through the [`@theme-original`](../swizzling.mdx#wrapping) alias. One theme package can also wrap a component from another theme, by importing the component from the initial theme, using the `@theme-init` import. + +Here's an example of using this feature to enhance the default theme `CodeBlock` component with a `react-live` playground feature. + +```js +import InitialCodeBlock from '@theme-init/CodeBlock'; +import React from 'react'; + +export default function CodeBlock(props) { + return props.live ? ( + + ) : ( + + ); +} +``` + +Check the code of `@docusaurus/theme-live-codeblock` for details. + +:::warning + +Unless you want to publish a re-usable "theme enhancer" (like `@docusaurus/theme-live-codeblock`), you likely don't need `@theme-init`. + +::: + +It can be quite hard to wrap your mind around these aliases. Let's imagine the following case with a super convoluted setup with three themes/plugins and the site itself all trying to define the same component. Internally, Docusaurus loads these themes as a "stack". + +```text ++-------------------------------------------------+ +| `website/src/theme/CodeBlock.js` | <-- `@theme/CodeBlock` always points to the top ++-------------------------------------------------+ +| `theme-live-codeblock/theme/CodeBlock/index.js` | <-- `@theme-original/CodeBlock` points to the topmost non-swizzled component ++-------------------------------------------------+ +| `plugin-awesome-codeblock/theme/CodeBlock.js` | ++-------------------------------------------------+ +| `theme-classic/theme/CodeBlock/index.js` | <-- `@theme-init/CodeBlock` always points to the bottom ++-------------------------------------------------+ +``` + +The components in this "stack" are pushed in the order of `preset plugins > preset themes > plugins > themes > site`, so the swizzled component in `website/src/theme` always comes out on top because it's loaded last. + +`@theme/*` always points to the topmost component—when `CodeBlock` is swizzled, all other components requesting `@theme/CodeBlock` receive the swizzled version. + +`@theme-original/*` always points to the topmost non-swizzled component. That's why you can import `@theme-original/CodeBlock` in the swizzled component—it points to the next one in the "component stack", a theme-provided one. Plugin authors should not try to use this because your component could be the topmost component and cause a self-import. + +`@theme-init/*` always points to the bottommost component—usually, this comes from the theme or plugin that first provides this component. Individual plugins / themes trying to enhance code block can safely use `@theme-init/CodeBlock` to get its basic version. Site creators should generally not use this because you likely want to enhance the _topmost_ instead of the _bottommost_ component. It's also possible that the `@theme-init/CodeBlock` alias does not exist at all—Docusaurus only creates it when it points to a different one from `@theme-original/CodeBlock`, i.e. when it's provided by more than one theme. We don't waste aliases! + +## Client modules {#client-modules} + +Client modules are part of your site's bundle, just like theme components. However, they are usually side-effect-ful. Client modules are anything that can be `import`ed by Webpack—CSS, JS, etc. JS scripts usually work on the global context, like registering event listeners, creating global variables... + +These modules are imported globally before React even renders the initial UI. + +```js title="@docusaurus/core/App.tsx" +// How it works under the hood +import '@generated/client-modules'; +``` + +Plugins and sites can both declare client modules, through [`getClientModules`](../api/plugin-methods/lifecycle-apis.mdx#getClientModules) and [`siteConfig.clientModules`](../api/docusaurus.config.js.mdx#clientModules), respectively. + +Client modules are called during server-side rendering as well, so remember to check the [execution environment](./ssg.mdx#escape-hatches) before accessing client-side globals. + +```js title="mySiteGlobalJs.js" +import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment'; + +if (ExecutionEnvironment.canUseDOM) { + // As soon as the site loads in the browser, register a global event listener + window.addEventListener('keydown', (e) => { + if (e.code === 'Period') { + location.assign(location.href.replace('.com', '.dev')); + } + }); +} +``` + +CSS stylesheets imported as client modules are [global](../styling-layout.mdx#global-styles). + +```css title="mySiteGlobalCss.css" +/* This stylesheet is global. */ +.globalSelector { + color: red; +} +``` + +### Client module lifecycles {#client-module-lifecycles} + +Besides introducing side-effects, client modules can optionally export two lifecycle functions: `onRouteUpdate` and `onRouteDidUpdate`. + +Because Docusaurus builds a single-page application, `script` tags will only be executed the first time the page loads, but will not re-execute on page transitions. These lifecycles are useful if you have some imperative JS logic that should execute every time a new page has loaded, e.g., to manipulate DOM elements, to send analytics data, etc. + +For every route transition, there will be several important timings: + +1. The user clicks a link, which causes the router to change its current location. +2. Docusaurus preloads the next route's assets, while keeping displaying the current page's content. +3. The next route's assets have loaded. +4. The new location's route component gets rendered to DOM. + +`onRouteUpdate` will be called at event (2), and `onRouteDidUpdate` will be called at (4). They both receive the current location and the previous location (which can be `null`, if this is the first screen). + +`onRouteUpdate` can optionally return a "cleanup" callback, which will be called at (3). For example, if you want to display a progress bar, you can start a timeout in `onRouteUpdate`, and clear the timeout in the callback. (The classic theme already provides an `nprogress` integration this way.) + +Note that the new page's DOM is only available during event (4). If you need to manipulate the new page's DOM, you'll likely want to use `onRouteDidUpdate`, which will be fired as soon as the DOM on the new page has mounted. + +```js title="myClientModule.js" +export function onRouteDidUpdate({location, previousLocation}) { + // Don't execute if we are still on the same page; the lifecycle may be fired + // because the hash changes (e.g. when navigating between headings) + if (location.pathname !== previousLocation?.pathname) { + const title = document.getElementsByTagName('h1')[0]; + if (title) { + title.innerText += '❤️'; + } + } +} + +export function onRouteUpdate({location, previousLocation}) { + if (location.pathname !== previousLocation?.pathname) { + const progressBarTimeout = window.setTimeout(() => { + nprogress.start(); + }, delay); + return () => window.clearTimeout(progressBarTimeout); + } + return undefined; +} +``` + +Or, if you are using TypeScript and you want to leverage contextual typing: + +```ts title="myClientModule.ts" +import type {ClientModule} from '@docusaurus/types'; + +const module: ClientModule = { + onRouteUpdate({location, previousLocation}) { + // ... + }, + onRouteDidUpdate({location, previousLocation}) { + // ... + }, +}; +export default module; +``` + +Both lifecycles will fire on first render, but they will not fire on server-side, so you can safely access browser globals in them. + +:::tip Prefer using React + +Client module lifecycles are purely imperative, and you can't use React hooks or access React contexts within them. If your operations are state-driven or involve complicated DOM manipulations, you should consider [swizzling components](../swizzling.mdx) instead. + +::: diff --git a/website/versioned_docs/version-3.9.2/advanced/index.mdx b/website/versioned_docs/version-3.9.2/advanced/index.mdx new file mode 100644 index 0000000000..b5e5deb222 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/advanced/index.mdx @@ -0,0 +1,11 @@ +# Advanced Tutorials + +This section is not going to be very structured, but we will cover the following topics: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; + + +``` + +We will assume that you have finished the guides, and know the basics like how to configure plugins, how to write React components, etc. These sections will have plugin authors and code contributors in mind, so we may occasionally refer to [plugin APIs](../api/plugin-methods/README.mdx) or other architecture details. Don't panic if you don't understand everything😉 diff --git a/website/versioned_docs/version-3.9.2/advanced/plugins.mdx b/website/versioned_docs/version-3.9.2/advanced/plugins.mdx new file mode 100644 index 0000000000..1f09ea723a --- /dev/null +++ b/website/versioned_docs/version-3.9.2/advanced/plugins.mdx @@ -0,0 +1,129 @@ +# Plugins + +Plugins are the building blocks of features in a Docusaurus site. Each plugin handles its own individual feature. Plugins may work and be distributed as part of a bundle via presets. + +## Creating plugins {#creating-plugins} + +A plugin is a function that takes two parameters: `context` and `options`. It returns a plugin instance object (or a promise). You can create plugins as functions or modules. For more information, refer to the [plugin method references section](../api/plugin-methods/README.mdx). + +### Function definition {#function-definition} + +You can use a plugin as a function directly included in the Docusaurus config file: + +```js title="docusaurus.config.js" +export default { + // ... + plugins: [ + // highlight-start + async function myPlugin(context, options) { + // ... + return { + name: 'my-plugin', + async loadContent() { + // ... + }, + async contentLoaded({content, actions}) { + // ... + }, + /* other lifecycle API */ + }; + }, + // highlight-end + ], +}; +``` + +### Module definition {#module-definition} + +You can use a plugin as a module path referencing a separate file or npm package: + +```js title="docusaurus.config.js" +export default { + // ... + plugins: [ + // without options: + './my-plugin', + // or with options: + ['./my-plugin', options], + ], +}; +``` + +Then in the folder `my-plugin`, you can create an `index.js` such as this: + +```js title="my-plugin/index.js" +export default async function myPlugin(context, options) { + // ... + return { + name: 'my-plugin', + async loadContent() { + /* ... */ + }, + async contentLoaded({content, actions}) { + /* ... */ + }, + /* other lifecycle API */ + }; +} +``` + +--- + +You can view all plugins installed in your site using the [debug plugin's metadata panel](/__docusaurus/debug/metadata). + +Plugins come as several types: + +- `package`: an external package you installed +- `project`: a plugin you created in your project, given to Docusaurus as a local file path +- `local`: a plugin created using the function definition +- `synthetic`: a "fake plugin" Docusaurus created internally, so we take advantage of our modular architecture and don't let the core do much special work. You won't see this in the metadata because it's an implementation detail. + +You can access them on the client side with `useDocusaurusContext().siteMetadata.pluginVersions`. + +## Plugin design {#plugin-design} + +Docusaurus' implementation of the plugins system provides us with a convenient way to hook into the website's lifecycle to modify what goes on during development/build, which involves (but is not limited to) extending the webpack config, modifying the data loaded, and creating new components to be used in a page. + +### Theme design {#theme-design} + +When plugins have loaded their content, the data is made available to the client side through actions like [`createData` + `addRoute`](../api/plugin-methods/lifecycle-apis.mdx#addRoute) or [`setGlobalData`](../api/plugin-methods/lifecycle-apis.mdx#setGlobalData). This data has to be _serialized_ to plain strings, because [plugins and themes run in different environments](./architecture.mdx). Once the data arrives on the client side, the rest becomes familiar to React developers: data is passed along components, components are bundled with Webpack, and rendered to the window through `ReactDOM.render`... + +**Themes provide the set of UI components to render the content.** Most content plugins need to be paired with a theme in order to be actually useful. The UI is a separate layer from the data schema, which makes swapping designs easy. + +For example, a Docusaurus blog may consist of a blog plugin and a blog theme. + +:::note + +This is a contrived example: in practice, `@docusaurus/theme-classic` provides the theme for docs, blog, and layouts. + +::: + +```js title="docusaurus.config.js" +export default { + // highlight-next-line + themes: ['theme-blog'], + plugins: ['plugin-content-blog'], +}; +``` + +And if you want to use Bootstrap styling, you can swap out the theme with `theme-blog-bootstrap` (another fictitious non-existing theme): + +```js title="docusaurus.config.js" +export default { + // highlight-next-line + themes: ['theme-blog-bootstrap'], + plugins: ['plugin-content-blog'], +}; +``` + +Now, although the theme receives the same data from the plugin, how the theme chooses to _render_ the data as UI can be drastically different. + +While themes share the exact same lifecycle methods with plugins, themes' implementations can look very different from those of plugins based on themes' designed objectives. + +Themes are designed to complete the build of your Docusaurus site and supply the components used by your site, plugins, and the themes themselves. A theme still acts like a plugin and exposes some lifecycle methods, but most likely they would not use [`loadContent`](../api/plugin-methods/lifecycle-apis.mdx#loadContent), since they only receive data from plugins, but don't generate data themselves; themes are typically also accompanied by an `src/theme` directory full of components, which are made known to the core through the [`getThemePath`](../api/plugin-methods/extend-infrastructure.mdx#getThemePath) lifecycle. + +To summarize: + +- Themes share the same lifecycle methods with Plugins +- Themes are run after all existing Plugins +- Themes add component aliases by providing `getThemePath`. diff --git a/website/versioned_docs/version-3.9.2/advanced/routing.mdx b/website/versioned_docs/version-3.9.2/advanced/routing.mdx new file mode 100644 index 0000000000..ea62c06f35 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/advanced/routing.mdx @@ -0,0 +1,289 @@ +--- +description: "Docusaurus' routing system follows single-page application conventions: one route, one component." +--- + +# Routing + +```mdx-code-block +import Link from '@docusaurus/Link'; +import {useLatestVersion, useActiveDocContext} from '@docusaurus/plugin-content-docs/client'; +import {useLocation} from '@docusaurus/router'; +import BrowserWindow from '@site/src/components/BrowserWindow'; +``` + +Docusaurus' routing system follows single-page application conventions: one route, one component. In this section, we will begin by talking about routing within the three content plugins (docs, blog, and pages), and then go beyond to talk about the underlying routing system. + +## Routing in content plugins {#routing-in-content-plugins} + +Every content plugin provides a `routeBasePath` option. It defines where the plugins append their routes to. By default, the docs plugin puts its routes under `/docs`; the blog plugin, `/blog`; and the pages plugin, `/`. You can think about the route structure like this: + +```mermaid +graph LR; + A(["https://example.com/"]) + B(["/base-url/"]) + C(["/docs/"]) + D(["/blog/"]) + E(["/"]) + F["All docs
    routes"] + G["All blog
    routes"] + H["All pages
    routes"] + A---B; + B---C; + B---D; + B---E; + C---F; + D---G; + E---H; +``` + +Any route will be matched against this nested route config until a good match is found. For example, when given a route `/docs/configuration`, Docusaurus first enters the `/docs` branch, and then searches among the subroutes created by the docs plugin. + +Changing `routeBasePath` can effectively alter your site's route structure. For example, in [Docs-only mode](../guides/docs/docs-introduction.mdx#docs-only-mode), we mentioned that configuring `routeBasePath: '/'` for docs means that all routes that the docs plugin create would not have the `/docs` prefix, yet it doesn't prevent you from having more subroutes like `/blog` created by other plugins. + +Next, let's look at how the three plugins structure their own "boxes of subroutes". + +### Pages routing {#pages-routing} + +Pages routing are straightforward: the file paths directly map to URLs, without any other way to customize. See the [pages docs](../guides/creating-pages.mdx#routing) for more information. + +The component used for Markdown pages is `@theme/MDXPage`. React pages are directly used as the route's component. + +### Blog routing {#blog-routing} + +The blog creates the following routes: + +- **Posts list pages**: `/`, `/page/2`, `/page/3`... + - The route is customizable through the `pageBasePath` option. + - The component is `@theme/BlogListPage`. +- **Post pages**: `/2021/11/21/algolia-docsearch-migration`, `/2021/05/12/announcing-docusaurus-two-beta`... + - Generated from each Markdown post. + - The routes are fully customizable through the `slug` front matter. + - The component is `@theme/BlogPostPage`. +- **Tags list page**: `/tags` + - The route is customizable through the `tagsBasePath` option. + - The component is `@theme/BlogTagsListPage`. +- **Tag pages**: `/tags/adoption`, `/tags/beta`... + - Generated through the tags defined in each post's front matter. + - The routes always have base defined in `tagsBasePath`, but the subroutes are customizable through the tag's `permalink` field. + - The component is `@theme/BlogTagsPostsPage`. +- **Archive page**: `/archive` + - The route is customizable through the `archiveBasePath` option. + - The component is `@theme/BlogArchivePage`. + +### Docs routing {#docs-routing} + +The docs is the only plugin that creates **nested routes**. At the top, it registers [**version paths**](../guides/docs/versioning.mdx): `/`, `/next`, `/2.0.0-beta.13`... which provide the version context, including the layout and sidebar. This ensures that when switching between individual docs, the sidebar's state is preserved, and that you can switch between versions through the navbar dropdown while staying on the same doc. The component used is `@theme/DocPage`. + +```mdx-code-block +export const URLPath = () => {useLocation().pathname}; + +export const FilePath = () => { + const currentVersion = useActiveDocContext('default').activeVersion.name; + return {currentVersion === 'current' ? './docs/' : `./versioned_docs/version-${currentVersion}/`}advanced/routing.md; +} +``` + +The individual docs are rendered in the remaining space after the navbar, footer, sidebar, etc. have all been provided by the `DocPage` component. For example, this page, , is generated from the file at . The component used is `@theme/DocItem`. + +The doc's `slug` front matter customizes the last part of the route, but the base route is always defined by the plugin's `routeBasePath` and the version's `path`. + +### File paths and URL paths {#file-paths-and-url-paths} + +Throughout the documentation, we always try to be unambiguous about whether we are talking about file paths or URL paths. Content plugins usually map file paths directly to URL paths, for example, `./docs/advanced/routing.md` will become `/docs/advanced/routing`. However, with `slug`, you can make URLs totally decoupled from the file structure. + +When writing links in Markdown, you could either mean a _file path_, or a _URL path_, which Docusaurus would use several heuristics to determine. + +- If the path has a `@site` prefix, it is _always_ an asset file path. +- If the path has an `http(s)://` prefix, it is _always_ a URL path. +- If the path doesn't have an extension, it is a URL path. For example, a link `[page](../plugins)` on a page with URL `/docs/advanced/routing` will link to `/docs/plugins`. Docusaurus will only detect broken links when building your site (when it knows the full route structure), but will make no assumptions about the existence of a file. It is exactly equivalent to writing `
    page` in a JSX file. +- If the path has an `.md(x)` extension, Docusaurus would try to resolve that Markdown file to a URL, and replace the file path with a URL path. +- If the path has any other extension, Docusaurus would treat it as [an asset](../guides/markdown-features/markdown-features-assets.mdx) and bundle it. + +The following directory structure may help you visualize this file → URL mapping. Assume that there's no slug customization in any page. + +
    + +A sample site structure + +```bash +. +├── blog # blog plugin has routeBasePath: '/blog' +│ ├── 2019-05-28-first-blog-post.md # -> /blog/2019/05/28/first-blog-post +│ ├── 2019-05-29-long-blog-post.md # -> /blog/2019/05/29/long-blog-post +│ ├── 2021-08-01-mdx-blog-post.mdx # -> /blog/2021/08/01/mdx-blog-post +│ └── 2021-08-26-welcome +│ ├── docusaurus-plushie-banner.jpeg +│ └── index.md # -> /blog/2021/08/26/welcome +├── docs # docs plugin has routeBasePath: '/docs'; current version has base path '/' +│ ├── intro.md # -> /docs/intro +│ ├── tutorial-basics +│ │ ├── _category_.json +│ │ ├── congratulations.md # -> /docs/tutorial-basics/congratulations +│ │ └── markdown-features.mdx # -> /docs/tutorial-basics/markdown-features +│ └── tutorial-extras +│ ├── _category_.json +│ ├── manage-docs-versions.md # -> /docs/tutorial-extras/manage-docs-versions +│ └── translate-your-site.md # -> /docs/tutorial-extras/translate-your-site +├── src +│ └── pages # pages plugin has routeBasePath: '/' +│ ├── index.module.css +│ ├── index.tsx # -> / +│ └── markdown-page.md # -> /markdown-page +└── versioned_docs + └── version-1.0.0 # version has base path '/1.0.0' + ├── intro.md # -> /docs/1.0.0/intro + ├── tutorial-basics + │ ├── _category_.json + │ ├── congratulations.md # -> /docs/1.0.0/tutorial-basics/congratulations + │ └── markdown-features.mdx # -> /docs/1.0.0/tutorial-basics/markdown-features + └── tutorial-extras + ├── _category_.json + ├── manage-docs-versions.md # -> /docs/1.0.0/tutorial-extras/manage-docs-versions + └── translate-your-site.md # -> /docs/1.0.0/tutorial-extras/translate-your-site +``` + +
    + +So much about content plugins. Let's take one step back and talk about how routing works in a Docusaurus app in general. + +## Routes become HTML files {#routes-become-html-files} + +Because Docusaurus is a server-side rendering framework, all routes generated will be server-side rendered into static HTML files. If you are familiar with the behavior of HTTP servers like [Apache2](https://httpd.apache.org/docs/trunk/getting-started.html), you will understand how this is done: when the browser sends a request to the route `/docs/advanced/routing`, the server interprets that as request for the HTML file `/docs/advanced/routing/index.html`, and returns that. + +The `/docs/advanced/routing` route can correspond to either `/docs/advanced/routing/index.html` or `/docs/advanced/routing.html`. Some hosting providers differentiate between them using the presence of a trailing slash, and may or may not tolerate the other. Read more in the [trailing slash guide](https://github.com/slorber/trailing-slash-guide). + +For example, the build output of the directory above is (ignoring other assets and JS bundle): + +
    + +Output of the above workspace + +```bash +build +├── 404.html # /404/ +├── blog +│ ├── archive +│ │ └── index.html # /blog/archive/ +│ ├── first-blog-post +│ │ └── index.html # /blog/first-blog-post/ +│ ├── index.html # /blog/ +│ ├── long-blog-post +│ │ └── index.html # /blog/long-blog-post/ +│ ├── mdx-blog-post +│ │ └── index.html # /blog/mdx-blog-post/ +│ ├── tags +│ │ ├── docusaurus +│ │ │ └── index.html # /blog/tags/docusaurus/ +│ │ ├── hola +│ │ │ └── index.html # /blog/tags/hola/ +│ │ └── index.html # /blog/tags/ +│ └── welcome +│ └── index.html # /blog/welcome/ +├── docs +│ ├── 1.0.0 +│ │ ├── intro +│ │ │ └── index.html # /docs/1.0.0/intro/ +│ │ ├── tutorial-basics +│ │ │ ├── congratulations +│ │ │ │ └── index.html # /docs/1.0.0/tutorial-basics/congratulations/ +│ │ │ └── markdown-features +│ │ │ └── index.html # /docs/1.0.0/tutorial-basics/markdown-features/ +│ │ └── tutorial-extras +│ │ ├── manage-docs-versions +│ │ │ └── index.html # /docs/1.0.0/tutorial-extras/manage-docs-versions/ +│ │ └── translate-your-site +│ │ └── index.html # /docs/1.0.0/tutorial-extras/translate-your-site/ +│ ├── intro +│ │ └── index.html # /docs/1.0.0/intro/ +│ ├── tutorial-basics +│ │ ├── congratulations +│ │ │ └── index.html # /docs/tutorial-basics/congratulations/ +│ │ └── markdown-features +│ │ └── index.html # /docs/tutorial-basics/markdown-features/ +│ └── tutorial-extras +│ ├── manage-docs-versions +│ │ └── index.html # /docs/tutorial-extras/manage-docs-versions/ +│ └── translate-your-site +│ └── index.html # /docs/tutorial-extras/translate-your-site/ +├── index.html # / +└── markdown-page + └── index.html # /markdown-page/ +``` + +
    + +If `trailingSlash` is set to `false`, the build would emit `intro.html` instead of `intro/index.html`. + +All HTML files will reference its JS assets using absolute URLs, so in order for the correct assets to be located, you have to configure the `baseUrl` field. Note that `baseUrl` doesn't affect the emitted bundle's file structure: the base URL is one level above the Docusaurus routing system. You can see the aggregate of `url` and `baseUrl` as the actual location of your Docusaurus site. + +For example, the emitted HTML would contain links like ``. Because absolute URLs are resolved from the host, if the bundle placed under the path `https://example.com/base/`, the link will point to `https://example.com/assets/js/runtime~main.7ed5108a.js`, which is, well, non-existent. By specifying `/base/` as base URL, the link will correctly point to `/base/assets/js/runtime~main.7ed5108a.js`. + +Localized sites have the locale as part of the base URL as well. For example, `https://docusaurus.io/zh-CN/docs/advanced/routing/` has base URL `/zh-CN/`. + +## Generating and accessing routes {#generating-and-accessing-routes} + +The `addRoute` lifecycle action is used to generate routes. It registers a piece of route config to the route tree, giving a route, a component, and props that the component needs. The props and the component are both provided as paths for the bundler to `require`, because as explained in the [architecture overview](architecture.mdx), server and client only communicate through temp files. + +All routes are aggregated in `.docusaurus/routes.js`, which you can view with the debug plugin's [routes panel](/__docusaurus/debug/routes). + +On the client side, we offer `@docusaurus/router` to access the page's route. `@docusaurus/router` is a re-export of the [`react-router-dom`](https://www.npmjs.com/package/react-router-dom/v/5.3.0) package. For example, you can use `useLocation` to get the current page's [location](https://developer.mozilla.org/en-US/docs/Web/API/Location), and `useHistory` to access the [history object](https://developer.mozilla.org/en-US/docs/Web/API/History). (They are not the same as the browser API, although similar in functionality. Refer to the React Router documentation for specific APIs.) + +This API is **SSR safe**, as opposed to the browser-only `window.location`. + +```jsx title="myComponent.js" +import React from 'react'; +import {useLocation} from '@docusaurus/router'; + +export function PageRoute() { + // React router provides the current component's route, even in SSR + const location = useLocation(); + return ( + + We are currently on {location.pathname} + + ); +} +``` + +```mdx-code-block +export function PageRoute() { + const location = useLocation(); + return ( + + We are currently on {location.pathname} + + ); +} + + + + + + +``` + +## Escaping from SPA redirects {#escaping-from-spa-redirects} + +Docusaurus builds a [single-page application](https://developer.mozilla.org/en-US/docs/Glossary/SPA), where route transitions are done through the `history.push()` method of React router. This operation is done on the client side. However, the prerequisite for a route transition to happen this way is that the target URL is known to our router. Otherwise, the router catches this path and displays a 404 page instead. + +If you put some HTML pages under the `static` folder, they will be copied to the build output and therefore become accessible as part of your website, yet it's not part of the Docusaurus route system. We provide a `pathname://` protocol that allows you to redirect to another part of your domain in a non-SPA fashion, as if this route is an external link. + +```md +- [pathname:///pure-html](pathname:///pure-html) +``` + + + +- [`pathname:///pure-html`](pathname:///pure-html) + + + +The `pathname://` protocol is useful for referencing any content in the static folder. For example, Docusaurus would convert [all Markdown static assets to require() calls](../guides/markdown-features/markdown-features-assets.mdx#static-assets). You can use `pathname://` to keep it a regular link instead of being hashed by Webpack. + +```md title="my-doc.md" +![An image from the static](pathname:///img/docusaurus.png) + +[An asset from the static](pathname:///files/asset.pdf) +``` + +Docusaurus will only strip the `pathname://` prefix without processing the content. diff --git a/website/versioned_docs/version-3.9.2/advanced/ssg.mdx b/website/versioned_docs/version-3.9.2/advanced/ssg.mdx new file mode 100644 index 0000000000..07931249bb --- /dev/null +++ b/website/versioned_docs/version-3.9.2/advanced/ssg.mdx @@ -0,0 +1,218 @@ +--- +sidebar_label: Static site generation +description: Docusaurus statically renders your React code into HTML, allowing faster load speed and better SEO. +--- + +# Static site generation (SSG) + +In [architecture](architecture.mdx), we mentioned that the theme is run in Webpack. But beware: that doesn't mean it always has access to browser globals! The theme is built twice: + +- During **server-side rendering**, the theme is compiled in a sandbox called [React DOM Server](https://reactjs.org/docs/react-dom-server.html). You can see this as a "headless browser", where there is no `window` or `document`, only React. SSR produces static HTML pages. +- During **client-side rendering**, the theme is compiled to JavaScript that gets eventually executed in the browser, so it has access to browser variables. + +:::info SSR or SSG? + +_Server-side rendering_ and _static site generation_ can be different concepts, but we use them interchangeably. + +Strictly speaking, Docusaurus is a static site generator, because there's no server-side runtime—we statically render to HTML files that are deployed on a CDN, instead of dynamically pre-rendering on each request. This differs from the working model of [Next.js](https://nextjs.org/). + +::: + +Therefore, while you probably know not to access Node globals like `process` ([or can we?](#node-env)) or the `'fs'` module, you can't freely access browser globals either. + +```jsx +import React from 'react'; + +export default function WhereAmI() { + return {window.location.href}; +} +``` + +This looks like idiomatic React, but if you run `docusaurus build`, you will get an error: + +``` +ReferenceError: window is not defined +``` + +This is because during server-side rendering, the Docusaurus app isn't actually run in browser, and it doesn't know what `window` is. + +```mdx-code-block +
    +What about process.env.NODE_ENV? +``` + +One exception to the "no Node globals" rule is `process.env.NODE_ENV`. In fact, you can use it in React, because Webpack injects this variable as a global: + +```jsx +import React from 'react'; + +export default function expensiveComp() { + if (process.env.NODE_ENV === 'development') { + return <>This component is not shown in development; + } + const res = someExpensiveOperationThatLastsALongTime(); + return <>{res}; +} +``` + +During Webpack build, the `process.env.NODE_ENV` will be replaced with the value, either `'development'` or `'production'`. You will then get different build results after dead code elimination: + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +```mdx-code-block + + +``` + +```diff +import React from 'react'; + +export default function expensiveComp() { + // highlight-next-line + if ('development' === 'development') { ++ return <>This component is not shown in development; + } +- const res = someExpensiveOperationThatLastsALongTime(); +- return <>{res}; +} +``` + +```mdx-code-block + + +``` + +```diff +import React from 'react'; + +export default function expensiveComp() { + // highlight-next-line +- if ('production' === 'development') { +- return <>This component is not shown in development; +- } ++ const res = someExpensiveOperationThatLastsALongTime(); ++ return <>{res}; +} +``` + +```mdx-code-block + + +
    +``` + +## Understanding SSR {#understanding-ssr} + +React is not just a dynamic UI runtime—it's also a templating engine. Because Docusaurus sites mostly contain static contents, it should be able to work without any JavaScript (which React runs in), but only plain HTML/CSS. And that's what server-side rendering offers: statically rendering your React code into HTML, without any dynamic content. An HTML file has no concept of client state (it's purely markup), hence it shouldn't rely on browser APIs. + +These HTML files are the first to arrive at the user's browser screen when a URL is visited (see [routing](routing.mdx)). Afterwards, the browser fetches and runs other JS code to provide the "dynamic" parts of your site—anything implemented with JavaScript. However, before that, the main content of your page is already visible, allowing faster loading. + +In CSR-only apps, all DOM elements are generated on client side with React, and the HTML file only ever contains one root element for React to mount DOM to; in SSR, React is already facing a fully built HTML page, and it only needs to correlate the DOM elements with the virtual DOM in its model. This step is called "hydration". After React has hydrated the static markup, the app starts to work as any normal React app. + +Note that Docusaurus is ultimately a single-page application, so static site generation is only an optimization (_progressive enhancement_, as it's called), but our functionality does not fully depend on those HTML files. This is contrary to site generators like [Jekyll](https://jekyllrb.com/) and [Docusaurus v1](https://v1.docusaurus.io/), where all files are statically transformed to markup, and interactiveness is added through external JavaScript linked with ` + <% }); %> + <%~ it.postBodyTags %> + +`, +}; +``` + +### `titleDelimiter` {#titleDelimiter} + +- Type: `string` + +Will be used as title delimiter in the generated `` tag. + +Example: + +```js title="docusaurus.config.js" +export default { + titleDelimiter: '🦖', // Defaults to `|` +}; +``` + +### `baseUrlIssueBanner` {#baseUrlIssueBanner} + +- Type: `boolean` + +When enabled, will show a banner in case your site can't load its CSS or JavaScript files, which is a very common issue, often related to a wrong `baseUrl` in site config. + +Example: + +```js title="docusaurus.config.js" +export default { + baseUrlIssueBanner: true, // Defaults to `true` +}; +``` + +![A sample base URL issue banner. The style is very raw since the stylesheets failed to load. The text says "Your Docusaurus site did not load properly... Current configured baseUrl = / (default value); We suggest trying baseUrl = /build/](/img/baseUrlIssueBanner.png) + +:::warning + +This banner needs to inline CSS / JS in case all asset loading fails due to wrong base URL. + +If you have a strict [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP), you should rather disable it. + +::: diff --git a/website/versioned_docs/version-3.9.2/api/misc/_category_.yml b/website/versioned_docs/version-3.9.2/api/misc/_category_.yml new file mode 100644 index 0000000000..2fb3073764 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/misc/_category_.yml @@ -0,0 +1,2 @@ +label: Miscellaneous +position: 4 diff --git a/website/versioned_docs/version-3.9.2/api/misc/create-docusaurus.mdx b/website/versioned_docs/version-3.9.2/api/misc/create-docusaurus.mdx new file mode 100644 index 0000000000..c79540e564 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/misc/create-docusaurus.mdx @@ -0,0 +1,58 @@ +--- +sidebar_position: 0 +slug: /api/misc/create-docusaurus +--- + +# 📦 create-docusaurus + +A scaffolding utility to help you instantly set up a functional Docusaurus app. + +## Usage {#usage} + +```bash +npx create-docusaurus@latest [name] [template] [rootDir] +``` + +The `name` argument will be used as the site's path as well as the `name` field in the created app's package.json. It can be an absolute path, or a path relative to `rootDir`. + +The `template` argument can be one of the following: + +- `classic`: Uses the classic template (recommended) +- `facebook`: Uses the Facebook/Meta template, which contains some Meta-specific setup +- A git repo URL (beginning with `https://` or `git@`), which can be cloned to the destination +- A local file path relative to CWD, which contains the files to be copied to destination + +The `rootDir` will be used to resolve the absolute path to the site directory. The default is CWD. + +:::warning + +This command should be preferably used in an interactive shell so all features are available. + +::: + +## Options {#options} + +### `-t, --typescript` {#typescript} + +Used when the template argument is a recognized name. Currently, only `classic` provides a TypeScript variant. + +### `-g, --git-strategy` {#git-strategy} + +Used when the template argument is a git repo. It needs to be one of: + +- `deep`: preserves full git history +- `shallow`: clones with `--depth=1` +- `copy`: does a shallow clone, but does not create a git repo +- `custom`: enter your custom git clone command. We will prompt you for it. You can write something like `git clone --depth 10`, and we will append the repository URL and destination directory. + +### `-p, --package-manager` {#package-manager} + +Value should be one of `npm`, `yarn`, `pnpm`, or `bun`. If it's not explicitly provided, Docusaurus will infer one based on: + +- The lockfile already present in the CWD (e.g. if you are setting up website in an existing project) +- The command used to invoke `create-docusaurus` (e.g. `npm init`, `npx`, `yarn create`, `bunx`, etc.) +- Interactive prompting, in case all heuristics are not present + +### `-s, --skip-install` {#skip-install} + +If provided, Docusaurus will not automatically install dependencies after creating the app. The `--package-manager` option is only useful when you are actually installing dependencies. diff --git a/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/README.mdx b/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/README.mdx new file mode 100644 index 0000000000..a0d41ee4d4 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/README.mdx @@ -0,0 +1,74 @@ +--- +sidebar_position: 1 +slug: /api/misc/@docusaurus/eslint-plugin +--- + +# 📦 eslint-plugin + +[ESLint](https://eslint.org/) is a tool that statically analyzes your code and reports problems or suggests best practices through editor hints and command line. Docusaurus provides an ESLint plugin to enforce best Docusaurus practices. + +## Installation + +```bash npm2yarn +npm install --save-dev @docusaurus/eslint-plugin +``` + +## Usage + +### Recommended config + +Add `plugin:@docusaurus/recommended` to the `extends` section of your `.eslintrc` configuration file: + +```json title=".eslintrc" +{ + "extends": ["plugin:@docusaurus/recommended"] +} +``` + +This will enable the `@docusaurus` eslint plugin and use the `recommended` config. See [Supported rules](#supported-rules) below for a list of rules that this will enable. + +### Manual config + +For more fine-grained control, you can also enable the plugin manually and configure the rules you want to use directly: + +```json title=".eslintrc" +{ + "plugins": ["@docusaurus"], + "rules": { + "@docusaurus/string-literal-i18n-messages": "error", + "@docusaurus/no-untranslated-text": "warn" + } +} +``` + +## Supported configs + +- Recommended: recommended rule set for most Docusaurus sites that should be extended from. +- All: **all** rules enabled. This will change between minor versions, so you should not use this if you want to avoid unexpected breaking changes. + +## Supported rules + +| Name | Description | | +| --- | --- | --- | +| [`@docusaurus/no-untranslated-text`](./no-untranslated-text.mdx) | Enforce text labels in JSX to be wrapped by translate calls | | +| [`@docusaurus/string-literal-i18n-messages`](./string-literal-i18n-messages.mdx) | Enforce translate APIs to be called on plain text labels | ✅ | +| [`@docusaurus/no-html-links`](./no-html-links.mdx) | Ensures @docusaurus/Link is used instead of `<a>` tags | ✅ | +| [`@docusaurus/prefer-docusaurus-heading`](./prefer-docusaurus-heading.mdx) | Ensures @theme/Heading is used instead of `<hn>` tags for headings | ✅ | + +✅ = recommended + +## Example configuration + +Here's an example configuration: + +```js title=".eslintrc.js" +module.exports = { + extends: ['plugin:@docusaurus/recommended'], + rules: { + '@docusaurus/no-untranslated-text': [ + 'warn', + {ignoredStrings: ['·', '—', '×']}, + ], + }, +}; +``` diff --git a/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/no-html-links.mdx b/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/no-html-links.mdx new file mode 100644 index 0000000000..2c01a5c114 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/no-html-links.mdx @@ -0,0 +1,47 @@ +--- +slug: /api/misc/@docusaurus/eslint-plugin/no-html-links +--- + +# no-html-links + +import APITable from '@site/src/components/APITable'; + +Ensure that the Docusaurus [`<Link>`](../../../docusaurus-core.mdx#link) component is used instead of `<a>` tags. + +The `<Link>` component has prefetching and preloading built-in. It also does build-time broken link detection, and helps Docusaurus understand your site's structure better. + +## Rule Details {#details} + +Examples of **incorrect** code for this rule: + +```html +<a href="/page">go to page!</a> + +<a href="https://x.com/docusaurus" target="_blank">X</a> +``` + +Examples of **correct** code for this rule: + +```js +import Link from '@docusaurus/Link' + +<Link to="/page">go to page!</Link> + +<Link to="https://x.com/docusaurus">X</Link> +``` + +## Rule Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Option | Type | Default | Description | +| --- | --- | --- | --- | +| `ignoreFullyResolved` | `boolean` | `false` | Set to true will not report any `<a>` tags with absolute URLs including a protocol. | + +```mdx-code-block +</APITable> +``` diff --git a/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/no-untranslated-text.mdx b/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/no-untranslated-text.mdx new file mode 100644 index 0000000000..589d90e4a2 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/no-untranslated-text.mdx @@ -0,0 +1,54 @@ +--- +slug: /api/misc/@docusaurus/eslint-plugin/no-untranslated-text +--- + +# no-untranslated-text + +import APITable from '@site/src/components/APITable'; + +Enforce text labels in JSX to be wrapped by translate calls. + +When the [i18n feature](../../../i18n/i18n-introduction.mdx) is used, this rule ensures that all labels appearing on the website are translatable, so no string accidentally slips through untranslated. + +## Rule Details {#details} + +Examples of **incorrect** code for this rule: + +```js +// Hello World is not translated +<Component>Hello World</Component> +``` + +Examples of **correct** code for this rule: + +```js +// Hello World is translated +<Component> + <Translate>Hello World</Translate> +</Component> +``` + +## Rule Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Option | Type | Default | Description | +| --- | --- | --- | --- | +| `ignoredStrings` | `string[]` | `[]` | Text labels that only contain strings in this list will not be reported. | + +```mdx-code-block +</APITable> +``` + +## When Not To Use It {#when-not-to-use} + +If you're not using the [i18n feature](../../../i18n/i18n-introduction.mdx), you can disable this rule. You can also disable this rule where the text is not supposed to be translated. + +## Further Reading {#further-reading} + +- https://docusaurus.io/docs/docusaurus-core#translate +- https://docusaurus.io/docs/docusaurus-core#translate-imperative diff --git a/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/prefer-docusaurus-heading.mdx b/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/prefer-docusaurus-heading.mdx new file mode 100644 index 0000000000..e1d758898d --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/prefer-docusaurus-heading.mdx @@ -0,0 +1,31 @@ +--- +slug: /api/misc/@docusaurus/eslint-plugin/prefer-docusaurus-heading +--- + +# prefer-docusaurus-heading + +Ensures that the `@theme/Heading` theme component provided by Docusaurus [`theme-classic`](../../themes/theme-classic.mdx) is used instead of `<hn>` tags for headings. + +## Rule Details {#details} + +Examples of **incorrect** code for this rule: + +```html +<h1>This is heading 1</h1> + +<h2>This is heading 2</h2> + +<h3>This is heading 3</h3> +``` + +Examples of **correct** code for this rule: + +```javascript +import Heading from '@theme/Heading' + +<Heading as='h1'>This is heading 1</Heading> + +<Heading as='h2'>This is heading 2</Heading> + +<Heading as='h3'>This is heading 3</Heading> +``` diff --git a/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/string-literal-i18n-messages.mdx b/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/string-literal-i18n-messages.mdx new file mode 100644 index 0000000000..0d5fb2f53d --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/misc/eslint-plugin/string-literal-i18n-messages.mdx @@ -0,0 +1,50 @@ +--- +slug: /api/misc/@docusaurus/eslint-plugin/string-literal-i18n-messages +--- + +# string-literal-i18n-messages + +Enforce translate APIs to be called on plain text labels. + +Docusaurus offers the [`docusaurus write-translations`](../../../cli.mdx#docusaurus-write-translations-sitedir) API, which statically extracts the text labels marked as translatable. Dynamic values used in `<Translate>` or `translate()` calls will fail to be extracted. This rule will ensure that all translate calls are statically extractable. + +## Rule Details {#details} + +Examples of **incorrect** code for this rule: + +```js +const text = 'Some text to be translated' + +// Invalid <Translate> child +<Translate>{text}</Translate> + +// Invalid message attribute +translate({message: text}) +``` + +Examples of **correct** code for this rule: + +```js +// Valid <Translate> child +<Translate>Some text to be translated</Translate> + +// Valid message attribute +translate({message: 'Some text to be translated'}) + +// Valid <Translate> child using values object as prop +<Translate values={{firstName: 'Sébastien'}}> + {'Welcome, {firstName}! How are you?'} +</Translate> + +// Valid message attribute using values object as second argument +translate({message: 'The logo of site {siteName}'}, {siteName: 'Docusaurus'}) +``` + +## When Not To Use It {#when-not-to-use} + +If you're not using the [i18n feature](../../../i18n/i18n-introduction.mdx), you can disable this rule. + +## Further Reading {#further-reading} + +- https://docusaurus.io/docs/docusaurus-core#translate +- https://docusaurus.io/docs/docusaurus-core#translate-imperative diff --git a/website/versioned_docs/version-3.9.2/api/misc/logger/demo.png b/website/versioned_docs/version-3.9.2/api/misc/logger/demo.png new file mode 100644 index 0000000000..f387755210 Binary files /dev/null and b/website/versioned_docs/version-3.9.2/api/misc/logger/demo.png differ diff --git a/website/versioned_docs/version-3.9.2/api/misc/logger/logger.mdx b/website/versioned_docs/version-3.9.2/api/misc/logger/logger.mdx new file mode 100644 index 0000000000..4c0b37371e --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/misc/logger/logger.mdx @@ -0,0 +1,71 @@ +--- +sidebar_position: 2 +slug: /api/misc/@docusaurus/logger +--- + +# 📦 logger + +An encapsulated logger for semantically formatting console messages. + +Authors of packages in the Docusaurus ecosystem are encouraged to use this package to provide unified log formats. + +## APIs + +It exports a single object as default export: `logger`. `logger` has the following properties: + +- Some useful colors. + - `red` + - `yellow` + - `green` + - `bold` + - `dim` +- Formatters. These functions all have the signature `(msg: unknown) => string`. Note that their implementations are not guaranteed. You should only care about their semantics. + - `path`: formats a file path. + - `url`: formats a URL. + - `name`: formats an identifier. + - `code`: formats a code snippet. + - `subdue`: subdues the text. + - `num`: formats a number. +- The `interpolate` function. It is a template literal tag. The syntax can be found below. +- Logging functions. All logging functions can both be used as normal functions (similar to the `console.log` family, but only accepts one parameter) or template literal tags. + - `info`: prints information. + - `warn`: prints a warning that should be paid attention to. + - `error`: prints an error (not necessarily halting the program) that signals significant problems. + - `success`: prints a success message. +- The `report` function. It takes a `ReportingSeverity` value (`ignore`, `log`, `warn`, `throw`) and reports a message according to the severity. + +:::warning A word on the `error` formatter + +Beware that an `error` message, even when it doesn't hang the program, is likely going to cause confusion. When users inspect logs and find an `[ERROR]`, even when the build succeeds, they will assume something is going wrong. Use it sparingly. + +Docusaurus only uses `logger.error` when printing messages immediately before throwing an error, or when user has set the reporting severity of `onBrokenLink`, etc. to `"error"`. + +In addition, `warn` and `error` will color the **entire** message for better attention. If you are printing large blocks of help text about an error, better use `logger.info`. + +::: + +### Using the template literal tag + +The template literal tag evaluates the template and expressions embedded. `interpolate` returns a new string, while other logging functions prints it. Below is a typical usage: + +```js +import logger from '@docusaurus/logger'; + +logger.info`Hello name=${name}! You have number=${money} dollars. Here are the ${ + items.length > 1 ? 'items' : 'item' +} on the shelf: ${items} +To buy anything, enter code=${'buy x'} where code=${'x'} is the item's name; to quit, press code=${'Ctrl + C'}.`; +``` + +An embedded expression is optionally preceded by a flag in the form `[a-z]+=` (a few lowercase letters, followed by an equals sign, directly preceding the embedded expression). If the expression is not preceded by any flag, it's printed out as-is. Otherwise, it's formatted with one of the formatters: + +- `path=`: `path` +- `url=`: `url` +- `name=`: `name` +- `code=`: `code` +- `subdue=`: `subdue` +- `number=`: `num` + +If the expression is an array, it's formatted by `` `\n- ${array.join('\n- ')}\n` `` (note it automatically gets a leading line end). Each member is formatted by itself and the bullet is not formatted. So you would see the above message printed as: + +![Some text output in the terminal, containing array, code, name, and number formatting](./demo.png) diff --git a/website/versioned_docs/version-3.9.2/api/plugin-methods/README.mdx b/website/versioned_docs/version-3.9.2/api/plugin-methods/README.mdx new file mode 100644 index 0000000000..e25bc9246e --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugin-methods/README.mdx @@ -0,0 +1,144 @@ +# Plugin Method References + +:::warning + +This section is a work in progress. Anchor links or even URLs are not guaranteed to be stable. + +::: + +Plugin APIs are shared by themes and plugins—themes are loaded just like plugins. + +## Plugin module {#plugin-module} + +Every plugin is imported as a module. The module is expected to have the following members: + +- A **default export**: the constructor function for the plugin. +- **Named exports**: the [static methods](./static-methods.mdx) called before plugins are initialized. + +## Plugin constructor {#plugin-constructor} + +The plugin module's default export is a constructor function with the signature `(context: LoadContext, options: PluginOptions) => Plugin | Promise<Plugin>`. + +### `context` {#context} + +`context` is plugin-agnostic, and the same object will be passed into all plugins used for a Docusaurus website. The `context` object contains the following fields: + +```ts +type LoadContext = { + siteDir: string; + generatedFilesDir: string; + siteConfig: DocusaurusConfig; + outDir: string; + baseUrl: string; +}; +``` + +### `options` {#options} + +`options` are the [second optional parameter when the plugins are used](../../using-plugins.mdx#configuring-plugins). `options` are plugin-specific and are specified by users when they use them in `docusaurus.config.js`. If there's a [`validateOptions`](./static-methods.mdx#validateOptions) function exported, the `options` will be validated and normalized beforehand. + +Alternatively, if a preset contains the plugin, the preset will then be in charge of passing the correct options into the plugin. It is up to the individual plugin to define what options it takes. + +## Example {#example} + +Here's a mental model for a presumptuous plugin implementation. + +```js +// A JavaScript function that returns an object. +// `context` is provided by Docusaurus. Example: siteConfig can be accessed from context. +// `opts` is the user-defined options. +export default async function myPlugin(context, opts) { + return { + // A compulsory field used as the namespace for directories to cache + // the intermediate data for each plugin. + // If you're writing your own local plugin, you will want it to + // be unique in order not to potentially conflict with imported plugins. + // A good way will be to add your own project name within. + name: 'docusaurus-my-project-cool-plugin', + + async loadContent() { + // The loadContent hook is executed after siteConfig and env has been loaded. + // You can return a JavaScript object that will be passed to contentLoaded hook. + }, + + async contentLoaded({content, actions}) { + // The contentLoaded hook is done after loadContent hook is done. + // `actions` are set of functional API provided by Docusaurus (e.g. addRoute) + }, + + async postBuild(props) { + // After docusaurus <build> finish. + }, + + // TODO + async postStart(props) { + // docusaurus <start> finish + }, + + // TODO + afterDevServer(app, server) { + // https://webpack.js.org/configuration/dev-server/#devserverbefore + }, + + // TODO + beforeDevServer(app, server) { + // https://webpack.js.org/configuration/dev-server/#devserverafter + }, + + configureWebpack(config, isServer, utils, content) { + // Modify internal webpack config. If returned value is an Object, it + // will be merged into the final config using webpack-merge; + // If the returned value is a function, it will receive the config as the 1st argument and an isServer flag as the 2nd argument. + }, + + getPathsToWatch() { + // Paths to watch. + }, + + getThemePath() { + // Returns the path to the directory where the theme components can + // be found. + }, + + getClientModules() { + // Return an array of paths to the modules that are to be imported + // in the client bundle. These modules are imported globally before + // React even renders the initial UI. + }, + + extendCli(cli) { + // Register an extra command to enhance the CLI of Docusaurus + }, + + injectHtmlTags({content}) { + // Inject head and/or body HTML tags. + }, + + async getTranslationFiles({content}) { + // Return translation files + }, + + translateContent({content, translationFiles}) { + // translate the plugin content here + }, + + translateThemeConfig({themeConfig, translationFiles}) { + // translate the site themeConfig here + }, + + async getDefaultCodeTranslationMessages() { + // return default theme translations here + }, + }; +} + +export function validateOptions({options, validate}) { + const validatedOptions = validate(myValidationSchema, options); + return validatedOptions; +} + +export function validateThemeConfig({themeConfig, validate}) { + const validatedThemeConfig = validate(myValidationSchema, options); + return validatedThemeConfig; +} +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugin-methods/_category_.yml b/website/versioned_docs/version-3.9.2/api/plugin-methods/_category_.yml new file mode 100644 index 0000000000..86cb36c246 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugin-methods/_category_.yml @@ -0,0 +1,2 @@ +label: Plugin method references +position: 1 diff --git a/website/versioned_docs/version-3.9.2/api/plugin-methods/extend-infrastructure.mdx b/website/versioned_docs/version-3.9.2/api/plugin-methods/extend-infrastructure.mdx new file mode 100644 index 0000000000..ec0b0542cf --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugin-methods/extend-infrastructure.mdx @@ -0,0 +1,132 @@ +--- +sidebar_position: 2 +--- + +# Extending infrastructure + +Docusaurus has some infrastructure like hot reloading, CLI, and swizzling, that can be extended by external plugins. + +## `getPathsToWatch()` {#getPathsToWatch} + +Specifies the paths to watch for plugins and themes. The paths are watched by the dev server so that the plugin lifecycles are reloaded when contents in the watched paths change. Note that the plugins and themes modules are initially called with `context` and `options` from Node, which you may use to find the necessary directory information about the site. + +Use this for files that are consumed server-side, because theme files are automatically watched by Webpack dev server. + +Example: + +```js title="docusaurus-plugin/src/index.js" +import path from 'path'; + +export default function (context, options) { + return { + name: 'docusaurus-plugin', + // highlight-start + getPathsToWatch() { + const contentPath = path.resolve(context.siteDir, options.path); + return [`${contentPath}/**/*.{ts,tsx}`]; + }, + // highlight-end + }; +} +``` + +## `extendCli(cli)` {#extendCli} + +Register an extra command to enhance the CLI of Docusaurus. `cli` is a [commander](https://www.npmjs.com/package/commander/v/5.1.0) object. + +:::warning + +The commander version matters! We use commander v5, and make sure you are referring to the right version documentation for available APIs. + +::: + +Example: + +```js title="docusaurus-plugin/src/index.js" +export default function (context, options) { + return { + name: 'docusaurus-plugin', + // highlight-start + extendCli(cli) { + cli + .command('roll') + .description('Roll a random number between 1 and 1000') + .action(() => { + console.log(Math.floor(Math.random() * 1000 + 1)); + }); + }, + // highlight-end + }; +} +``` + +## `getThemePath()` {#getThemePath} + +Returns the path to the directory where the theme components can be found. When your users call `swizzle`, `getThemePath` is called and its returned path is used to find your theme components. Relative paths are resolved against the folder containing the entry point. + +For example, your `getThemePath` can be: + +```js title="my-theme/src/index.js" +export default function (context, options) { + return { + name: 'my-theme', + // highlight-start + getThemePath() { + return './theme'; + }, + // highlight-end + }; +} +``` + +## `getTypeScriptThemePath()` {#getTypeScriptThemePath} + +Similar to `getThemePath()`, it should return the path to the directory where the source code of TypeScript theme components can be found. This path is purely for swizzling TypeScript theme components, and theme components under this path will **not** be resolved by Webpack. Therefore, it is not a replacement for `getThemePath()`. Typically, you can make the path returned by `getTypeScriptThemePath()` be your source directory, and make the path returned by `getThemePath()` be the compiled JavaScript output. + +:::tip + +For TypeScript theme authors: you are strongly advised to make your compiled output as human-readable as possible. Only strip type annotations and don't transpile any syntaxes, because they will be handled by Webpack's Babel loader based on the targeted browser versions. + +You should also format these files with Prettier. Remember—JS files can and will be directly consumed by your users. + +::: + +Example: + +```js title="my-theme/src/index.js" +export default function (context, options) { + return { + name: 'my-theme', + // highlight-start + getThemePath() { + // Where compiled JavaScript output lives + return '../lib/theme'; + }, + getTypeScriptThemePath() { + // Where TypeScript source code lives + return '../src/theme'; + }, + // highlight-end + }; +} +``` + +## `getSwizzleComponentList()` {#getSwizzleComponentList} + +**This is a static method, not attached to any plugin instance.** + +Returns a list of stable components that are considered safe for swizzling. These components will be swizzlable without `--danger`. All components are considered unstable by default. If an empty array is returned, all components are considered unstable. If `undefined` is returned, all components are considered stable. + +```js title="my-theme/src/index.js" +export function getSwizzleComponentList() { + return [ + 'CodeBlock', + 'DocSidebar', + 'Footer', + 'NotFound', + 'SearchBar', + 'hooks/useTheme', + 'prism-include-languages', + ]; +} +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugin-methods/i18n-lifecycles.mdx b/website/versioned_docs/version-3.9.2/api/plugin-methods/i18n-lifecycles.mdx new file mode 100644 index 0000000000..d9a6297569 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugin-methods/i18n-lifecycles.mdx @@ -0,0 +1,121 @@ +--- +sidebar_position: 3 +--- + +# I18n lifecycles + +Plugins use these lifecycles to load i18n-related data. + +## `getTranslationFiles({content})` {#getTranslationFiles} + +Plugins declare the JSON translation files they want to use. + +Returns translation files `{path: string, content: ChromeI18nJSON}`: + +- `path`: relative to the plugin localized folder `i18n/[locale]/[pluginName]`. Extension `.json` should be omitted to remain generic. +- `content`: using the Chrome i18n JSON format. + +These files will be written by the [`write-translations` CLI](../../cli.mdx#docusaurus-write-translations-sitedir) to the plugin i18n subfolder, and will be read in the appropriate locale before calling [`translateContent()`](#translateContent) and [`translateThemeConfig()`](#translateThemeConfig) + +Example: + +```js title="my-plugin.js" +export default function (context, options) { + return { + name: 'my-plugin', + // highlight-start + async getTranslationFiles({content}) { + return [ + { + path: 'sidebar-labels', + content: { + someSidebarLabel: { + message: 'Some Sidebar Label', + description: 'A label used in my plugin in the sidebar', + }, + someLabelFromContent: content.myLabel, + }, + }, + ]; + }, + // highlight-end + }; +} +``` + +## `translateContent({content,translationFiles})` {#translateContent} + +Translate the plugin content, using the localized translation files. + +Returns the localized plugin content. + +The `contentLoaded()` lifecycle will be called with the localized plugin content returned by `translateContent()`. + +Example: + +```js title="my-plugin.js" +export default function (context, options) { + return { + name: 'my-plugin', + // highlight-start + translateContent({content, translationFiles}) { + const myTranslationFile = translationFiles.find( + (f) => f.path === 'myTranslationFile', + ); + return { + ...content, + someContentLabel: myTranslationFile.someContentLabel.message, + }; + }, + // highlight-end + }; +} +``` + +## `translateThemeConfig({themeConfig,translationFiles})` {#translateThemeConfig} + +Translate the site `themeConfig` labels, using the localized translation files. + +Returns the localized `themeConfig`. + +Example: + +```js title="my-plugin.js" +export default function (context, options) { + return { + name: 'my-theme', + // highlight-start + translateThemeConfig({themeConfig, translationFiles}) { + const myTranslationFile = translationFiles.find( + (f) => f.path === 'myTranslationFile', + ); + return { + ...themeConfig, + someThemeConfigLabel: myTranslationFile.someThemeConfigLabel.message, + }; + }, + // highlight-end + }; +} +``` + +## `async getDefaultCodeTranslationMessages()` {#getDefaultCodeTranslationMessages} + +Themes using the `<Translate>` API can provide default code translation messages. + +It should return messages in `Record<string, string>`, where keys are translation IDs and values are messages (without the description) localized using the site's current locale. + +Example: + +```js title="my-plugin.js" +export default function (context, options) { + return { + name: 'my-theme', + // highlight-start + async getDefaultCodeTranslationMessages() { + return readJsonFile(`${context.i18n.currentLocale}.json`); + }, + // highlight-end + }; +} +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugin-methods/lifecycle-apis.mdx b/website/versioned_docs/version-3.9.2/api/plugin-methods/lifecycle-apis.mdx new file mode 100644 index 0000000000..bc6c1f77aa --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugin-methods/lifecycle-apis.mdx @@ -0,0 +1,493 @@ +--- +sidebar_position: 1 +toc_max_heading_level: 4 +--- + +# Lifecycle APIs + +During the build, plugins are loaded in parallel to fetch their own contents and render them to routes. Plugins may also configure webpack or post-process the generated files. + +## `async loadContent()` {#loadContent} + +Plugins should use this lifecycle to fetch from data sources (filesystem, remote API, headless CMS, etc.) or do some server processing. The return value is the content it needs. + +For example, this plugin below returns a random integer between 1 and 10 as content. + +```js title="docusaurus-plugin/src/index.js" +export default function (context, options) { + return { + name: 'docusaurus-plugin', + // highlight-start + async loadContent() { + return 1 + Math.floor(Math.random() * 10); + }, + // highlight-end + }; +} +``` + +## `async contentLoaded({content, actions})` {#contentLoaded} + +The data that was loaded in `loadContent` will be consumed in `contentLoaded`. It can be rendered to routes, registered as global data, etc. + +### `content` {#content} + +`contentLoaded` will be called _after_ `loadContent` is done. The return value of `loadContent()` will be passed to `contentLoaded` as `content`. + +### `actions` {#actions} + +`actions` contain three functions: + +#### `addRoute(config: RouteConfig): void` {#addRoute} + +Create a route to add to the website. + +```ts +export type RouteConfig = { + /** + * With leading slash. Trailing slash will be normalized by config. + */ + path: string; + /** + * Component used to render this route, a path that the bundler can `require`. + */ + component: string; + /** + * Props. Each entry should be `[propName]: pathToPropModule` (created with + * `createData`) + */ + modules?: RouteModules; + /** + * The route context will wrap the `component`. Use `useRouteContext` to + * retrieve what's declared here. Note that all custom route context declared + * here will be namespaced under {@link RouteContext.data}. + */ + context?: RouteModules; + /** + * Nested routes config, useful for "layout routes" having subroutes. + */ + routes?: RouteConfig[]; + /** + * React router config option: `exact` routes would not match subroutes. + */ + exact?: boolean; + /** + * React router config option: `strict` routes are sensitive to the presence + * of a trailing slash. + */ + strict?: boolean; + /** + * Used to sort routes. + * Higher-priority routes will be matched first. + */ + priority?: number; + /** + * Optional route metadata + */ + metadata?: RouteMetadata; + /** + * Extra props; will be available on the client side. + */ + [propName: string]: unknown; +}; + +/** + * Plugin authors can assign extra metadata to the created routes + * It is only available on the Node.js side, and not sent to the browser + * Optional: plugin authors are encouraged but not required to provide it + * + * Some plugins might use this data to provide additional features. + * This is the case of the sitemap plugin to provide support for "lastmod". + * See also: https://github.com/facebook/docusaurus/pull/9954 + */ +export type RouteMetadata = { + /** + * The source code file path that led to the creation of the current route + * In official content plugins, this is usually a Markdown or React file + * This path is expected to be relative to the site directory + */ + sourceFilePath?: string; + /** + * The last updated date of this route + * This is generally read from the Git history of the sourceFilePath + * but can also be provided through other means (usually front matter) + * + * This has notably been introduced for adding "lastmod" support to the + * sitemap plugin, see https://github.com/facebook/docusaurus/pull/9954 + */ + lastUpdatedAt?: number; +}; + +type RouteModules = { + [module: string]: Module | RouteModules | RouteModules[]; +}; + +type Module = + | { + path: string; + __import?: boolean; + query?: ParsedUrlQueryInput; + } + | string; +``` + +#### `createData(name: string, data: any): Promise<string>` {#createData} + +A declarative callback to create static data (generally JSON or string) which can later be provided to your routes as props. Takes the file name and data to be stored, and returns the actual data file's path. + +For example, this plugin below creates a `/friends` page which displays `Your friends are: Yangshun, Sebastien`: + +```jsx title="website/src/components/Friends.js" +import React from 'react'; + +export default function FriendsComponent({friends}) { + return <div>Your friends are {friends.join(',')}</div>; +} +``` + +```js title="docusaurus-friends-plugin/src/index.js" +export default function friendsPlugin(context, options) { + return { + name: 'docusaurus-friends-plugin', + // highlight-start + async contentLoaded({content, actions}) { + const {createData, addRoute} = actions; + // Create friends.json + const friends = ['Yangshun', 'Sebastien']; + const friendsJsonPath = await createData( + 'friends.json', + JSON.stringify(friends), + ); + + // Add the '/friends' routes, and ensure it receives the friends props + addRoute({ + path: '/friends', + component: '@site/src/components/Friends.js', + modules: { + // propName -> JSON file path + friends: friendsJsonPath, + }, + exact: true, + }); + }, + // highlight-end + }; +} +``` + +#### `setGlobalData(data: any): void` {#setGlobalData} + +This function permits one to create some global plugin data that can be read from any page, including the pages created by other plugins, and your theme layout. + +This data becomes accessible to your client-side/theme code through the [`useGlobalData`](../../docusaurus-core.mdx#useGlobalData) and [`usePluginData`](../../docusaurus-core.mdx#usePluginData) hooks. + +:::warning + +Global data is... global: its size affects the loading time of all pages of your site, so try to keep it small. Prefer `createData` and page-specific data whenever possible. + +::: + +For example, this plugin below creates a `/friends` page which displays `Your friends are: Yangshun, Sebastien`: + +```jsx title="website/src/components/Friends.js" +import React from 'react'; +import {usePluginData} from '@docusaurus/useGlobalData'; + +export default function FriendsComponent() { + const {friends} = usePluginData('docusaurus-friends-plugin'); + return <div>Your friends are {friends.join(',')}</div>; +} +``` + +```js title="docusaurus-friends-plugin/src/index.js" +export default function friendsPlugin(context, options) { + return { + name: 'docusaurus-friends-plugin', + // highlight-start + async contentLoaded({content, actions}) { + const {setGlobalData, addRoute} = actions; + // Create friends global data + setGlobalData({friends: ['Yangshun', 'Sebastien']}); + + // Add the '/friends' routes + addRoute({ + path: '/friends', + component: '@site/src/components/Friends.js', + exact: true, + }); + }, + // highlight-end + }; +} +``` + +## `configureWebpack(config, isServer, utils, content)` {#configureWebpack} + +Modifies the internal webpack config. If the return value is a JavaScript object, it will be merged into the final config using [`webpack-merge`](https://github.com/survivejs/webpack-merge). If it is a function, it will be called and receive `config` as the first argument and an `isServer` flag as the second argument. + +:::warning + +The API of `configureWebpack` will be modified in the future to accept an object (`configureWebpack({config, isServer, utils, content})`) + +::: + +### `config` {#config} + +`configureWebpack` is called with `config` generated according to client/server build. You may treat this as the base config to be merged with. + +### `isServer` {#isServer} + +`configureWebpack` will be called both in server build and in client build. The server build receives `true` and the client build receives `false` as `isServer`. + +### `utils` {#utils} + +`configureWebpack` also receives an util object: + +- `getStyleLoaders(isServer: boolean, cssOptions: {[key: string]: any}): Loader[]` +- `getJSLoader(isServer: boolean, cacheOptions?: {}): Loader | null` + +You may use them to return your webpack configuration conditionally. + +For example, this plugin below modify the webpack config to transpile `.foo` files. + +```js title="docusaurus-plugin/src/index.js" +export default function (context, options) { + return { + name: 'custom-docusaurus-plugin', + // highlight-start + configureWebpack(config, isServer, utils) { + const {getJSLoader} = utils; + return { + module: { + rules: [ + { + test: /\.foo$/, + use: [getJSLoader(isServer), 'my-custom-webpack-loader'], + }, + ], + }, + }; + }, + // highlight-end + }; +} +``` + +### `content` {#content-1} + +`configureWebpack` will be called both with the content loaded by the plugin. + +### Merge strategy {#merge-strategy} + +We merge the Webpack configuration parts of plugins into the global Webpack config using [webpack-merge](https://github.com/survivejs/webpack-merge). + +It is possible to specify the merge strategy. For example, if you want a webpack rule to be prepended instead of appended: + +```js title="docusaurus-plugin/src/index.js" +export default function (context, options) { + return { + name: 'custom-docusaurus-plugin', + configureWebpack(config, isServer, utils) { + return { + // highlight-start + mergeStrategy: {'module.rules': 'prepend'}, + module: {rules: [myRuleToPrepend]}, + // highlight-end + }; + }, + }; +} +``` + +Read the [webpack-merge strategy doc](https://github.com/survivejs/webpack-merge#merging-with-strategies) for more details. + +### Configuring dev server {#configuring-dev-server} + +The dev server can be configured through returning a `devServer` field. + +```js title="docusaurus-plugin/src/index.js" +export default function (context, options) { + return { + name: 'custom-docusaurus-plugin', + configureWebpack(config, isServer, utils) { + return { + // highlight-start + devServer: { + open: '/docs', // Opens localhost:3000/docs instead of localhost:3000/ + }, + // highlight-end + }; + }, + }; +} +``` + +## `configurePostCss(options)` {#configurePostCss} + +Modifies [`postcssOptions` of `postcss-loader`](https://webpack.js.org/loaders/postcss-loader/#postcssoptions) during the generation of the client bundle. + +Should return the mutated `postcssOptions`. + +By default, `postcssOptions` looks like this: + +```js +const postcssOptions = { + ident: 'postcss', + plugins: [require('autoprefixer')], +}; +``` + +Example: + +```js title="docusaurus-plugin/src/index.js" +export default function (context, options) { + return { + name: 'docusaurus-plugin', + // highlight-start + configurePostCss(postcssOptions) { + // Appends new PostCSS plugin. + postcssOptions.plugins.push(require('postcss-import')); + return postcssOptions; + }, + // highlight-end + }; +} +``` + +## `postBuild(props)` {#postBuild} + +Called when a (production) build finishes. + +```ts +interface Props { + siteDir: string; + generatedFilesDir: string; + siteConfig: DocusaurusConfig; + outDir: string; + baseUrl: string; + headTags: string; + preBodyTags: string; + postBodyTags: string; + routesPaths: string[]; + routesBuildMetadata: {[location: string]: {noIndex: boolean}}; + plugins: Plugin<any>[]; + content: Content; +} +``` + +Example: + +```js title="docusaurus-plugin/src/index.js" +export default function (context, options) { + return { + name: 'docusaurus-plugin', + // highlight-start + async postBuild({siteConfig = {}, routesPaths = [], outDir}) { + // Print out to console all the rendered routes. + routesPaths.map((route) => { + console.log(route); + }); + }, + // highlight-end + }; +} +``` + +## `injectHtmlTags({content})` {#injectHtmlTags} + +Inject head and/or body HTML tags to Docusaurus generated HTML. + +`injectHtmlTags` will be called both with the content loaded by the plugin. + +```ts +function injectHtmlTags(): { + headTags?: HtmlTags; + preBodyTags?: HtmlTags; + postBodyTags?: HtmlTags; +}; + +type HtmlTags = string | HtmlTagObject | (string | HtmlTagObject)[]; + +type HtmlTagObject = { + /** + * Attributes of the HTML tag + * E.g. `{'disabled': true, 'value': 'demo', 'rel': 'preconnect'}` + */ + attributes?: { + [attributeName: string]: string | boolean; + }; + /** + * The tag name e.g. `div`, `script`, `link`, `meta` + */ + tagName: string; + /** + * The inner HTML + */ + innerHTML?: string; +}; +``` + +Example: + +```js title="docusaurus-plugin/src/index.js" +export default function (context, options) { + return { + name: 'docusaurus-plugin', + loadContent: async () => { + return {remoteHeadTags: await fetchHeadTagsFromAPI()}; + }, + // highlight-start + injectHtmlTags({content}) { + return { + headTags: [ + { + tagName: 'link', + attributes: { + rel: 'preconnect', + href: 'https://www.github.com', + }, + }, + ...content.remoteHeadTags, + ], + preBodyTags: [ + { + tagName: 'script', + attributes: { + charset: 'utf-8', + src: '/noflash.js', + }, + }, + ], + postBodyTags: [`<div> This is post body </div>`], + }; + }, + // highlight-end + }; +} +``` + +Tags will be added as follows: + +- `headTags` will be inserted before the closing `</head>` tag after scripts added by config. +- `preBodyTags` will be inserted after the opening `<body>` tag before any child elements. +- `postBodyTags` will be inserted before the closing `</body>` tag after all child elements. + +## `getClientModules()` {#getClientModules} + +Returns an array of paths to the [client modules](../../advanced/client.mdx#client-modules) that are to be imported into the client bundle. + +As an example, to make your theme load a `customCss` or `customJs` file path from `options` passed in by the user: + +```js title="my-theme/src/index.js" +export default function (context, options) { + const {customCss, customJs} = options || {}; + return { + name: 'name-of-my-theme', + // highlight-start + getClientModules() { + return [customCss, customJs]; + }, + // highlight-end + }; +} +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugin-methods/static-methods.mdx b/website/versioned_docs/version-3.9.2/api/plugin-methods/static-methods.mdx new file mode 100644 index 0000000000..1ae95185b3 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugin-methods/static-methods.mdx @@ -0,0 +1,83 @@ +--- +sidebar_position: 4 +--- + +# Static methods + +Static methods are not part of the plugin instance—they are attached to the constructor function. These methods are used to validate and normalize the plugin options and theme config, which are then used as constructor parameters to initialize the plugin instance. + +## `validateOptions({options, validate})` {#validateOptions} + +Returns validated and normalized options for the plugin. This method is called before the plugin is initialized. You must return the options since they will be passed to the plugin during initialization. + +### `options` {#options} + +`validateOptions` is called with `options` passed to plugin for validation and normalization. + +### `validate` {#validate} + +`validateOptions` is called with `validate` function which takes a **[Joi](https://www.npmjs.com/package/joi)** schema and options as the arguments, returns validated and normalized options. `validate` will automatically handle error and validation config. + +:::tip + +[Joi](https://www.npmjs.com/package/joi) is recommended for validation and normalization of options. + +To avoid mixing Joi versions, use `import {Joi} from '@docusaurus/utils-validation'` + +::: + +If you don't use **[Joi](https://www.npmjs.com/package/joi)** for validation you can throw an Error in case of invalid options and return options in case of success. + +```js title="my-plugin/src/index.js" +export default function myPlugin(context, options) { + return { + name: 'docusaurus-plugin', + // rest of methods + }; +} + +// highlight-start +export function validateOptions({options, validate}) { + const validatedOptions = validate(myValidationSchema, options); + return validatedOptions; +} +// highlight-end +``` + +## `validateThemeConfig({themeConfig, validate})` {#validateThemeConfig} + +Return validated and normalized configuration for the theme. + +### `themeConfig` {#themeConfig} + +`validateThemeConfig` is called with `themeConfig` provided in `docusaurus.config.js` for validation and normalization. + +### `validate` {#validate-1} + +`validateThemeConfig` is called with `validate` function which takes a **[Joi](https://www.npmjs.com/package/joi)** schema and `themeConfig` as the arguments, returns validated and normalized options. `validate` will automatically handle error and validation config. + +:::tip + +[Joi](https://www.npmjs.com/package/joi) is recommended for validation and normalization of theme config. + +To avoid mixing Joi versions, use `import {Joi} from '@docusaurus/utils-validation'` + +::: + +If you don't use **[Joi](https://www.npmjs.com/package/joi)** for validation you can throw an Error in case of invalid options. + +```js title="my-theme/src/index.js" +export default function myPlugin(context, options) { + return { + name: 'docusaurus-plugin', + // rest of methods + }; +} + +// highlight-start +export function validateThemeConfig({themeConfig, validate}) { + const validatedThemeConfig = validate(myValidationSchema, options); + return validatedThemeConfig; +} +// highlight-end +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugins/_category_.yml b/website/versioned_docs/version-3.9.2/api/plugins/_category_.yml new file mode 100644 index 0000000000..cffabddbd5 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/_category_.yml @@ -0,0 +1,5 @@ +label: Plugins +position: 2 +link: + type: doc + id: api/plugins/plugins-overview # Dogfood using a "qualified id" diff --git a/website/versioned_docs/version-3.9.2/api/plugins/_partial-tags-file-api-ref-section.mdx b/website/versioned_docs/version-3.9.2/api/plugins/_partial-tags-file-api-ref-section.mdx new file mode 100644 index 0000000000..f6d247c70f --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/_partial-tags-file-api-ref-section.mdx @@ -0,0 +1,54 @@ +## Tags File {#tags-file} + +Use the [`tags` plugin option](#tags) to configure the path of a YAML tags file. + +By convention, the plugin will look for a `tags.yml` file at the root of your content folder(s). + +This file can contain a list of predefined tags. You can reference these tags by their keys in Markdown files thanks to the [`tags` front matter](#markdown-front-matter). + +:::tip Keeping tags consistent + +Using a tags file, you can ensure that your tags usage is consistent across your plugin content set. Use the [`onInlineTags: 'throw'`](#onInlineTags) plugin option to enforce this consistency and prevent usage of inline tags declared on the fly. + +::: + +### Types {#tags-file-types} + +The YAML content of the provided tags file should respect the following shape: + +```tsx +type Tag = { + label?: string; // Tag display label + permalink?: string; // Tag URL pathname segment + description?: string; // Tag description displayed in the tag page +}; + +type TagsFileInput = Record<string, Partial<Tag> | null>; +``` + +### Example {#tags-file-example} + +```yml title="tags.yml" +releases: + label: 'Product releases' + permalink: '/product-releases' + description: 'Content related to product releases.' + +# A partial tag definition is also valid +announcements: + label: 'Announcements' + +# An empty tag definition is also valid +# Other attributes will be inferred from the key +emptyTag: +``` + +```md title="content.md" +--- +tags: [releases, announcements, emptyTag] +--- + +# Title + +Content +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugins/overview.mdx b/website/versioned_docs/version-3.9.2/api/plugins/overview.mdx new file mode 100644 index 0000000000..94ecbed65c --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/overview.mdx @@ -0,0 +1,34 @@ +--- +sidebar_position: 0 +id: plugins-overview +sidebar_label: Plugins overview +slug: /api/plugins +--- + +# Docusaurus plugins + +We provide official Docusaurus plugins. + +## Content plugins {#content-plugins} + +These plugins are responsible for loading your site's content, and creating pages for your theme to render. + +- [@docusaurus/plugin-content-docs](./plugin-content-docs.mdx) +- [@docusaurus/plugin-content-blog](./plugin-content-blog.mdx) +- [@docusaurus/plugin-content-pages](./plugin-content-pages.mdx) + +## Behavior plugins {#behavior-plugins} + +These plugins will add a useful behavior to your Docusaurus site. + +- [@docusaurus/plugin-debug](./plugin-debug.mdx) +- [@docusaurus/plugin-sitemap](./plugin-sitemap.mdx) +- [@docusaurus/plugin-svgr](./plugin-svgr.mdx) +- [@docusaurus/plugin-rsdoctor](./plugin-rsdoctor.mdx) +- [@docusaurus/plugin-pwa](./plugin-pwa.mdx) +- [@docusaurus/plugin-client-redirects](./plugin-client-redirects.mdx) +- [@docusaurus/plugin-ideal-image](./plugin-ideal-image.mdx) +- [@docusaurus/plugin-google-analytics](./plugin-google-analytics.mdx) +- [@docusaurus/plugin-google-gtag](./plugin-google-gtag.mdx) +- [@docusaurus/plugin-google-tag-manager](./plugin-google-tag-manager.mdx) +- [@docusaurus/plugin-css-cascade-layers](./plugin-css-cascade-layers.mdx) diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-client-redirects.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-client-redirects.mdx new file mode 100644 index 0000000000..baca3a6bb9 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-client-redirects.mdx @@ -0,0 +1,127 @@ +--- +sidebar_position: 4 +slug: /api/plugins/@docusaurus/plugin-client-redirects +--- + +# 📦 plugin-client-redirects + +import APITable from '@site/src/components/APITable'; + +Docusaurus Plugin to generate **client-side redirects**. + +This plugin will write additional HTML pages to your static site that redirect the user to your existing Docusaurus pages with JavaScript. + +:::warning production only + +This plugin is always inactive in development and **only active in production** because it works on the build output. + +::: + +:::warning + +It is better to use server-side redirects whenever possible. + +Before using this plugin, you should look if your hosting provider doesn't offer this feature. + +::: + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-client-redirects +``` + +## Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Option | Type | Default | Description | +| --- | --- | --- | --- | +| `fromExtensions` | `string[]` | `[]` | The extensions to be removed from the route after redirecting. | +| `toExtensions` | `string[]` | `[]` | The extensions to be appended to the route after redirecting. | +| `redirects` | <code>[RedirectRule](#RedirectRule)[]</code> | `[]` | The list of redirect rules. | +| `createRedirects` | <code>[CreateRedirectsFn](#CreateRedirectsFn)</code> | `undefined` | A callback to create a redirect rule. Docusaurus query this callback against every path it has created, and use its return value to output more paths. | + +```mdx-code-block +</APITable> +``` + +:::note + +This plugin will also read the [`siteConfig.onDuplicateRoutes`](../docusaurus.config.js.mdx#onDuplicateRoutes) config to adjust its logging level when multiple files will be emitted to the same location. + +::: + +### Types {#types} + +#### `RedirectRule` {#RedirectRule} + +```ts +type RedirectRule = { + to: string; + from: string | string[]; +}; +``` + +:::note + +The idea of "from" and "to" is central in this plugin. "From" means a path that you want to _create_, i.e. an extra HTML file that will be written; "to" means a path to want to redirect _to_, usually a route that Docusaurus already knows about. + +This is why you can have multiple "from" for the same "to": we will create multiple HTML files that all redirect to the same destination. On the other hand, one "from" can never have more than one "to": the written HTML file needs to have a determinate destination. + +::: + +#### `CreateRedirectsFn` {#CreateRedirectsFn} + +```ts +// The parameter `path` is a route that Docusaurus has already created. It can +// be seen as the "to", and your return value is the "from". Returning a falsy +// value will not create any redirect pages for this particular path. +type CreateRedirectsFn = (path: string) => string[] | string | null | undefined; +``` + +### Example configuration {#ex-config} + +Here's an example configuration: + +```js title="docusaurus.config.js" +export default { + plugins: [ + [ + '@docusaurus/plugin-client-redirects', + // highlight-start + { + fromExtensions: ['html', 'htm'], // /myPage.html -> /myPage + toExtensions: ['exe', 'zip'], // /myAsset -> /myAsset.zip (if latter exists) + redirects: [ + // /docs/oldDoc -> /docs/newDoc + { + to: '/docs/newDoc', + from: '/docs/oldDoc', + }, + // Redirect from multiple old paths to the new path + { + to: '/docs/newDoc2', + from: ['/docs/oldDocFrom2019', '/docs/legacyDocFrom2016'], + }, + ], + createRedirects(existingPath) { + if (existingPath.includes('/community')) { + // Redirect from /docs/team/X to /community/X and /docs/support/X to /community/X + return [ + existingPath.replace('/community', '/docs/team'), + existingPath.replace('/community', '/docs/support'), + ]; + } + return undefined; // Return a falsy value: no redirect created + }, + }, + // highlight-end + ], + ], +}; +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-content-blog.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-content-blog.mdx new file mode 100644 index 0000000000..f8a17e4347 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-content-blog.mdx @@ -0,0 +1,419 @@ +--- +sidebar_position: 2 +slug: /api/plugins/@docusaurus/plugin-content-blog +--- + +# 📦 plugin-content-blog + +import APITable from '@site/src/components/APITable'; + +Provides the [Blog](blog.mdx) feature and is the default blog plugin for Docusaurus. + +:::warning some features production only + +The [feed feature](../../blog.mdx#feed) works by extracting the build output, and is **only active in production**. + +::: + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-content-blog +``` + +:::tip + +If you use the preset `@docusaurus/preset-classic`, you don't need to install this plugin as a dependency. + +You can configure this plugin through the [preset options](../../using-plugins.mdx#docusauruspreset-classic). + +::: + +## Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `path` | `string` | `'blog'` | Path to the blog content directory on the file system, relative to site dir. | +| `editUrl` | <code>string \| [EditUrlFn](#EditUrlFn)</code> | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativePostPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | +| `editLocalizedFiles` | `boolean` | `false` | The edit URL will target the localized file, instead of the original unlocalized file. Ignored when `editUrl` is a function. | +| `blogTitle` | `string` | `'Blog'` | Blog page title for better SEO. | +| `blogDescription` | `string` | `'Blog'` | Blog page meta description for better SEO. | +| `blogSidebarCount` | <code>number \| 'ALL'</code> | `5` | Number of blog post elements to show in the blog sidebar. `'ALL'` to show all blog posts; `0` to disable. | +| `blogSidebarTitle` | `string` | `'Recent posts'` | Title of the blog sidebar. | +| `routeBasePath` | `string` | `'blog'` | URL route for the blog section of your site. **DO NOT** include a trailing slash. Use `/` to put the blog at root path. | +| `tagsBasePath` | `string` | `'tags'` | URL route for the tags section of your blog. Will be appended to `routeBasePath`. | +| `pageBasePath` | `string` | `'page'` | URL route for the pages section of your blog. Will be appended to `routeBasePath`. | +| `archiveBasePath` | <code>string \| null</code> | `'archive'` | URL route for the archive section of your blog. Will be appended to `routeBasePath`. **DO NOT** include a trailing slash. Use `null` to disable generation of archive. | +| `authorsBasePath` | `string` | `'authors'` | URL route for the authors pages of your blog. Will be appended to `path`. | +| `include` | `string[]` | `['**/*.{md,mdx}']` | Array of glob patterns matching Markdown files to be built, relative to the content path. | +| `exclude` | `string[]` | _See example configuration_ | Array of glob patterns matching Markdown files to be excluded. Serves as refinement based on the `include` option. | +| `postsPerPage` | <code>number \| 'ALL'</code> | `10` | Number of posts to show per page in the listing page. Use `'ALL'` to display all posts on one listing page. | +| `blogListComponent` | `string` | `'@theme/BlogListPage'` | Root component of the blog listing page. | +| `blogPostComponent` | `string` | `'@theme/BlogPostPage'` | Root component of each blog post page. | +| `blogTagsListComponent` | `string` | `'@theme/BlogTagsListPage'` | Root component of the tags list page. | +| `blogTagsPostsComponent` | `string` | `'@theme/BlogTagsPostsPage'` | Root component of the "posts containing tag" page. | +| `blogArchiveComponent` | `string` | `'@theme/BlogArchivePage'` | Root component of the blog archive page. | +| `blogAuthorsPostsComponent` | `string` | `'@theme/Blog/Pages/BlogAuthorsPostsPage'` | Root component of the blog author page. | +| `blogAuthorsListComponent` | `string` | `'@theme/Blog/Pages/BlogAuthorsListPage'` | Root component of the blog authors page index. | +| `remarkPlugins` | `any[]` | `[]` | Remark plugins passed to MDX. | +| `rehypePlugins` | `any[]` | `[]` | Rehype plugins passed to MDX. | +| `rehypePlugins` | `any[]` | `[]` | Recma plugins passed to MDX. | +| `beforeDefaultRemarkPlugins` | `any[]` | `[]` | Custom Remark plugins passed to MDX before the default Docusaurus Remark plugins. | +| `beforeDefaultRehypePlugins` | `any[]` | `[]` | Custom Rehype plugins passed to MDX before the default Docusaurus Rehype plugins. | +| `truncateMarker` | `RegExp` | `/<!--\s*truncate\s*-->/` \| `\{\/\*\s*truncate\s*\*\/\}/` | Truncate marker marking where the summary ends. | +| `showReadingTime` | `boolean` | `true` | Show estimated reading time for the blog post. | +| `readingTime` | `ReadingTimeFn` | The default reading time | A callback to customize the reading time number displayed. | +| `authorsMapPath` | `string` | `'authors.yml'` | Path to the authors map file, relative to the blog content directory. | +| `feedOptions` | _See below_ | `{type: ['rss', 'atom']}` | Blog feed. | +| `feedOptions.type` | <code>[FeedType](#FeedType) \| [FeedType](#FeedType)[] \| 'all' \| null</code> | **Required** | Type of feed to be generated. Use `null` to disable generation. | +| `feedOptions.createFeedItems` | <code>[CreateFeedItemsFn](#CreateFeedItemsFn) \| undefined</code> | `undefined` | An optional function which can be used to transform and / or filter the items in the feed. | +| `feedOptions.limit` | `number \| null \| false` | `20` | Limits the feed to the specified number of posts, `false` or `null` for all entries. Defaults to `20`. | +| `feedOptions.title` | `string` | `siteConfig.title` | Title of the feed. | +| `feedOptions.description` | `string` | <code>\`$\{siteConfig.title} Blog\`</code> | Description of the feed. | +| `feedOptions.copyright` | `string` | `undefined` | Copyright message. | +| `feedOptions.xslt` | <code>boolean \| [FeedXSLTOptions](#FeedXSLTOptions)</code> | `undefined` | Permits to style the blog XML feeds with XSLT so that browsers render them nicely. | +| `feedOptions.language` | `string` (See [documentation](http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes) for possible values) | `undefined` | Language metadata of the feed. | +| `sortPosts` | <code>'descending' \| 'ascending' </code> | `'descending'` | Governs the direction of blog post sorting. | +| `processBlogPosts` | <code>[ProcessBlogPostsFn](#ProcessBlogPostsFn)</code> | `undefined` | An optional function which can be used to transform blog posts (filter, modify, delete, etc...). | +| `showLastUpdateAuthor` | `boolean` | `false` | Whether to display the author who last updated the blog post. | +| `showLastUpdateTime` | `boolean` | `false` | Whether to display the last date the blog post was updated. This requires access to git history during the build, so will not work correctly with shallow clones (a common default for CI systems). With GitHub `actions/checkout`, use`fetch-depth: 0`. | +| `tags` | `string \| false \| null \| undefined` | `tags.yml` | Path to the YAML tags file listing pre-defined tags. Relative to the blog content directory. | +| `onInlineTags` | `'ignore' \| 'log' \| 'warn' \| 'throw'` | `warn` | The plugin behavior when blog posts contain inline tags (not appearing in the list of pre-defined tags, usually `tags.yml`). | +| `onUntruncatedBlogPosts` | `'ignore' \| 'log' \| 'warn' \| 'throw'` | `warn` | The plugin behavior when blog posts do not contain a truncate marker. | + +```mdx-code-block +</APITable> +``` + +### Types {#types} + +#### `EditUrlFn` {#EditUrlFn} + +```ts +type EditUrlFunction = (params: { + blogDirPath: string; + blogPath: string; + permalink: string; + locale: string; +}) => string | undefined; +``` + +#### `ReadingTimeFn` {#ReadingTimeFn} + +```ts +type ReadingTimeOptions = { + wordsPerMinute: number; +}; + +type ReadingTimeCalculator = (params: { + content: string; + locale: string; + frontMatter?: BlogPostFrontMatter & Record<string, unknown>; + options?: ReadingTimeOptions; +}) => number; + +type ReadingTimeFn = (params: { + content: string; + locale: string; + frontMatter: BlogPostFrontMatter & Record<string, unknown>; + defaultReadingTime: ReadingTimeCalculator; +}) => number | undefined; +``` + +#### `FeedType` {#FeedType} + +```ts +type FeedType = 'rss' | 'atom' | 'json'; +``` + +#### `FeedXSLTOptions` {#FeedXSLTOptions} + +Permits to style the blog XML feeds so that browsers render them nicely with [XSLT](https://developer.mozilla.org/en-US/docs/Web/XSLT). + +- Use `true` to let the blog use its built-in `.xsl` and `.css` files to style the blog feed +- Use a falsy value (`undefined | null | false`) to disable the feature +- Use a `string` to provide a file path to a custom `.xsl` file relative to the blog content folder. By convention, you must provide a `.css` file with the exact same name. + +```ts +type FeedXSLTOptions = + | boolean + | undefined + | null + | { + rss?: string | boolean | null | undefined; + atom?: string | boolean | null | undefined; + }; +``` + +#### `CreateFeedItemsFn` {#CreateFeedItemsFn} + +```ts +type CreateFeedItemsFn = (params: { + blogPosts: BlogPost[]; + siteConfig: DocusaurusConfig; + outDir: string; + defaultCreateFeedItemsFn: CreateFeedItemsFn; +}) => Promise<BlogFeedItem[]>; +``` + +#### `ProcessBlogPostsFn` {#ProcessBlogPostsFn} + +```ts +type ProcessBlogPostsFn = (params: { + blogPosts: BlogPost[]; +}) => Promise<void | BlogPost[]>; +``` + +### Example configuration {#ex-config} + +You can configure this plugin through preset options or plugin options. + +:::tip + +Most Docusaurus users configure this plugin through the preset options. + +::: + +```js config-tabs +// Preset Options: blog +// Plugin Options: @docusaurus/plugin-content-blog + +const config = { + path: 'blog', + // Simple use-case: string editUrl + // editUrl: 'https://github.com/facebook/docusaurus/edit/main/website/', + // Advanced use-case: functional editUrl + editUrl: ({locale, blogDirPath, blogPath, permalink}) => + `https://github.com/facebook/docusaurus/edit/main/website/${blogDirPath}/${blogPath}`, + editLocalizedFiles: false, + blogTitle: 'Blog title', + blogDescription: 'Blog', + blogSidebarCount: 5, + blogSidebarTitle: 'All our posts', + routeBasePath: 'blog', + include: ['**/*.{md,mdx}'], + exclude: [ + '**/_*.{js,jsx,ts,tsx,md,mdx}', + '**/_*/**', + '**/*.test.{js,jsx,ts,tsx}', + '**/__tests__/**', + ], + postsPerPage: 10, + blogListComponent: '@theme/BlogListPage', + blogPostComponent: '@theme/BlogPostPage', + blogTagsListComponent: '@theme/BlogTagsListPage', + blogTagsPostsComponent: '@theme/BlogTagsPostsPage', + remarkPlugins: [require('./my-remark-plugin')], + rehypePlugins: [], + beforeDefaultRemarkPlugins: [], + beforeDefaultRehypePlugins: [], + truncateMarker: /<!--\s*(truncate)\s*-->/, + showReadingTime: true, + feedOptions: { + type: '', + title: '', + description: '', + copyright: '', + language: undefined, + createFeedItems: async (params) => { + const {blogPosts, defaultCreateFeedItems, ...rest} = params; + return defaultCreateFeedItems({ + // keep only the 10 most recent blog posts in the feed + blogPosts: blogPosts.filter((item, index) => index < 10), + ...rest, + }); + }, + }, +}; +``` + +## Markdown front matter {#markdown-front-matter} + +Markdown documents can use the following Markdown [front matter](../../guides/markdown-features/markdown-features-intro.mdx#front-matter) metadata fields, enclosed by a line `---` on either side. + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `authors` | `Authors` | `undefined` | List of blog post authors (or unique author). Read the [`authors` guide](../../blog.mdx#blog-post-authors) for more explanations. Prefer `authors` over the `author_*` front matter fields, even for single author blog posts. | +| `author` | `string` | `undefined` | ⚠️ Prefer using `authors`. The blog post author's name. | +| `author_url` | `string` | `undefined` | ⚠️ Prefer using `authors`. The URL that the author's name will be linked to. This could be a GitHub, X, Facebook profile URL, etc. | +| `author_image_url` | `string` | `undefined` | ⚠️ Prefer using `authors`. The URL to the author's thumbnail image. | +| `author_title` | `string` | `undefined` | ⚠️ Prefer using `authors`. A description of the author. | +| `title` | `string` | Markdown title | The blog post title. | +| `title_meta` | `string` | `frontMatter.title` | The blog post SEO metadata title, used in `<head>` for `<title>` and `og:title`. Permits to override `title` when the displayed title and SEO title should be different. | +| `sidebar_label` | `string` | `title` | A custom label for the blog sidebar, replacing the default one (`title`). | +| `date` | `string` | File name or file creation time | The blog post creation date. If not specified, this can be extracted from the file or folder name, e.g, `2021-04-15-blog-post.mdx`, `2021-04-15-blog-post/index.mdx`, `2021/04/15/blog-post.mdx`. Otherwise, it is the Markdown file creation time. | +| `tags` | `Tag[]` | `undefined` | A list of strings or objects of two string fields `label` and `permalink` to tag to your post. Strings can be a reference to keys of a [tags file](#tags-file) (usually `tags.yml`) | +| `draft` | `boolean` | `false` | Draft blog posts will only be available during development. | +| `unlisted` | `boolean` | `false` | Unlisted blog posts will be available in both development and production. They will be "hidden" in production, not indexed, excluded from sitemaps, and can only be accessed by users having a direct link. | +| `hide_table_of_contents` | `boolean` | `false` | Whether to hide the table of contents to the right. | +| `toc_min_heading_level` | `number` | `2` | The minimum heading level shown in the table of contents. Must be between 2 and 6 and lower or equal to the max value. | +| `toc_max_heading_level` | `number` | `3` | The max heading level shown in the table of contents. Must be between 2 and 6. | +| `keywords` | `string[]` | `undefined` | Keywords meta tag, which will become the `<meta name="keywords" content="keyword1,keyword2,..."/>` in `<head>`, used by search engines. | +| `description` | `string` | The first line of Markdown content | The description of your document, which will become the `<meta name="description" content="..."/>` and `<meta property="og:description" content="..."/>` in `<head>`, used by search engines. | +| `image` | `string` | `undefined` | Cover or thumbnail image that will be used as the `<meta property="og:image" content="..."/>` in the `<head>`, enhancing link previews on social media and messaging platforms. | +| `slug` | `string` | File path | Allows to customize the blog post URL (`/<routeBasePath>/<slug>`). Support multiple patterns: `slug: my-blog-post`, `slug: /my/path/to/blog/post`, slug: `/`. | +| `last_update` | `FrontMatterLastUpdate` | `undefined` | Allows overriding the last update author/date. Date can be any [parsable date string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse). | + +```mdx-code-block +</APITable> +``` + +```ts +type FrontMatterLastUpdate = {date?: string; author?: string}; + +type Tag = string | {label: string; permalink: string}; + +// An author key references an author from the global plugin authors.yml file +type AuthorKey = string; + +// Social platform name -> Social platform link +// Example: {MyPlatform: 'https://myplatform.com/myusername'} +// Pre-defined platforms +// ("x", "github", "twitter", "linkedin", "stackoverflow", "instagram", "bluesky", "mastodon", "threads", "twitch", "youtube", "email") accept handles: +// Example: {github: 'slorber'} +type AuthorSocials = Record<string, string>; + +type Author = { + key?: AuthorKey; + name: string; + title?: string; + url?: string; + image_url?: string; + socials?: AuthorSocials; +}; + +// The front matter authors field allows various possible shapes +type Authors = AuthorKey | Author | (AuthorKey | Author)[]; +``` + +Example: + +```md +--- +title: Welcome Docusaurus +authors: + - slorber + - yangshun + - name: Joel Marcey + title: Co-creator of Docusaurus 1 + url: https://github.com/JoelMarcey + image_url: https://github.com/JoelMarcey.png + socials: + x: joelmarcey + github: JoelMarcey +tags: [docusaurus] +description: This is my first post on Docusaurus. +image: https://i.imgur.com/mErPwqL.png +hide_table_of_contents: false +--- + +A Markdown blog post +``` + +import TagsFileApiRefSection from './_partial-tags-file-api-ref-section.mdx'; + +<TagsFileApiRefSection /> + +## Authors File {#authors-file} + +Use the [`authors` plugin option](#authors) to configure the path of a YAML authors file. + +By convention, the plugin will look for a `authors.yml` file at the root of your blog content folder(s). + +This file can contain a list of predefined [global blog authors](../../blog.mdx#global-authors). You can reference these authors by their keys in Markdown files thanks to the [`authors` front matter](#markdown-front-matter). + +### Types {#authors-file-types} + +The YAML content of the provided authors file should respect the following shape: + +```tsx +type AuthorsMapInput = { + [authorKey: string]: AuthorInput; +}; + +type AuthorInput = { + name?: string; + title?: string; + description?: string; + imageURL?: string; + url?: string; + email?: string; + page?: boolean | {permalink: string}; + socials?: Record<string, string>; + [customAuthorAttribute: string]: unknown; +}; +``` + +### Example {#authors-file-example} + +```yml title="tags.yml" +slorber: + name: Sébastien Lorber + title: Docusaurus maintainer + url: https://sebastienlorber.com + image_url: https://github.com/slorber.png + page: true + socials: + x: sebastienlorber + github: slorber + email: seb@example.com + +jmarcey: + name: Joel Marcey + title: Co-creator of Docusaurus 1 + url: https://github.com/JoelMarcey + image_url: https://github.com/JoelMarcey.png + email: jimarcey@gmail.com + page: + permalink: '/joel-marcey' + socials: + x: joelmarcey + github: JoelMarcey +``` + +```md title="blog/my-blog-post.md" +--- +authors: [slorber, jmarcey] +--- + +# My Blog Post + +Content +``` + +## i18n {#i18n} + +Read the [i18n introduction](../../i18n/i18n-introduction.mdx) first. + +### Translation files location {#translation-files-location} + +- **Base path**: `website/i18n/[locale]/docusaurus-plugin-content-blog` +- **Multi-instance path**: `website/i18n/[locale]/docusaurus-plugin-content-blog-[pluginId]` +- **JSON files**: extracted with [`docusaurus write-translations`](../../cli.mdx#docusaurus-write-translations-sitedir) +- **Markdown files**: `website/i18n/[locale]/docusaurus-plugin-content-blog` + +### Example file-system structure {#example-file-system-structure} + +```bash +website/i18n/[locale]/docusaurus-plugin-content-blog +│ +│ # translations for website/blog +├── authors.yml +├── first-blog-post.md +├── second-blog-post.md +│ +│ # translations for the plugin options that will be rendered +└── options.json +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-content-docs.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-content-docs.mdx new file mode 100644 index 0000000000..324e2f5004 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-content-docs.mdx @@ -0,0 +1,377 @@ +--- +sidebar_position: 1 +slug: /api/plugins/@docusaurus/plugin-content-docs +--- + +# 📦 plugin-content-docs + +import APITable from '@site/src/components/APITable'; + +Provides the [Docs](../../guides/docs/docs-introduction.mdx) functionality and is the default docs plugin for Docusaurus. + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-content-docs +``` + +:::tip + +If you use the preset `@docusaurus/preset-classic`, you don't need to install this plugin as a dependency. + +You can configure this plugin through the [preset options](../../using-plugins.mdx#docusauruspreset-classic). + +::: + +## Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `path` | `string` | `'docs'` | Path to the docs content directory on the file system, relative to site directory. | +| `editUrl` | <code>string \| [EditUrlFunction](#EditUrlFunction)</code> | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | +| `editLocalizedFiles` | `boolean` | `false` | The edit URL will target the localized file, instead of the original unlocalized file. Ignored when `editUrl` is a function. | +| `editCurrentVersion` | `boolean` | `false` | The edit URL will always target the current version doc instead of older versions. Ignored when `editUrl` is a function. | +| `routeBasePath` | `string` | `'docs'` | URL route for the docs section of your site. **DO NOT** include a trailing slash. Use `/` for shipping docs without base path. | +| `tagsBasePath` | `string` | `'tags'` | URL route for the tags list page of your site. It is prepended to the `routeBasePath`. | +| `include` | `string[]` | `['**/*.{md,mdx}']` | Array of glob patterns matching Markdown files to be built, relative to the content path. | +| `exclude` | `string[]` | _See example configuration_ | Array of glob patterns matching Markdown files to be excluded. Serves as refinement based on the `include` option. | +| `sidebarPath` | <code>false \| string</code> | `undefined` | Path to a sidebars configuration file, loaded in a Node.js context. Use `false` to disable sidebars, or `undefined` to create a fully autogenerated sidebar. | +| `sidebarCollapsible` | `boolean` | `true` | Whether sidebar categories are collapsible by default. See also [Collapsible categories](/docs/sidebar/items#collapsible-categories) | +| `sidebarCollapsed` | `boolean` | `true` | Whether sidebar categories are collapsed by default. See also [Expanded categories by default](/docs/sidebar/items#expanded-categories-by-default) | +| `sidebarItemsGenerator` | <code>[SidebarGenerator](#SidebarGenerator)</code> | _Omitted_ | Function used to replace the sidebar items of type `'autogenerated'` with real sidebar items (docs, categories, links...). See also [Customize the sidebar items generator](/docs/sidebar/autogenerated#customize-the-sidebar-items-generator) | +| `numberPrefixParser` | <code>boolean \| [PrefixParser](#PrefixParser)</code> | _Omitted_ | Custom parsing logic to extract number prefixes from file names. Use `false` to disable this behavior and leave the docs untouched, and `true` to use the default parser. See also [Using number prefixes](/docs/sidebar/autogenerated#using-number-prefixes) | +| `docsRootComponent` | `string` | `'@theme/DocsRoot'` | Parent component of all the docs plugin pages (including all versions). Stays mounted when navigation between docs pages and versions. | +| `docVersionRootComponent` | `string` | `'@theme/DocVersionLayout'` | Parent component of all docs pages of an individual version (doc pages with sidebars, tags pages). Stays mounted when navigation between pages of that specific version. | +| `docRootComponent` | `string` | `'@theme/DocRoot'` | Parent component of all doc pages with sidebars (regular docs pages, category generated index pages). Stays mounted when navigation between such pages. | +| `docItemComponent` | `string` | `'@theme/DocItem'` | Main doc container, with TOC, pagination, etc. | +| `docTagsListComponent` | `string` | `'@theme/DocTagsListPage'` | Root component of the tags list page | +| `docTagDocListComponent` | `string` | `'@theme/DocTagDocListPage'` | Root component of the "docs containing tag X" page. | +| `docCategoryGeneratedIndexComponent` | `string` | `'@theme/DocCategoryGeneratedIndexPage'` | Root component of the generated category index page. | +| `remarkPlugins` | `any[]` | `[]` | Remark plugins passed to MDX. | +| `rehypePlugins` | `any[]` | `[]` | Rehype plugins passed to MDX. | +| `rehypePlugins` | `any[]` | `[]` | Recma plugins passed to MDX. | +| `beforeDefaultRemarkPlugins` | `any[]` | `[]` | Custom Remark plugins passed to MDX before the default Docusaurus Remark plugins. | +| `beforeDefaultRehypePlugins` | `any[]` | `[]` | Custom Rehype plugins passed to MDX before the default Docusaurus Rehype plugins. | +| `showLastUpdateAuthor` | `boolean` | `false` | Whether to display the author who last updated the doc. | +| `showLastUpdateTime` | `boolean` | `false` | Whether to display the last date the doc was updated. This requires access to git history during the build, so will not work correctly with shallow clones (a common default for CI systems). With GitHub `actions/checkout`, use`fetch-depth: 0`. | +| `breadcrumbs` | `boolean` | `true` | Enable or disable the breadcrumbs on doc pages. | +| `disableVersioning` | `boolean` | `false` | Explicitly disable versioning even when multiple versions exist. This will make the site only include the current version. Will error if `includeCurrentVersion: false` and `disableVersioning: true`. | +| `includeCurrentVersion` | `boolean` | `true` | Include the current version of your docs. | +| `lastVersion` | `string` | First version in `versions.json` | The version navigated to in priority and displayed by default for docs navbar items. | +| `onlyIncludeVersions` | `string[]` | All versions available | Only include a subset of all available versions. | +| `versions` | <code>[VersionsConfig](#VersionsConfig)</code> | `{}` | Independent customization of each version's properties. | +| `tags` | `string \| false \| null \| undefined` | `tags.yml` | Path to a YAML file listing pre-defined tags. Relative to the docs version content directories. | +| `onInlineTags` | `'ignore' \| 'log' \| 'warn' \| 'throw'` | `warn` | The plugin behavior when docs contain inline tags (not appearing in the list of pre-defined tags, usually `docs/tags.yml`). | + +```mdx-code-block +</APITable> +``` + +### Types {#types} + +#### `EditUrlFunction` {#EditUrlFunction} + +```ts +type EditUrlFunction = (params: { + version: string; + versionDocsDirPath: string; + docPath: string; + permalink: string; + locale: string; +}) => string | undefined; +``` + +#### `PrefixParser` {#PrefixParser} + +```ts +type PrefixParser = (filename: string) => { + filename: string; + numberPrefix?: number; +}; +``` + +#### `SidebarGenerator` {#SidebarGenerator} + +```ts +type SidebarGenerator = (generatorArgs: { + /** The sidebar item with type "autogenerated" to be transformed. */ + item: {type: 'autogenerated'; dirName: string}; + /** Useful metadata for the version this sidebar belongs to. */ + version: {contentPath: string; versionName: string}; + /** All the docs of that version (unfiltered). */ + docs: { + id: string; + title: string; + frontMatter: DocFrontMatter & Record<string, unknown>; + source: string; + sourceDirName: string; + sidebarPosition?: number | undefined; + }[]; + /** Number prefix parser configured for this plugin. */ + numberPrefixParser: PrefixParser; + /** The default category index matcher which you can override. */ + isCategoryIndex: CategoryIndexMatcher; + /** + * key is the path relative to the doc content directory, value is the + * category metadata file's content. + */ + categoriesMetadata: {[filePath: string]: CategoryMetadata}; + /** + * Useful to re-use/enhance the default sidebar generation logic from + * Docusaurus. + */ + defaultSidebarItemsGenerator: SidebarGenerator; + // Returns an array of sidebar items — same as what you can declare in + // sidebars.js, except for shorthands. See https://docusaurus.io/docs/sidebar/items +}) => Promise<SidebarItem[]>; + +type CategoryIndexMatcher = (param: { + /** The file name, without extension */ + fileName: string; + /** + * The list of directories, from lowest level to highest. + * If there's no dir name, directories is ['.'] + */ + directories: string[]; + /** The extension, with a leading dot */ + extension: string; +}) => boolean; +``` + +#### `VersionsConfig` {#VersionsConfig} + +```ts +type VersionConfig = { + /** + * The base path of the version, will be appended to `baseUrl` + + * `routeBasePath`. + */ + path?: string; + /** The label of the version to be used in badges, dropdowns, etc. */ + label?: string; + /** The banner to show at the top of a doc of that version. */ + banner?: 'none' | 'unreleased' | 'unmaintained'; + /** Show a badge with the version label at the top of each doc. */ + badge?: boolean; + /** Prevents search engines from indexing this version */ + noIndex?: boolean; + /** Add a custom class name to the <html> element of each doc */ + className?: string; +}; + +type VersionsConfig = {[versionName: string]: VersionConfig}; +``` + +### Example configuration {#ex-config} + +You can configure this plugin through preset options or plugin options. + +:::tip + +Most Docusaurus users configure this plugin through the preset options. + +::: + +```js config-tabs +// Preset Options: docs +// Plugin Options: @docusaurus/plugin-content-docs + +const config = { + path: 'docs', + breadcrumbs: true, + // Simple use-case: string editUrl + // editUrl: 'https://github.com/facebook/docusaurus/edit/main/website/', + // Advanced use-case: functional editUrl + editUrl: ({versionDocsDirPath, docPath}) => + `https://github.com/facebook/docusaurus/edit/main/website/${versionDocsDirPath}/${docPath}`, + editLocalizedFiles: false, + editCurrentVersion: false, + routeBasePath: 'docs', + include: ['**/*.md', '**/*.mdx'], + exclude: [ + '**/_*.{js,jsx,ts,tsx,md,mdx}', + '**/_*/**', + '**/*.test.{js,jsx,ts,tsx}', + '**/__tests__/**', + ], + sidebarPath: 'sidebars.js', + async sidebarItemsGenerator({ + defaultSidebarItemsGenerator, + numberPrefixParser, + item, + version, + docs, + isCategoryIndex, + }) { + // Use the provided data to generate a custom sidebar slice + return [ + {type: 'doc', id: 'intro'}, + { + type: 'category', + label: 'Tutorials', + items: [ + {type: 'doc', id: 'tutorial1'}, + {type: 'doc', id: 'tutorial2'}, + ], + }, + ]; + }, + numberPrefixParser(filename) { + // Implement your own logic to extract a potential number prefix + const numberPrefix = findNumberPrefix(filename); + // Prefix found: return it with the cleaned filename + if (numberPrefix) { + return { + numberPrefix, + filename: filename.replace(prefix, ''), + }; + } + // No number prefix found + return {numberPrefix: undefined, filename}; + }, + docsRootComponent: '@theme/DocsRoot', + docVersionRootComponent: '@theme/DocVersionRoot', + docRootComponent: '@theme/DocRoot', + docItemComponent: '@theme/DocItem', + remarkPlugins: [require('./my-remark-plugin')], + rehypePlugins: [], + beforeDefaultRemarkPlugins: [], + beforeDefaultRehypePlugins: [], + showLastUpdateAuthor: false, + showLastUpdateTime: false, + disableVersioning: false, + includeCurrentVersion: true, + lastVersion: undefined, + versions: { + current: { + label: 'Android SDK v2.0.0 (WIP)', + path: 'android-2.0.0', + banner: 'none', + }, + '1.0.0': { + label: 'Android SDK v1.0.0', + path: 'android-1.0.0', + banner: 'unmaintained', + }, + }, + onlyIncludeVersions: ['current', '1.0.0', '2.0.0'], +}; +``` + +## Markdown front matter {#markdown-front-matter} + +Markdown documents can use the following Markdown [front matter](../../guides/markdown-features/markdown-features-intro.mdx#front-matter) metadata fields, enclosed by a line `---` on either side. + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `id` | `string` | file path (including folders, without the extension) | A unique document ID. | +| `title` | `string` | Markdown title or `id` | The text title of your document. Used for the page metadata and as a fallback value in multiple places (sidebar, next/previous buttons...). Automatically added at the top of your doc if it does not contain any Markdown title. | +| `pagination_label` | `string` | `sidebar_label` or `title` | The text used in the document next/previous buttons for this document. | +| `sidebar_label` | `string` | `title` | The text shown in the document sidebar for this document. | +| `sidebar_position` | `number` | Default ordering | Controls the position of a doc inside the generated sidebar slice when using `autogenerated` sidebar items. See also [Autogenerated sidebar metadata](/docs/sidebar/autogenerated#autogenerated-sidebar-metadata). | +| `sidebar_class_name` | `string` | `undefined` | Gives the corresponding sidebar label a special class name when using autogenerated sidebars. | +| `sidebar_key` | `string` | `undefined` | Gives the corresponding sidebar item a key to uniquely identify the sidebar item. This is mostly useful for i18n sites to generate unique translation keys for categories sharing the same labels. An error will tell you when this extra metadata is needed. | +| `sidebar_custom_props` | `object` | `undefined` | Assign [custom props](../../guides/docs/sidebar/index.mdx#passing-custom-props) to the sidebar item referencing this doc | +| `displayed_sidebar` | `string` | `undefined` | Force the display of a given sidebar when browsing the current document. Read the [multiple sidebars guide](../../guides/docs/sidebar/multiple-sidebars.mdx) for details. | +| `hide_title` | `boolean` | `false` | Whether to hide the title at the top of the doc. It only hides a title declared through the front matter, and have no effect on a Markdown title at the top of your document. | +| `hide_table_of_contents` | `boolean` | `false` | Whether to hide the table of contents to the right. | +| `toc_min_heading_level` | `number` | `2` | The minimum heading level shown in the table of contents. Must be between 2 and 6 and lower or equal to the max value. | +| `toc_max_heading_level` | `number` | `3` | The max heading level shown in the table of contents. Must be between 2 and 6. | +| `pagination_next` | <code>string \| null</code> | Next doc in the sidebar | The ID of the documentation you want the "Next" pagination to link to. Use `null` to disable showing "Next" for this page. | +| `pagination_prev` | <code>string \| null</code> | Previous doc in the sidebar | The ID of the documentation you want the "Previous" pagination to link to. Use `null` to disable showing "Previous" for this page. | +| `parse_number_prefixes` | `boolean` | `numberPrefixParser` plugin option | Whether number prefix parsing is disabled on this doc. See also [Using number prefixes](/docs/sidebar/autogenerated#using-number-prefixes). | +| `custom_edit_url` | <code>string \| null</code> | Computed using the `editUrl` plugin option | The URL for editing this document. Use `null` to disable showing "Edit this page" for this page. | +| `keywords` | `string[]` | `undefined` | Keywords meta tag for the document page, for search engines. | +| `description` | `string` | The first line of Markdown content | The description of your document, which will become the `<meta name="description" content="..."/>` and `<meta property="og:description" content="..."/>` in `<head>`, used by search engines. | +| `image` | `string` | `undefined` | Cover or thumbnail image that will be used as the `<meta property="og:image" content="..."/>` in the `<head>`, enhancing link previews on social media and messaging platforms. | +| `slug` | `string` | File path | Allows to customize the document URL (`/<routeBasePath>/<slug>`). Support multiple patterns: `slug: my-doc`, `slug: /my/path/myDoc`, `slug: /`. | +| `tags` | `Tag[]` | `undefined` | A list of strings or objects of two string fields `label` and `permalink` to tag to your docs. Strings can be a reference to keys of a [tags file](#tags-file) (usually `tags.yml`) | +| `draft` | `boolean` | `false` | Draft documents will only be available during development. | +| `unlisted` | `boolean` | `false` | Unlisted documents will be available in both development and production. They will be "hidden" in production, not indexed, excluded from sitemaps, and can only be accessed by users having a direct link. | +| `last_update` | `FrontMatterLastUpdate` | `undefined` | Allows overriding the last update author/date. Date can be any [parsable date string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse). | + +```mdx-code-block +</APITable> +``` + +```ts +type FrontMatterLastUpdate = {date?: string; author?: string}; + +type Tag = string | {label: string; permalink: string}; +``` + +Example: + +```md +--- +id: doc-markdown +title: Docs Markdown Features +hide_title: false +hide_table_of_contents: false +sidebar_label: Markdown +sidebar_position: 3 +pagination_label: Markdown features +custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-markdown.md +description: How do I find you when I cannot solve this problem +keywords: + - docs + - docusaurus +tags: [docusaurus] +image: https://i.imgur.com/mErPwqL.png +slug: /myDoc +last_update: + date: 1/1/2000 + author: custom author name +--- + +# Markdown Features + +My Document Markdown content +``` + +import TagsFileApiRefSection from './_partial-tags-file-api-ref-section.mdx'; + +<TagsFileApiRefSection /> + +## i18n {#i18n} + +Read the [i18n introduction](../../i18n/i18n-introduction.mdx) first. + +### Translation files location {#translation-files-location} + +- **Base path**: `website/i18n/[locale]/docusaurus-plugin-content-docs` +- **Multi-instance path**: `website/i18n/[locale]/docusaurus-plugin-content-docs-[pluginId]` +- **JSON files**: extracted with [`docusaurus write-translations`](../../cli.mdx#docusaurus-write-translations-sitedir) +- **Markdown files**: `website/i18n/[locale]/docusaurus-plugin-content-docs/[versionName]` + +### Example file-system structure {#example-file-system-structure} + +```bash +website/i18n/[locale]/docusaurus-plugin-content-docs +│ +│ # translations for website/docs +├── current +│ ├── api +│ │ └── config.md +│ └── getting-started.md +├── current.json +│ +│ # translations for website/versioned_docs/version-1.0.0 +├── version-1.0.0 +│ ├── api +│ │ └── config.md +│ └── getting-started.md +└── version-1.0.0.json +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-content-pages.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-content-pages.mdx new file mode 100644 index 0000000000..b71ef05500 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-content-pages.mdx @@ -0,0 +1,160 @@ +--- +sidebar_position: 3 +slug: /api/plugins/@docusaurus/plugin-content-pages +--- + +# 📦 plugin-content-pages + +import APITable from '@site/src/components/APITable'; + +The default pages plugin for Docusaurus. The classic template ships with this plugin with default configurations. This plugin provides [creating pages](guides/creating-pages.mdx) functionality. + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-content-pages +``` + +:::tip + +If you use the preset `@docusaurus/preset-classic`, you don't need to install this plugin as a dependency. + +You can configure this plugin through the [preset options](../../using-plugins.mdx#docusauruspreset-classic). + +::: + +## Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `path` | `string` | `'src/pages'` | Path to data on filesystem relative to site dir. Components in this directory will be automatically converted to pages. | +| `editUrl` | <code>string \| [EditUrlFn](#EditUrlFn)</code> | `undefined` | **Only for Markdown pages**. Base URL to edit your site. The final URL is computed by `editUrl + relativePostPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | +| `editLocalizedFiles` | `boolean` | `false` | **Only for Markdown pages**. The edit URL will target the localized file, instead of the original unlocalized file. Ignored when `editUrl` is a function. | +| `routeBasePath` | `string` | `'/'` | URL route for the pages section of your site. **DO NOT** include a trailing slash. | +| `include` | `string[]` | `['**/*.{js,jsx,ts,tsx,md,mdx}']` | Matching files will be included and processed. | +| `exclude` | `string[]` | _See example configuration_ | No route will be created for matching files. | +| `mdxPageComponent` | `string` | `'@theme/MDXPage'` | Component used by each MDX page. | +| `remarkPlugins` | `[]` | `any[]` | Remark plugins passed to MDX. | +| `rehypePlugins` | `[]` | `any[]` | Rehype plugins passed to MDX. | +| `rehypePlugins` | `any[]` | `[]` | Recma plugins passed to MDX. | +| `beforeDefaultRemarkPlugins` | `any[]` | `[]` | Custom Remark plugins passed to MDX before the default Docusaurus Remark plugins. | +| `beforeDefaultRehypePlugins` | `any[]` | `[]` | Custom Rehype plugins passed to MDX before the default Docusaurus Rehype plugins. | +| `showLastUpdateAuthor` | `boolean` | `false` | **Only for Markdown pages**. Whether to display the author who last updated the page. | +| `showLastUpdateTime` | `boolean` | `false` | **Only for Markdown pages**. Whether to display the last date the page post was updated. This requires access to git history during the build, so will not work correctly with shallow clones (a common default for CI systems). With GitHub `actions/checkout`, use`fetch-depth: 0`. | + +```mdx-code-block +</APITable> +``` + +### Types {#types} + +#### `EditUrlFn` {#EditUrlFn} + +```ts +type EditUrlFunction = (params: { + blogDirPath: string; + blogPath: string; + permalink: string; + locale: string; +}) => string | undefined; +``` + +### Example configuration {#ex-config} + +You can configure this plugin through preset options or plugin options. + +:::tip + +Most Docusaurus users configure this plugin through the preset options. + +::: + +```js config-tabs +// Preset Options: pages +// Plugin Options: @docusaurus/plugin-content-pages + +const config = { + path: 'src/pages', + routeBasePath: '', + include: ['**/*.{js,jsx,ts,tsx,md,mdx}'], + exclude: [ + '**/_*.{js,jsx,ts,tsx,md,mdx}', + '**/_*/**', + '**/*.test.{js,jsx,ts,tsx}', + '**/__tests__/**', + ], + mdxPageComponent: '@theme/MDXPage', + remarkPlugins: [require('./my-remark-plugin')], + rehypePlugins: [], + beforeDefaultRemarkPlugins: [], + beforeDefaultRehypePlugins: [], +}; +``` + +## Markdown front matter {#markdown-front-matter} + +Markdown pages can use the following Markdown [front matter](../../guides/markdown-features/markdown-features-intro.mdx#front-matter) metadata fields, enclosed by a line `---` on either side. + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `title` | `string` | Markdown title | The blog post title. | +| `description` | `string` | The first line of Markdown content | The description of your page, which will become the `<meta name="description" content="..."/>` and `<meta property="og:description" content="..."/>` in `<head>`, used by search engines. | +| `keywords` | `string[]` | `undefined` | Keywords meta tag, which will become the `<meta name="keywords" content="keyword1,keyword2,..."/>` in `<head>`, used by search engines. | +| `image` | `string` | `undefined` | Cover or thumbnail image that will be used as the `<meta property="og:image" content="..."/>` in the `<head>`, enhancing link previews on social media and messaging platforms. | +| `slug` | `string` | File path | Allows to customize the page URL (`/<routeBasePath>/<slug>`). Support multiple patterns: `slug: my-page`, `slug: /my/page`, slug: `/`. | +| `wrapperClassName` | `string` | | Class name to be added to the wrapper element to allow targeting specific page content. | +| `hide_table_of_contents` | `boolean` | `false` | Whether to hide the table of contents to the right. | +| `draft` | `boolean` | `false` | Draft pages will only be available during development. | +| `unlisted` | `boolean` | `false` | Unlisted pages will be available in both development and production. They will be "hidden" in production, not indexed, excluded from sitemaps, and can only be accessed by users having a direct link. | + +```mdx-code-block +</APITable> +``` + +Example: + +```md +--- +title: Markdown Page +description: Markdown page SEO description +wrapperClassName: markdown-page +hide_table_of_contents: false +draft: true +slug: /markdown-page +--- + +Markdown page content +``` + +## i18n {#i18n} + +Read the [i18n introduction](../../i18n/i18n-introduction.mdx) first. + +### Translation files location {#translation-files-location} + +- **Base path**: `website/i18n/[locale]/docusaurus-plugin-content-pages` +- **Multi-instance path**: `website/i18n/[locale]/docusaurus-plugin-content-pages-[pluginId]` +- **JSON files**: extracted with [`docusaurus write-translations`](../../cli.mdx#docusaurus-write-translations-sitedir) +- **Markdown files**: `website/i18n/[locale]/docusaurus-plugin-content-pages` + +### Example file-system structure {#example-file-system-structure} + +```bash +website/i18n/[locale]/docusaurus-plugin-content-pages +│ +│ # translations for website/src/pages +├── first-markdown-page.md +└── second-markdown-page.md +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-css-cascade-layers.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-css-cascade-layers.mdx new file mode 100644 index 0000000000..a155a02260 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-css-cascade-layers.mdx @@ -0,0 +1,95 @@ +--- +sidebar_position: 9 +slug: /api/plugins/@docusaurus/plugin-css-cascade-layers +--- + +# 📦 plugin-css-cascade-layers + +import APITable from '@site/src/components/APITable'; + +:::caution Experimental + +This plugin is mostly designed to be used internally by the classic preset through the [Docusaurus `future.v4.useCssCascadeLayers` flag](../docusaurus.config.js.mdx#future), although it can also be used as a standalone plugin. Please [let us know here](https://github.com/facebook/docusaurus/pull/11142) if you have a use case for it and help us design an API that makes sense for the future of Docusaurus. + +::: + +A plugin for wrapping CSS modules of your Docusaurus site in [CSS Cascade Layers](https://css-tricks.com/css-cascade-layers/). This modern CSS feature is widely supported by all browsers. It allows grouping CSS rules in layers of specificity and gives you more control over the CSS cascade. + +Use this plugin to: + +- apply a top-level `@layer myLayer { ... }` block rule around any CSS module, including un-layered third-party CSS. +- define an explicit layer ordering + +:::caution + +To use this plugin properly, it's recommended to have a solid understanding of [CSS Cascade Layers](https://css-tricks.com/css-cascade-layers/), the [CSS Cascade](https://developer.mozilla.org/docs/Web/CSS/CSS_cascade/Cascade) and [specificity](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_cascade/Specificity). + +::: + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-css-cascade-layers +``` + +:::tip + +If you use the preset `@docusaurus/preset-classic`, this plugin is automatically configured for you with the [`siteConfig.future.v4.useCssCascadeLayers`](../docusaurus.config.js.mdx#future) flag. + +::: + +## Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `layers` | `Layers` | **Built-in layers** | An object representing all the CSS cascade layers you want to use, and whether the layer should be applied to a given file path. See examples and types below. | + +```mdx-code-block +</APITable> +``` + +### Types {#types} + +#### `Layers` {#EditUrlFunction} + +```ts +type Layers = Record< + string, // layer name + (filePath: string) => boolean // layer matcher +>; +``` + +The `layers` object is defined by: + +- key: the name of a layer +- value: a function to define if a given CSS module file should be in that layer + +:::caution Order matters + +The object order matters: + +- the keys order defines an explicit CSS layer order +- when multiple layers match a file path, only the first layer will apply + +::: + +### Example configuration {#ex-config} + +You can configure this plugin through plugin options. + +```js +const options = { + layers: { + 'docusaurus.infima': (filePath) => + filePath.includes('/node_modules/infima/dist'), + 'docusaurus.theme-classic': (filePath) => + filePath.includes('/node_modules/@docusaurus/theme-classic/lib'), + }, +}; +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-debug.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-debug.mdx new file mode 100644 index 0000000000..d764e61930 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-debug.mdx @@ -0,0 +1,108 @@ +--- +sidebar_position: 5 +slug: /api/plugins/@docusaurus/plugin-debug +--- + +# 📦 plugin-debug + +```mdx-code-block +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +``` + +The debug plugin will display useful debug information at [`http://localhost:3000/__docusaurus/debug`](http://localhost:3000/__docusaurus/debug). + +It is mostly useful for plugin authors, that will be able to inspect more easily the content of the `.docusaurus` folder (like the creates routes), but also be able to inspect data structures that are never written to disk, like the plugin data loaded through the `contentLoaded` lifecycle. + +:::info + +If you use the plugin via the classic preset, the preset will **enable the plugin in development and disable it in production** by default (`debug: undefined`) to avoid exposing potentially sensitive information. You can use `debug: true` to always enable it or `debug: false` to always disable it. + +If you use a standalone plugin, you may need to achieve the same effect by checking the environment: + +```js title="docusaurus.config.js" +export default { + plugins: [ + // highlight-next-line + process.env.NODE_ENV !== 'production' && '@docusaurus/plugin-debug', + ].filter(Boolean), +}; +``` + +::: + +:::note + +If you report a bug, we will probably ask you to have this plugin turned on in the production, so that we can inspect your deployment config more easily. + +If you don't have any sensitive information, you can keep it on in production [like we do](/__docusaurus/debug). + +::: + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-debug +``` + +:::tip + +If you use the preset `@docusaurus/preset-classic`, you don't need to install this plugin as a dependency. + +You can configure this plugin through the [preset options](../../using-plugins.mdx#docusauruspreset-classic). + +::: + +## Configuration {#configuration} + +This plugin currently has no options. + +### Example configuration {#ex-config} + +You can configure this plugin through preset options or plugin options. + +:::tip + +Most Docusaurus users configure this plugin through the preset options. + +::: + +```mdx-code-block +<Tabs groupId="api-config-ex"> +<TabItem value="preset" label="Preset options"> +``` + +If you use a preset, configure this plugin through the [preset options](../../using-plugins.mdx#docusauruspreset-classic): + +```js title="docusaurus.config.js" +export default { + presets: [ + [ + '@docusaurus/preset-classic', + { + // highlight-next-line + debug: true, // This will enable the plugin in production + }, + ], + ], +}; +``` + +```mdx-code-block +</TabItem> +<TabItem value="plugin" label="Plugin Options"> +``` + +If you are using a standalone plugin, provide options directly to the plugin: + +```js title="docusaurus.config.js" +export default { + // highlight-next-line + plugins: ['@docusaurus/plugin-debug'], +}; +``` + +```mdx-code-block +</TabItem> +</Tabs> +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-google-analytics.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-google-analytics.mdx new file mode 100644 index 0000000000..a914d122be --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-google-analytics.mdx @@ -0,0 +1,77 @@ +--- +sidebar_position: 6 +slug: /api/plugins/@docusaurus/plugin-google-analytics +--- + +# 📦 plugin-google-analytics + +import APITable from '@site/src/components/APITable'; + +The default [Google Analytics](https://developers.google.com/analytics/devguides/collection/analyticsjs/) plugin. It is a JavaScript library for measuring how users interact with your website **in the production build**. If you are using Google Analytics 4 you might need to consider using [plugin-google-gtag](./plugin-google-gtag.mdx) instead. + +:::danger Deprecated + +This plugin is **deprecated** and became useless on July 1, 2023. + +Google is [moving away from Universal Analytics](https://blog.google/products/marketingplatform/analytics/prepare-for-future-with-google-analytics-4/). + +If you are still using this plugin with a `UA-*` tracking id, you should create a Google Analytics 4 account as soon as possible, and use [`@docusaurus/plugin-google-gtag`](./plugin-google-gtag.mdx) instead of this plugin. More details [here](https://github.com/facebook/docusaurus/issues/7221). + +::: + +:::warning production only + +This plugin is always inactive in development and **only active in production** to avoid polluting the analytics statistics. + +::: + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-google-analytics +``` + +:::tip + +If you use the preset `@docusaurus/preset-classic`, you don't need to install this plugin as a dependency. + +You can configure this plugin through the [preset options](../../using-plugins.mdx#docusauruspreset-classic). + +::: + +## Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `trackingID` | `string` | **Required** | The tracking ID of your analytics service. | +| `anonymizeIP` | `boolean` | `false` | Whether the IP should be anonymized when sending requests. | + +```mdx-code-block +</APITable> +``` + +### Example configuration {#ex-config} + +You can configure this plugin through preset options or plugin options. + +:::tip + +Most Docusaurus users configure this plugin through the preset options. + +::: + +```js config-tabs +// Preset Options: googleAnalytics +// Plugin Options: @docusaurus/plugin-google-analytics + +const config = { + trackingID: 'UA-141789564-1', + anonymizeIP: true, +}; +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-google-gtag.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-google-gtag.mdx new file mode 100644 index 0000000000..ee30a0f3b8 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-google-gtag.mdx @@ -0,0 +1,73 @@ +--- +sidebar_position: 7 +slug: /api/plugins/@docusaurus/plugin-google-gtag +--- + +# 📦 plugin-google-gtag + +import APITable from '@site/src/components/APITable'; + +The default [Global Site Tag (gtag.js)](https://developers.google.com/tag-platform/gtagjs) plugin. It is a JavaScript tagging framework and API that allows you to send event data to Google Analytics, Google Ads, and Google Marketing Platform. This section describes how to configure a Docusaurus site to enable global site tag for Google Analytics. + +:::tip + +You can use [Google's Tag Assistant](https://tagassistant.google.com/) tool to check if your gtag is set up correctly! + +::: + +:::warning production only + +This plugin is always inactive in development and **only active in production** to avoid polluting the analytics statistics. + +::: + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-google-gtag +``` + +:::tip + +If you use the preset `@docusaurus/preset-classic`, you don't need to install this plugin as a dependency. + +You can configure this plugin through the [preset options](../../using-plugins.mdx#docusauruspreset-classic). + +::: + +## Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `trackingID` | <code>string \| string[]</code> | **Required** | The tracking ID of your gtag service. It is possible to provide multiple ids. | +| `anonymizeIP` | `boolean` | `false` | Whether the IP should be anonymized when sending requests. | + +```mdx-code-block +</APITable> +``` + +### Example configuration {#ex-config} + +You can configure this plugin through preset options or plugin options. + +:::tip + +Most Docusaurus users configure this plugin through the preset options. + +::: + +```js config-tabs +// Preset Options: gtag +// Plugin Options: @docusaurus/plugin-google-gtag + +const config = { + trackingID: 'G-999X9XX9XX', + anonymizeIP: true, +}; +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-google-tag-manager.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-google-tag-manager.mdx new file mode 100644 index 0000000000..e444a53877 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-google-tag-manager.mdx @@ -0,0 +1,71 @@ +--- +sidebar_position: 8 +slug: /api/plugins/@docusaurus/plugin-google-tag-manager +--- + +# 📦 plugin-google-tag-manager + +import APITable from '@site/src/components/APITable'; + +A plugin for adding [Google Tag Manager (gtm.js)](https://developers.google.com/tag-platform/tag-manager) to a Docusaurus site. Use this plugin in conjunction with the standard [gtag plugin](./plugin-google-gtag.mdx) for in-depth analysis of how users are using your site. + +:::tip + +You can use [Google's Tag Assistant](https://tagassistant.google.com/) tool to check if tag manager is set up correctly! + +::: + +:::warning production only + +This plugin is always inactive in development and **only active in production** to avoid polluting the analytics statistics. + +::: + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-google-tag-manager +``` + +:::tip + +If you use the preset `@docusaurus/preset-classic`, you don't need to install this plugin as a dependency. + +You can configure this plugin through the [preset options](../../using-plugins.mdx#docusauruspreset-classic). + +::: + +## Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `containerId` | `string` | **Required** | Your Tag Manager container Id (usually starts with `GTM-`). | + +```mdx-code-block +</APITable> +``` + +### Example configuration {#ex-config} + +You can configure this plugin through preset options or plugin options. + +:::tip + +Most Docusaurus users configure this plugin through the preset options. + +::: + +```js config-tabs +// Preset Options: googleTagManager +// Plugin Options: @docusaurus/plugin-google-tag-manager + +const config = { + containerId: 'GTM-12345', +}; +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-ideal-image.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-ideal-image.mdx new file mode 100644 index 0000000000..c6793466db --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-ideal-image.mdx @@ -0,0 +1,106 @@ +--- +sidebar_position: 8 +slug: /api/plugins/@docusaurus/plugin-ideal-image +--- + +# 📦 plugin-ideal-image + +import APITable from '@site/src/components/APITable'; + +Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder). + +:::info + +By default, the plugin is **inactive in development** so you could always view full-scale images. If you want to debug the ideal image behavior, you could set the [`disableInDev`](#disableInDev) option to `false`. + +::: + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-ideal-image +``` + +## Usage {#usage} + +This plugin supports the PNG and JPG formats only. + +```jsx +import Image from '@theme/IdealImage'; +import thumbnail from './path/to/img.png'; + +// your React code +<Image img={thumbnail} /> + +// or +<Image img={require('./path/to/img.png')} /> +``` + +:::warning + +This plugin registers a [Webpack loader](https://webpack.js.org/loaders/) that changes the type of imported/require images: + +- Before: `string` +- After: `{preSrc: string, src: import("@theme/IdealImage").SrcImage}` + +::: + +:::warning For pnpm users + +Starting with [pnpm 10](https://github.com/pnpm/pnpm/releases/tag/v10.0.0), running `pnpm install` won't run dependency install scripts by default. You'll need additional pnpm configuration ([issue](https://github.com/lovell/sharp/issues/4343)) for our `sharp` image resizing dependency to install correctly, such as: + +```json title="package.json" +{ + "pnpm": { + "onlyBuiltDependencies": ["fsevents"] + } +} +``` + +::: + +## Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Option | Type | Default | Description | +| --- | --- | --- | --- | +| `name` | `string` | `ideal-img/[name].[hash:hex:7].[width].[ext]` | Filename template for output files. | +| `sizes` | `number[]` | _original size_ | Specify all widths you want to use. If a specified size exceeds the original image's width, the latter will be used (i.e. images won't be scaled up). | +| `size` | `number` | _original size_ | Specify one width you want to use; if the specified size exceeds the original image's width, the latter will be used (i.e. images won't be scaled up) | +| `min` | `number` | | As an alternative to manually specifying `sizes`, you can specify `min`, `max` and `steps`, and the sizes will be generated for you. | +| `max` | `number` | | See `min` above | +| `steps` | `number` | `4` | Configure the number of images generated between `min` and `max` (inclusive) | +| `quality` | `number` | `85` | JPEG compression quality | +| `disableInDev` | `boolean` | `true` | You can test ideal image behavior in dev mode by setting this to `false`. **Tip**: use [network throttling](https://www.browserstack.com/guide/how-to-perform-network-throttling-in-chrome) in your browser to simulate slow networks. | + +```mdx-code-block +</APITable> +``` + +### Example configuration {#ex-config} + +Here's an example configuration: + +```js title="docusaurus.config.js" +export default { + plugins: [ + [ + '@docusaurus/plugin-ideal-image', + // highlight-start + { + quality: 70, + max: 1030, // max resized image's size. + min: 640, // min resized image's size. if original is lower, use that size. + steps: 2, // the max number of images generated between min and max (inclusive) + disableInDev: false, + }, + // highlight-end + ], + ], +}; +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-pwa.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-pwa.mdx new file mode 100644 index 0000000000..df16a0c864 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-pwa.mdx @@ -0,0 +1,303 @@ +--- +sidebar_position: 9 +slug: /api/plugins/@docusaurus/plugin-pwa +--- + +# 📦 plugin-pwa + +Docusaurus Plugin to add PWA support using [Workbox](https://developers.google.com/web/tools/workbox). This plugin generates a [Service Worker](https://developers.google.com/web/fundamentals/primers/service-workers) in production build only, and allows you to create fully PWA-compliant documentation site with offline and installation support. + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-pwa +``` + +## Configuration {#configuration} + +Create a [PWA manifest](https://web.dev/add-manifest/) at `./static/manifest.json`. + +Modify `docusaurus.config.js` with a minimal PWA config, like: + +```js title="docusaurus.config.js" +export default { + plugins: [ + [ + '@docusaurus/plugin-pwa', + { + debug: true, + offlineModeActivationStrategies: [ + 'appInstalled', + 'standalone', + 'queryString', + ], + pwaHead: [ + { + tagName: 'link', + rel: 'icon', + href: '/img/docusaurus.png', + }, + { + tagName: 'link', + rel: 'manifest', + href: '/manifest.json', // your PWA manifest + }, + { + tagName: 'meta', + name: 'theme-color', + content: 'rgb(37, 194, 160)', + }, + ], + }, + ], + ], +}; +``` + +## Progressive Web App {#progressive-web-app} + +Having a service worker installed is not enough to make your application a PWA. You'll need to at least include a [Web App Manifest](https://developer.mozilla.org/en-US/docs/Web/Manifest) and have the correct tags in `<head>` ([Options > pwaHead](#pwahead)). + +After deployment, you can use [Lighthouse](https://developers.google.com/web/tools/lighthouse) to run an audit on your site. + +For a more exhaustive list of what it takes for your site to be a PWA, refer to the [PWA Checklist](https://developers.google.com/web/progressive-web-apps/checklist) + +## App installation support {#app-installation-support} + +If your browser supports it, you should be able to install a Docusaurus site as an app. + +![A screen recording of the installation process. A button appears in the address bar of the browser, which displays a dialog asking "install this application?" when clicked. After clicking the "Install" button, a new application is opened in the operating system, opening to the Docusaurus homepage.](/img/pwa_install.gif) + +:::note + +App installation requires the HTTPS protocol and a valid manifest. + +::: + +## Offline mode (precaching) {#offline-mode-precaching} + +We enable users to browse a Docusaurus site offline, by using service-worker precaching. + +The [workbox-precaching](https://developers.google.com/web/tools/workbox/modules/workbox-precaching) page explains the idea: + +> One feature of service workers is the ability to save a set of files to the cache when the service worker is installing. This is often referred to as "precaching", since you are caching content ahead of the service worker being used. +> +> The main reason for doing this is that it gives developers control over the cache, meaning they can determine when and how long a file is cached as well as serve it to the browser without going to the network, meaning it can be used to create web apps that work offline. +> +> Workbox takes a lot of the heavy lifting out of precaching by simplifying the API and ensuring assets are downloaded efficiently. + +By default, offline mode is enabled when the site is installed as an app. See the `offlineModeActivationStrategies` option for details. + +After the site has been precached, the service worker will serve cached responses for later visits. When a new build is deployed along with a new service worker, the new one will begin installing and eventually move to a waiting state. During this waiting state, a reload popup will show and ask the user to reload the page for new content. Until the user either clears the application cache or clicks the `reload` button on the popup, the service worker will continue serving the old content. + +:::warning + +Offline mode / precaching requires downloading all the static assets of the site ahead of time, and can consume unnecessary bandwidth. It may not be a good idea to activate it for all kind of sites. + +::: + +## Options {#options} + +### `debug` {#debug} + +- Type: `boolean` +- Default: `false` + +Turn debug mode on: + +- Workbox logs +- Additional Docusaurus logs +- Unoptimized SW file output +- Source maps + +### `offlineModeActivationStrategies` {#offlinemodeactivationstrategies} + +- Type: `('appInstalled' | 'mobile' | 'saveData'| 'queryString' | 'always')[]` +- Default: `['appInstalled', 'queryString', 'standalone']` + +Strategies used to turn the offline mode on: + +- `appInstalled`: activates for users having installed the site as an app (not 100% reliable) +- `standalone`: activates for users running the app as standalone (often the case once a PWA is installed) +- `queryString`: activates if queryString contains `offlineMode=true` (convenient for PWA debugging) +- `mobile`: activates for mobile users (`width <= 996px`) +- `saveData`: activates for users with `navigator.connection.saveData === true` +- `always`: activates for all users + +:::warning + +Use this carefully: some users may not like to be forced to use the offline mode. + +::: + +:::danger + +It is not possible to detect if a page is rendered as a PWA in a reliable manner. + +The `appinstalled` event has been [removed from the specification](https://github.com/w3c/manifest/pull/836), and the [`navigator.getInstalledRelatedApps()`](https://web.dev/get-installed-related-apps/) API is only supported in recent Chrome versions and require `related_applications` declared in the manifest. + +The [`standalone` strategy](https://petelepage.com/blog/2019/07/is-my-pwa-installed/) is a nice fallback to activate the offline mode (at least when running the installed app). + +::: + +### `injectManifestConfig` {#injectmanifestconfig} + +[Workbox options](https://developer.chrome.com/docs/workbox/reference/workbox-build/#type-InjectManifestOptions) to pass to `workbox.injectManifest()`. This gives you control over which assets will be precached, and be available offline. + +- Type: `InjectManifestOptions` +- Default: `{}` + +```js title="docusaurus.config.js" +export default { + plugins: [ + [ + '@docusaurus/plugin-pwa', + { + injectManifestConfig: { + manifestTransforms: [ + //... + ], + modifyURLPrefix: { + //... + }, + // We already add regular static assets (HTML, images...) to be available offline + // You can add more files according to your needs + globPatterns: ['**/*.{pdf,docx,xlsx}'], + // ... + }, + }, + ], + ], +}; +``` + +### `pwaHead` {#pwahead} + +- Type: `({ tagName: string; [attributeName: string]: string })[]` +- Default: `[]` + +Array of objects containing `tagName` and key-value pairs for attributes to inject into the `<head>` tag. Technically you can inject any head tag through this, but it's ideally used for tags to make your site PWA compliant. Here's a list of tag to make your app fully compliant: + +```js +export default { + plugins: [ + [ + '@docusaurus/plugin-pwa', + { + pwaHead: [ + { + tagName: 'link', + rel: 'icon', + href: '/img/docusaurus.png', + }, + { + tagName: 'link', + rel: 'manifest', + href: '/manifest.json', + }, + { + tagName: 'meta', + name: 'theme-color', + content: 'rgb(37, 194, 160)', + }, + { + tagName: 'meta', + name: 'apple-mobile-web-app-capable', + content: 'yes', + }, + { + tagName: 'meta', + name: 'apple-mobile-web-app-status-bar-style', + content: '#000', + }, + { + tagName: 'link', + rel: 'apple-touch-icon', + href: '/img/docusaurus.png', + }, + { + tagName: 'link', + rel: 'mask-icon', + href: '/img/docusaurus.svg', + color: 'rgb(37, 194, 160)', + }, + { + tagName: 'meta', + name: 'msapplication-TileImage', + content: '/img/docusaurus.png', + }, + { + tagName: 'meta', + name: 'msapplication-TileColor', + content: '#000', + }, + ], + }, + ], + ], +}; +``` + +### `swCustom` {#swcustom} + +- Type: `string | undefined` +- Default: `undefined` + +Useful for additional Workbox rules. You can do whatever a service worker can do here, and use the full power of workbox libraries. The code is transpiled, so you can use modern ES6+ syntax here. + +For example, to cache files from external routes: + +```js +import {registerRoute} from 'workbox-routing'; +import {StaleWhileRevalidate} from 'workbox-strategies'; + +// default fn export receiving some useful params +export default function swCustom(params) { + const { + debug, // :boolean + offlineMode, // :boolean + } = params; + + // Cache responses from external resources + registerRoute((context) => { + return [ + /graph\.facebook\.com\/.*\/picture/, + /netlify\.com\/img/, + /avatars1\.githubusercontent/, + ].some((regex) => context.url.href.match(regex)); + }, new StaleWhileRevalidate()); +} +``` + +The module should have a `default` function export, and receives some params. + +### `swRegister` {#swregister} + +- Type: `string | false` +- Default: `'docusaurus-plugin-pwa/src/registerSW.js'` + +Adds an entry before the Docusaurus app so that registration can happen before the app runs. The default `registerSW.js` file is enough for simple registration. + +Passing `false` will disable registration entirely. + +## Manifest example {#manifest-example} + +The Docusaurus site manifest can serve as an inspiration: + +```mdx-code-block +import CodeBlock from '@theme/CodeBlock'; + +<CodeBlock className="language-json"> + {JSON.stringify(require('@site/static/manifest.json'),null,2)} +</CodeBlock> +``` + +## Customizing reload popup {#customizing-reload-popup} + +The `@theme/PwaReloadPopup` component is rendered when a new service worker is waiting to be installed, and we suggest a reload to the user. You can [swizzle](../../swizzling.mdx) this component and implement your own UI. It will receive an `onReload` callback as props, which should be called when the `reload` button is clicked. This will tell the service worker to install the waiting service worker and reload the page. + +The default theme includes an implementation for the reload popup and uses [Infima Alerts](https://infima.dev/docs/components/alert). + +![A screen recording of the reload process. An alert box shows in the bottom right of the window, saying "New content available". After clicking the "Refresh" button, the page's main heading changes from "Introduction" to "PWA :))".](/img/pwa_reload.gif) + +Your component can render `null`, but this is not recommended: users won't have a way to get up-to-date content. diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-rsdoctor.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-rsdoctor.mdx new file mode 100644 index 0000000000..100d714893 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-rsdoctor.mdx @@ -0,0 +1,57 @@ +--- +sidebar_position: 7 +slug: /api/plugins/@docusaurus/plugin-rsdoctor +--- + +# 📦 plugin-rsdoctor + +import APITable from '@site/src/components/APITable'; + +A [Rsdoctor](https://rsdoctor.dev/) plugin can help you troubleshoot the bundling phase of your Docusaurus site, supporting both Webpack and Rspack. + +:::tip + +Use it to figure out which plugin or loader is slowing down the bundler, and focus your efforts on optimizing the bottleneck. + +::: + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-rsdoctor +``` + +## Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `rsdoctorOptions` | `object` | `{}` | The [Rsdoctor bundler plugin options](https://rsdoctor.dev/config/options/options), forwarded as is | + +```mdx-code-block +</APITable> +``` + +### Example configuration {#ex-config} + +You can configure this plugin through plugin options. + +```js title="docusaurus.config.js" +export default { + plugins: [ + [ + 'rsdoctor', + { + rsdoctorOptions: { + mode: 'lite', + }, + }, + ], + ], +}; +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-sitemap.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-sitemap.mdx new file mode 100644 index 0000000000..75ca74ef8b --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-sitemap.mdx @@ -0,0 +1,110 @@ +--- +sidebar_position: 10 +slug: /api/plugins/@docusaurus/plugin-sitemap +--- + +# 📦 plugin-sitemap + +import APITable from '@site/src/components/APITable'; + +This plugin creates sitemaps for your site so that search engine crawlers can crawl your site more accurately. + +:::warning production only + +This plugin is always inactive in development and **only active in production** because it works on the build output. + +::: + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-sitemap +``` + +:::tip + +If you use the preset `@docusaurus/preset-classic`, you don't need to install this plugin as a dependency. + +You can configure this plugin through the [preset options](../../using-plugins.mdx#docusauruspreset-classic). + +::: + +## Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `lastmod` | `'date' \| 'datetime' \| null` | `null` | `date` is YYYY-MM-DD. `datetime` is a ISO 8601 datetime. `null` is disabled. See [sitemap docs](https://www.sitemaps.org/protocol.html#xmlTagDefinitions). | +| `changefreq` | `string \| null` | `'weekly'` | See [sitemap docs](https://www.sitemaps.org/protocol.html#xmlTagDefinitions) | +| `priority` | `number \| null` | `0.5` | See [sitemap docs](https://www.sitemaps.org/protocol.html#xmlTagDefinitions) | +| `ignorePatterns` | `string[]` | `[]` | A list of glob patterns; matching route paths will be filtered from the sitemap. Note that you may need to include the base URL in here. | +| `filename` | `string` | `sitemap.xml` | The path to the created sitemap file, relative to the output directory. Useful if you have two plugin instances outputting two files. | +| `createSitemapItems` | <code>[CreateSitemapItemsFn](#CreateSitemapItemsFn) \| undefined</code> | `undefined` | An optional function which can be used to transform and / or filter the items in the sitemap. | + +```mdx-code-block +</APITable> +``` + +### Types {#types} + +#### `CreateSitemapItemsFn` {#CreateSitemapItemsFn} + +```ts +type CreateSitemapItemsFn = (params: { + siteConfig: DocusaurusConfig; + routes: RouteConfig[]; + defaultCreateSitemapItems: CreateSitemapItemsFn; +}) => Promise<SitemapItem[]>; +``` + +:::info + +This plugin also respects some site config: + +- [`noIndex`](../docusaurus.config.js.mdx#noIndex): results in no sitemap generated +- [`trailingSlash`](../docusaurus.config.js.mdx#trailingSlash): determines if the URLs in the sitemap have trailing slashes + +::: + +:::note About `lastmod` + +The `lastmod` option will only output a sitemap `<lastmod>` tag if plugins provide [route metadata](../plugin-methods/lifecycle-apis.mdx#addRoute) attributes `sourceFilePath` and/or `lastUpdatedAt`. + +All the official content plugins provide the metadata for routes backed by a content file (Markdown, MDX or React page components), but it is possible third-party plugin authors do not provide this information, and the plugin will not be able to output a `<lastmod>` tag for their routes. + +::: + +### Example configuration {#ex-config} + +You can configure this plugin through preset options or plugin options. + +:::tip + +Most Docusaurus users configure this plugin through the preset options. + +::: + +```js config-tabs +// Preset Options: sitemap +// Plugin Options: @docusaurus/plugin-sitemap + +const config = { + lastmod: 'date', + changefreq: 'weekly', + priority: 0.5, + ignorePatterns: ['/tags/**'], + filename: 'sitemap.xml', + createSitemapItems: async (params) => { + const {defaultCreateSitemapItems, ...rest} = params; + const items = await defaultCreateSitemapItems(rest); + return items.filter((item) => !item.url.includes('/page/')); + }, +}; +``` + +You can find your sitemap at `/sitemap.xml`. diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-svgr.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-svgr.mdx new file mode 100644 index 0000000000..bd5bef1eab --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-svgr.mdx @@ -0,0 +1,55 @@ +--- +sidebar_position: 7 +slug: /api/plugins/@docusaurus/plugin-svgr +--- + +# 📦 plugin-svgr + +import APITable from '@site/src/components/APITable'; + +An [SVGR](https://react-svgr.com/) plugin to transform SVG files into React components automatically at build time. + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-svgr +``` + +:::tip + +If you use the preset `@docusaurus/preset-classic`, you don't need to install this plugin as a dependency. + +You can configure this plugin through the [preset options](../../using-plugins.mdx#docusauruspreset-classic). + +::: + +## Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `svgrConfig` | `object` | `{}` | The [SVGR config options](https://react-svgr.com/docs/options/), forwarded as is | + +```mdx-code-block +</APITable> +``` + +### Example configuration {#ex-config} + +You can configure this plugin through plugin options. + +```js config-tabs +// Preset Options: svgr +// Plugin Options: @docusaurus/plugin-svgr + +const config = { + svgrConfig: { + /* SVGR config */ + }, +}; +``` diff --git a/website/versioned_docs/version-3.9.2/api/plugins/plugin-vercel-analytics.mdx b/website/versioned_docs/version-3.9.2/api/plugins/plugin-vercel-analytics.mdx new file mode 100644 index 0000000000..4c1e966843 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/plugins/plugin-vercel-analytics.mdx @@ -0,0 +1,57 @@ +--- +sidebar_position: 11 +slug: /api/plugins/@docusaurus/plugin-vercel-analytics +--- + +# 📦 plugin-vercel-analytics + +import APITable from '@site/src/components/APITable'; + +[Vercel Analytics](https://vercel.com/docs/analytics) provides comprehensive insights into your website's visitors, tracking top pages, referrers, and demographics like location, operating systems, and browser info. + +:::warning production only + +This plugin is always inactive in development and **only active in production** (`docusaurus build`) to avoid polluting the analytics statistics. + +::: + +## Installation {#installation} + +```bash npm2yarn +npm install --save @docusaurus/plugin-vercel-analytics +``` + +## Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `mode` | `string` | `'auto'` | Override the automatic environment detection. Read the [official docs](https://vercel.com/docs/analytics/package#mode) for details. | +| `debug` | `boolean` | `undefined` | Enable browser console logging of analytics events. Read the [official docs](https://vercel.com/docs/analytics/package#debug) for details. | + +```mdx-code-block +</APITable> +``` + +### Example configuration {#ex-config} + +You can configure this plugin through plugin options. + +```js title="docusaurus.config.js" +export default { + plugins: [ + [ + 'vercel-analytics', + { + debug: true, + mode: 'auto', + }, + ], + ], +}; +``` diff --git a/website/versioned_docs/version-3.9.2/api/themes/_category_.yml b/website/versioned_docs/version-3.9.2/api/themes/_category_.yml new file mode 100644 index 0000000000..a0ceda5d59 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/themes/_category_.yml @@ -0,0 +1,5 @@ +label: Themes +position: 3 +link: + type: doc + id: themes-overview # Dogfood using a "local id" diff --git a/website/versioned_docs/version-3.9.2/api/themes/overview.mdx b/website/versioned_docs/version-3.9.2/api/themes/overview.mdx new file mode 100644 index 0000000000..98084d7418 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/themes/overview.mdx @@ -0,0 +1,34 @@ +--- +sidebar_position: 0 +id: themes-overview +sidebar_label: Themes overview +slug: /api/themes +--- + +# Docusaurus themes + +We provide official Docusaurus themes. + +## Main themes {#main-themes} + +The main themes implement the user interface for the [docs](../plugins/plugin-content-docs.mdx), [blog](../plugins/plugin-content-blog.mdx) and [pages](../plugins/plugin-content-pages.mdx) plugins. + +- [@docusaurus/theme-classic](./theme-classic.mdx) +- 🚧 other themes are planned + +:::warning + +The goal is to have all themes share the exact same features, user-experience and configuration. + +Only the UI design and underlying styling framework should change, and you should be able to change theme easily. + +We are not there yet: only the classic theme is production ready. + +::: + +## Enhancement themes {#enhancement-themes} + +These themes will enhance the existing main themes with additional user-interface related features. + +- [@docusaurus/theme-live-codeblock](./theme-live-codeblock.mdx) +- [@docusaurus/theme-search-algolia](./theme-search-algolia.mdx) diff --git a/website/versioned_docs/version-3.9.2/api/themes/theme-classic.mdx b/website/versioned_docs/version-3.9.2/api/themes/theme-classic.mdx new file mode 100644 index 0000000000..5073013923 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/themes/theme-classic.mdx @@ -0,0 +1,63 @@ +--- +sidebar_position: 2 +slug: /api/themes/@docusaurus/theme-classic +--- + +# 📦 theme-classic + +import APITable from '@site/src/components/APITable'; + +The classic theme for Docusaurus. + +You can refer to the [theme configuration page](theme-configuration.mdx) for more details on the configuration. + +```bash npm2yarn +npm install --save @docusaurus/theme-classic +``` + +:::tip + +If you have installed `@docusaurus/preset-classic`, you don't need to install it as a dependency. + +::: + +## Configuration {#configuration} + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Option | Type | Default | Description | +| --- | --- | --- | --- | +| `customCss` | <code>string[] \| string</code> | `[]` | Stylesheets to be imported globally as [client modules](../../advanced/client.mdx#client-modules). Relative paths are resolved against the site directory. | + +```mdx-code-block +</APITable> +``` + +:::note + +Most configuration for the theme is done in `themeConfig`, which can be found in [theme configuration](./theme-configuration.mdx). + +::: + +### Example configuration {#ex-config} + +You can configure this theme through preset options or plugin options. + +:::tip + +Most Docusaurus users configure this plugin through the preset options. + +::: + +```js config-tabs +// Preset Options: theme +// Plugin Options: @docusaurus/theme-classic + +const config = { + customCss: './src/css/custom.css', +}; +``` diff --git a/website/versioned_docs/version-3.9.2/api/themes/theme-configuration.mdx b/website/versioned_docs/version-3.9.2/api/themes/theme-configuration.mdx new file mode 100644 index 0000000000..cca32b058d --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/themes/theme-configuration.mdx @@ -0,0 +1,1239 @@ +--- +sidebar_position: 1 +sidebar_label: Configuration +slug: /api/themes/configuration +toc_max_heading_level: 4 +--- + +# Theme configuration + +import APITable from '@site/src/components/APITable'; + +This configuration applies to all [main themes](./overview.mdx). + +## Common {#common} + +### Color mode {#color-mode---dark-mode} + +The classic theme provides by default light and dark mode support, with a navbar switch for the user. + +It is possible to customize the color mode support within the `colorMode` object. + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `defaultMode` | <code>'light' \| 'dark'</code> | `'light'` | The color mode when user first visits the site. | +| `disableSwitch` | `boolean` | `false` | Hides the switch in the navbar. Useful if you want to support a single color mode. | +| `respectPrefersColorScheme` | `boolean` | `false` | Whether to use the `prefers-color-scheme` media-query, using user system preferences, instead of the hardcoded `defaultMode`. | + +```mdx-code-block +</APITable> +``` + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + // highlight-start + colorMode: { + defaultMode: 'light', + disableSwitch: false, + respectPrefersColorScheme: false, + }, + // highlight-end + }, +}; +``` + +:::warning + +With `respectPrefersColorScheme: true`, the `defaultMode` is overridden by user system preferences. + +If you only want to support one color mode, you likely want to ignore user system preferences. + +::: + +### Meta image {#meta-image} + +You can configure a default image that will be used for your meta tag, in particular `og:image` and `twitter:image`. + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `image` | `string` | `undefined` | The meta image URL for the site. Relative to your site's "static" directory. Cannot be SVGs. Can be external URLs too. | + +```mdx-code-block +</APITable> +``` + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + // highlight-next-line + image: 'img/docusaurus.png', + }, +}; +``` + +### Metadata {#metadata} + +You can configure additional HTML metadata (and override existing ones). + +Accepted fields: + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `metadata` | `Metadata[]` | `[]` | Any field will be directly passed to the `<meta />` tag. Possible fields include `id`, `name`, `property`, `content`, `itemprop`, etc. | + +```mdx-code-block +</APITable> +``` + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + // highlight-next-line + metadata: [{name: 'twitter:card', content: 'summary'}], + }, +}; +``` + +### Announcement bar {#announcement-bar} + +Sometimes you want to announce something in your website. Just for such a case, you can add an announcement bar. This is a non-fixed and optionally dismissible panel above the navbar. All configuration are in the `announcementBar` object. + +Accepted fields: + +```mdx-code-block +<APITable name="announcement-bar"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `id` | `string` | `'announcement-bar'` | Any value that will identify this message. | +| `content` | `string` | `''` | The text content of the announcement. HTML will be interpolated. | +| `backgroundColor` | `string` | `'#fff'` | Background color of the entire bar. | +| `textColor` | `string` | `'#000'` | Announcement text color. | +| `isCloseable` | `boolean` | `true` | Whether this announcement can be dismissed with a '×' button. | + +```mdx-code-block +</APITable> +``` + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + // highlight-start + announcementBar: { + id: 'support_us', + content: + 'We are looking to revamp our docs, please fill <a target="_blank" rel="noopener noreferrer" href="#">this survey</a>', + backgroundColor: '#fafbfc', + textColor: '#091E42', + isCloseable: false, + }, + // highlight-end + }, +}; +``` + +## Plugins + +Our [main themes](./overview.mdx) offer additional theme configuration options for Docusaurus core content plugins. + +### Docs + +```mdx-code-block +<APITable name="navbar-overview"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `versionPersistence` | `'localStorage' \| 'none'` | `undefined` | Defines the browser persistence of the preferred docs version. | +| `sidebar.hideable` | `boolean` | `false` | Show a hide button at the bottom of the sidebar. | +| `sidebar.autoCollapseCategories` | `boolean` | `false` | Automatically collapse all sibling categories of the one you navigate to. | + +```mdx-code-block +</APITable> +``` + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + docs: { + // highlight-start + versionPersistence: 'localStorage', + sidebar: { + hideable: false, + autoCollapseCategories: false, + }, + // highlight-end + }, + }, +}; +``` + +### Blog + +```mdx-code-block +<APITable name="navbar-overview"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `sidebar.groupByYear` | `boolean` | `true` | Group sidebar blog posts by years. | + +```mdx-code-block +</APITable> +``` + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + blog: { + // highlight-start + sidebar: { + groupByYear: true, + }, + // highlight-end + }, + }, +}; +``` + +## Navbar {#navbar} + +Accepted fields: + +```mdx-code-block +<APITable name="navbar-overview"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `title` | `string` | `undefined` | Title for the navbar. | +| `logo` | _See below_ | `undefined` | Customization of the logo object. | +| `items` | `NavbarItem[]` | `[]` | A list of navbar items. See specification below. | +| `hideOnScroll` | `boolean` | `false` | Whether the navbar is hidden when the user scrolls down. | +| `style` | <code>'primary' \| 'dark'</code> | Same as theme | Sets the navbar style, ignoring the dark/light theme. | + +```mdx-code-block +</APITable> +``` + +### Navbar logo {#navbar-logo} + +The logo can be placed in [static folder](static-assets.mdx). Logo URL is set to base URL of your site by default. Although you can specify your own URL for the logo, if it is an external link, it will open in a new tab. In addition, you can override a value for the target attribute of logo link, it can come in handy if you are hosting docs website in a subdirectory of your main website, and in which case you probably do not need a link in the logo to the main website will open in a new tab. + +To improve dark mode support, you can also set a different logo for this mode. + +Accepted fields: + +```mdx-code-block +<APITable name="navbar-logo"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `alt` | `string` | `undefined` | Alt tag for the logo image. | +| `src` | `string` | **Required** | URL to the logo image. Base URL is appended by default. | +| `srcDark` | `string` | `logo.src` | An alternative image URL to use in dark mode. | +| `href` | `string` | `siteConfig.baseUrl` | Link to navigate to when the logo is clicked. | +| `width` | <code>string \| number</code> | `undefined` | Specifies the `width` attribute. | +| `height` | <code>string \| number</code> | `undefined` | Specifies the `height` attribute. | +| `target` | `string` | Calculated based on `href` (external links will open in a new tab, all others in the current one). | The `target` attribute of the link; controls whether the link is opened in a new tab, the current one, or otherwise. | +| `className` | `string` | `undefined` | CSS class applied to the image. | +| `style` | `object` | `undefined` | CSS inline style object. React/JSX flavor, using camelCase properties. | + +```mdx-code-block +</APITable> +``` + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + title: 'Site Title', + // highlight-start + logo: { + alt: 'Site Logo', + src: 'img/logo.svg', + srcDark: 'img/logo_dark.svg', + href: 'https://docusaurus.io/', + target: '_self', + width: 32, + height: 32, + className: 'custom-navbar-logo-class', + style: {border: 'solid red'}, + }, + // highlight-end + }, + }, +}; +``` + +### Navbar items {#navbar-items} + +You can add items to the navbar via `themeConfig.navbar.items`. + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + // highlight-start + items: [ + { + type: 'doc', + position: 'left', + docId: 'introduction', + label: 'Docs', + }, + {to: 'blog', label: 'Blog', position: 'left'}, + { + type: 'docsVersionDropdown', + position: 'right', + }, + { + type: 'localeDropdown', + position: 'right', + }, + { + href: 'https://github.com/facebook/docusaurus', + position: 'right', + className: 'header-github-link', + 'aria-label': 'GitHub repository', + }, + ], + // highlight-end + }, + }, +}; +``` + +The items can have different behaviors based on the `type` field. The sections below will introduce you to all the types of navbar items available. + +#### Navbar link {#navbar-link} + +By default, Navbar items are regular links (internal or external). + +React Router should automatically apply active link styling to links, but you can use `activeBasePath` in edge cases. For cases in which a link should be active on several different paths (such as when you have multiple doc folders under the same sidebar), you can use `activeBaseRegex`. `activeBaseRegex` is a more flexible alternative to `activeBasePath` and takes precedence over it -- Docusaurus parses it into a regular expression that is tested against the current URL. + +Outbound (external) links automatically get `target="_blank" rel="noopener noreferrer"` attributes. + +Accepted fields: + +```mdx-code-block +<APITable name="navbar-link"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `type` | `'default'` | Optional | Sets the type of this item to a link. | +| `label` | `string` | **Required** | The name to be shown for this item. | +| `html` | `string` | Optional | Same as `label`, but renders pure HTML instead of text content. | +| `to` | `string` | **Required** | Client-side routing, used for navigating within the website. The baseUrl will be automatically prepended to this value. | +| `href` | `string` | **Required** | A full-page navigation, used for navigating outside of the website. **Only one of `to` or `href` should be used.** | +| `prependBaseUrlToHref` | `boolean` | `false` | Prepends the baseUrl to `href` values. | +| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. | +| `activeBasePath` | `string` | `to` / `href` | To apply the active class styling on all routes starting with this path. This usually isn't necessary. | +| `activeBaseRegex` | `string` | `undefined` | Alternative to `activeBasePath` if required. | +| `className` | `string` | `''` | Custom CSS class (for styling any item). | + +```mdx-code-block +</APITable> +``` + +:::note + +In addition to the fields above, you can specify other arbitrary attributes that can be applied to a HTML link. + +::: + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + items: [ + // highlight-start + { + to: 'docs/introduction', + // Only one of "to" or "href" should be used + // href: 'https://www.facebook.com', + label: 'Introduction', + // Only one of "label" or "html" should be used + // html: '<b>Introduction</b>' + position: 'left', + activeBaseRegex: 'docs/(next|v8)', + target: '_blank', + }, + // highlight-end + ], + }, + }, +}; +``` + +#### Navbar dropdown {#navbar-dropdown} + +Navbar items of the type `dropdown` has the additional `items` field, an inner array of navbar items. + +Navbar dropdown items only accept the following **"link-like" item types**: + +- [Navbar link](#navbar-link) +- [Navbar doc link](#navbar-doc-link) +- [Navbar docs version](#navbar-docs-version) +- [Navbar doc sidebar](#navbar-doc-sidebar) +- [Navbar with custom HTML](#navbar-with-custom-html) + +Note that the dropdown base item is a clickable link as well, so this item can receive any of the props of a [plain navbar link](#navbar-link). + +Accepted fields: + +```mdx-code-block +<APITable name="navbar-dropdown"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `type` | `'dropdown'` | Optional | Sets the type of this item to a dropdown. | +| `label` | `string` | **Required** | The name to be shown for this item. | +| `items` | <code>[LinkLikeItem](#navbar-dropdown)[]</code> | **Required** | The items to be contained in the dropdown. | +| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. | + +```mdx-code-block +</APITable> +``` + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + items: [ + // highlight-start + { + type: 'dropdown', + label: 'Community', + position: 'left', + items: [ + { + label: 'Facebook', + href: 'https://www.facebook.com', + }, + { + type: 'doc', + label: 'Social', + docId: 'social', + }, + // ... more items + ], + }, + // highlight-end + ], + }, + }, +}; +``` + +#### Navbar doc link {#navbar-doc-link} + +If you want to link to a specific doc, this special navbar item type will render the link to the doc of the provided `docId`. It will get the class `navbar__link--active` as long as you browse a doc of the same sidebar. + +Accepted fields: + +```mdx-code-block +<APITable name="navbar-doc-link"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `type` | `'doc'` | **Required** | Sets the type of this item to a doc link. | +| `docId` | `string` | **Required** | The ID of the doc that this item links to. | +| `label` | `string` | `docId` | The name to be shown for this item. | +| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. | +| `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc belongs to. | + +```mdx-code-block +</APITable> +``` + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + items: [ + // highlight-start + { + type: 'doc', + position: 'left', + docId: 'introduction', + label: 'Docs', + }, + // highlight-end + ], + }, + }, +}; +``` + +#### Navbar linked to a sidebar {#navbar-doc-sidebar} + +You can link a navbar item to the first document link (which can be a doc link or a generated category index) of a given sidebar without having to hardcode a doc ID. + +Accepted fields: + +```mdx-code-block +<APITable name="navbar-doc-sidebar"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `type` | `'docSidebar'` | **Required** | Sets the type of this navbar item to a sidebar's first document. | +| `sidebarId` | `string` | **Required** | The ID of the sidebar that this item is linked to. | +| `label` | `string` | First document link's sidebar label | The name to be shown for this item. | +| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. | +| `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the sidebar belongs to. | + +```mdx-code-block +</APITable> +``` + +:::tip + +Use this navbar item type if your sidebar is updated often and the order is not stable. + +::: + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + items: [ + // highlight-start + { + type: 'docSidebar', + position: 'left', + sidebarId: 'api', + label: 'API', + }, + // highlight-end + ], + }, + }, +}; +``` + +```js title="sidebars.js" +export default { + tutorial: [ + { + type: 'autogenerated', + dirName: 'guides', + }, + ], + api: [ + // highlight-next-line + 'cli', // The navbar item will be linking to this doc + 'docusaurus-core', + { + type: 'autogenerated', + dirName: 'api', + }, + ], +}; +``` + +#### Navbar docs version dropdown {#navbar-docs-version-dropdown} + +If you use docs with versioning, this special navbar item type that will render a dropdown with all your site's available versions. + +The user will be able to switch from one version to another, while staying on the same doc (as long as the doc ID is constant across versions). + +Accepted fields: + +```mdx-code-block +<APITable name="navbar-docs-version-dropdown"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `type` | `'docsVersionDropdown'` | **Required** | Sets the type of this item to a docs version dropdown. | +| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. | +| `dropdownItemsBefore` | <code>[LinkLikeItem](#navbar-dropdown)[]</code> | `[]` | Add additional dropdown items at the beginning of the dropdown. | +| `dropdownItemsAfter` | <code>[LinkLikeItem](#navbar-dropdown)[]</code> | `[]` | Add additional dropdown items at the end of the dropdown. | +| `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc versioning belongs to. | +| `dropdownActiveClassDisabled` | `boolean` | `false` | Do not add the link active class when browsing docs. | +| `versions` | `DropdownVersions` | `undefined` | Specify a custom list of versions to include in the dropdown. See [the versioning guide](../../guides/docs/versioning.mdx#docsVersionDropdown) for details. | + +```mdx-code-block +</APITable> +``` + +Types: + +```ts +type DropdownVersion = { + /** Allows you to provide a custom display label for each version. */ + label?: string; +}; + +type DropdownVersions = string[] | {[versionName: string]: DropdownVersion}; +``` + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + items: [ + // highlight-start + { + type: 'docsVersionDropdown', + position: 'left', + dropdownItemsAfter: [{to: '/versions', label: 'All versions'}], + dropdownActiveClassDisabled: true, + }, + // highlight-end + ], + }, + }, +}; +``` + +#### Navbar docs version {#navbar-docs-version} + +If you use docs with versioning, this special navbar item type will link to the active/browsed version of your doc (depends on the current URL), and fallback to the latest version. + +Accepted fields: + +```mdx-code-block +<APITable name="navbar-docs-version"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `type` | `'docsVersion'` | **Required** | Sets the type of this item to a doc version link. | +| `label` | `string` | The active/latest version label. | The name to be shown for this item. | +| `to` | `string` | The active/latest version. | The internal link that this item points to. | +| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. | +| `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc versioning belongs to. | + +```mdx-code-block +</APITable> +``` + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + items: [ + // highlight-start + { + type: 'docsVersion', + position: 'left', + to: '/path', + label: 'label', + }, + // highlight-end + ], + }, + }, +}; +``` + +#### Navbar locale dropdown {#navbar-locale-dropdown} + +If you use the [i18n feature](../../i18n/i18n-introduction.mdx), this special navbar item type will render a dropdown with all your site's available locales. + +The user will be able to switch from one locale to another, while staying on the same page. + +Accepted fields: + +```mdx-code-block +<APITable name="navbar-locale-dropdown"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `type` | `'localeDropdown'` | **Required** | Sets the type of this item to a locale dropdown. | +| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. | +| `dropdownItemsBefore` | <code>[LinkLikeItem](#navbar-dropdown)[]</code> | `[]` | Add additional dropdown items at the beginning of the dropdown. | +| `dropdownItemsAfter` | <code>[LinkLikeItem](#navbar-dropdown)[]</code> | `[]` | Add additional dropdown items at the end of the dropdown. | +| `queryString` | `string` | `undefined` | The query string to be appended to the URL. | + +```mdx-code-block +</APITable> +``` + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + items: [ + // highlight-start + { + type: 'localeDropdown', + position: 'left', + dropdownItemsAfter: [ + { + to: 'https://my-site.com/help-us-translate', + label: 'Help us translate', + }, + ], + }, + // highlight-end + ], + }, + }, +}; +``` + +#### Navbar search {#navbar-search} + +If you use the [search](../../search.mdx), the search bar will be the rightmost element in the navbar. + +However, with this special navbar item type, you can change the default location. + +```mdx-code-block +<APITable name="navbar-search"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `type` | `'search'` | **Required** | Sets the type of this item to a search bar. | +| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. | +| `className` | `string` | / | Custom CSS class for this navbar item. | + +```mdx-code-block +</APITable> +``` + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + items: [ + // highlight-start + { + type: 'search', + position: 'right', + }, + // highlight-end + ], + }, + }, +}; +``` + +#### Navbar with custom HTML {#navbar-with-custom-html} + +You can also render your own HTML markup inside a navbar item using this navbar item type. + +```mdx-code-block +<APITable name="navbar-html"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `type` | `'html'` | **Required** | Sets the type of this item to a HTML element. | +| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. | +| `className` | `string` | `''` | Custom CSS class for this navbar item. | +| `value` | `string` | `''` | Custom HTML to be rendered inside this navbar item. | + +```mdx-code-block +</APITable> +``` + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + items: [ + // highlight-start + { + type: 'html', + position: 'right', + value: '<button>Give feedback</button>', + }, + // highlight-end + ], + }, + }, +}; +``` + +### Auto-hide sticky navbar {#auto-hide-sticky-navbar} + +You can enable this cool UI feature that automatically hides the navbar when a user starts scrolling down the page, and show it again when the user scrolls up. + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + // highlight-next-line + hideOnScroll: true, + }, + }, +}; +``` + +### Navbar style {#navbar-style} + +You can set the static Navbar style without disabling the theme switching ability. The selected style will always apply no matter which theme user have selected. + +Currently, there are two possible style options: `dark` and `primary` (based on the `--ifm-color-primary` color). You can see the styles preview in the [Infima documentation](https://infima.dev/docs/components/navbar/). + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + // highlight-next-line + style: 'primary', + }, + }, +}; +``` + +## CodeBlock {#codeblock} + +Docusaurus uses [Prism React Renderer](https://github.com/FormidableLabs/prism-react-renderer) to highlight code blocks. All configuration are in the `prism` object. + +Accepted fields: + +```mdx-code-block +<APITable name="codeblock"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `theme` | `PrismTheme` | `palenight` | The Prism theme to use for light-theme code blocks. | +| `darkTheme` | `PrismTheme` | `palenight` | The Prism theme to use for dark-theme code blocks. | +| `defaultLanguage` | `string` | `undefined` | The default language to use for code blocks not declaring any explicit language. | +| `magicComments` | `MagicCommentConfig[]` | _see below_ | The list of [magic comments](../../guides/markdown-features/markdown-features-code-blocks.mdx#custom-magic-comments). | + +```mdx-code-block +</APITable> +``` + +```ts +type MagicCommentConfig = { + className: string; + line?: string; + block?: {start: string; end: string}; +}; +``` + +```js +const defaultMagicComments = [ + { + className: 'theme-code-block-highlighted-line', + line: 'highlight-next-line', + block: {start: 'highlight-start', end: 'highlight-end'}, + }, +]; +``` + +### Theme {#theme} + +By default, we use [Palenight](https://github.com/FormidableLabs/prism-react-renderer/blob/master/packages/prism-react-renderer/src/themes/palenight.ts) as syntax highlighting theme. You can specify a custom theme from the [list of available themes](https://github.com/FormidableLabs/prism-react-renderer/tree/master/packages/prism-react-renderer/src/themes). You may also use a different syntax highlighting theme when the site is in dark mode. + +Example configuration: + +```js title="docusaurus.config.js" +import {themes as prismThemes} from 'prism-react-renderer'; + +export default { + themeConfig: { + prism: { + // highlight-start + theme: prismThemes.github, + darkTheme: prismThemes.dracula, + // highlight-end + }, + }, +}; +``` + +:::note + +If you use the line highlighting Markdown syntax, you might need to specify a different highlight background color for the dark mode syntax highlighting theme. Refer to the [docs for guidance](../../guides/markdown-features/markdown-features-code-blocks.mdx#line-highlighting). + +::: + +### Default language {#default-language} + +You can set a default language for code blocks if no language is added after the opening triple backticks (i.e. ```). Note that a valid [language name](https://prismjs.com/#supported-languages) must be passed. + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + prism: { + // highlight-next-line + defaultLanguage: 'javascript', + }, + }, +}; +``` + +## Footer {#footer-1} + +You can add logo and a copyright to the footer via `themeConfig.footer`. Logo can be placed in [static folder](static-assets.mdx). Logo URL works in the same way of the navbar logo. + +Accepted fields: + +```mdx-code-block +<APITable name="footer"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `logo` | `Logo` | `undefined` | Customization of the logo object. See [Navbar logo](#navbar-logo) for details. | +| `copyright` | `string` | `undefined` | The copyright message to be displayed at the bottom, also supports custom HTML. | +| `style` | <code>'dark' \| 'light'</code> | `'light'` | The color theme of the footer component. | +| `links` | <code>(Column \| FooterLink)[]</code> | `[]` | The link groups to be present. | + +```mdx-code-block +</APITable> +``` + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + // highlight-start + footer: { + logo: { + alt: 'Meta Open Source Logo', + src: 'img/meta_oss_logo.png', + href: 'https://opensource.fb.com', + width: 160, + height: 51, + }, + copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`, + }, + // highlight-end + }, +}; +``` + +### Footer Links {#footer-links} + +You can add links to the footer via `themeConfig.footer.links`. There are two types of footer configurations: **multi-column footers** and **simple footers**. + +Multi-column footer links have a `title` and a list of `FooterItem`s for each column. + +```mdx-code-block +<APITable name="footer-links"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `title` | `string` | `undefined` | Label of the section of these links. | +| `items` | `FooterItem[]` | `[]` | Links in this section. | + +```mdx-code-block +</APITable> +``` + +Accepted fields of each `FooterItem`: + +```mdx-code-block +<APITable name="footer-items"> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `label` | `string` | **Required** | Text to be displayed for this link. | +| `to` | `string` | **Required** | Client-side routing, used for navigating within the website. The baseUrl will be automatically prepended to this value. | +| `href` | `string` | **Required** | A full-page navigation, used for navigating outside of the website. **Only one of `to` or `href` should be used.** | +| `html` | `string` | `undefined` | Renders the HTML pass-through instead of a simple link. In case `html` is used, no other options should be provided. | + +```mdx-code-block +</APITable> +``` + +Example multi-column configuration: + +```js title="docusaurus.config.js" +export default { + footer: { + // highlight-start + links: [ + { + title: 'Docs', + items: [ + { + label: 'Style Guide', + to: 'docs/', + }, + { + label: 'Second Doc', + to: 'docs/doc2/', + }, + ], + }, + { + title: 'Community', + items: [ + { + label: 'Stack Overflow', + href: 'https://stackoverflow.com/questions/tagged/docusaurus', + }, + { + label: 'Discord', + href: 'https://discordapp.com/invite/docusaurus', + }, + { + label: 'X', + href: 'https://x.com/docusaurus', + }, + { + html: ` + <a href="https://www.netlify.com" target="_blank" rel="noreferrer noopener" aria-label="Deploys by Netlify"> + <img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" alt="Deploys by Netlify" width="114" height="51" /> + </a> + `, + }, + ], + }, + ], + // highlight-end + }, +}; +``` + +A simple footer just has a list of `FooterItem`s displayed in a row. + +Example simple configuration: + +```js title="docusaurus.config.js" +export default { + footer: { + // highlight-start + links: [ + { + label: 'Stack Overflow', + href: 'https://stackoverflow.com/questions/tagged/docusaurus', + }, + { + label: 'Discord', + href: 'https://discordapp.com/invite/docusaurus', + }, + { + label: 'X', + href: 'https://x.com/docusaurus', + }, + { + html: ` + <a href="https://www.netlify.com" target="_blank" rel="noreferrer noopener" aria-label="Deploys by Netlify"> + <img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" alt="Deploys by Netlify" width="114" height="51" /> + </a> + `, + }, + ], + // highlight-end + }, +}; +``` + +## Table of Contents {#table-of-contents} + +You can adjust the default table of contents via `themeConfig.tableOfContents`. + +```mdx-code-block +<APITable> +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `minHeadingLevel` | `number` | `2` | The minimum heading level shown in the table of contents. Must be between 2 and 6 and lower or equal to the max value. | +| `maxHeadingLevel` | `number` | `3` | Max heading level displayed in the TOC. Should be an integer between 2 and 6. | + +```mdx-code-block +</APITable> +``` + +Example configuration: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + // highlight-start + tableOfContents: { + minHeadingLevel: 2, + maxHeadingLevel: 5, + }, + // highlight-end + }, +}; +``` + +## Hooks {#hooks} + +### `useColorMode` {#use-color-mode} + +A React hook to access the color context. This context contains functions for selecting light/dark/system mode and exposes the current color mode and the choice from the user. The color mode values **should not be used for dynamic content rendering** (see below). + +Usage example: + +```jsx +// highlight-next-line +import {useColorMode} from '@docusaurus/theme-common'; + +const MyColorModeButton = () => { + // highlight-start + const { + colorMode, // the "effective" color mode, never null + colorModeChoice, // the color mode chosen by the user, can be null + setColorMode, // set the color mode chosen by the user + } = useColorMode(); + // highlight-end + + return ( + <button + onClick={() => { + const nextColorMode = colorModeChoice === 'dark' ? 'light' : 'dark'; + setColorMode(nextColorMode); + }}> + Toggle color mode + </button> + ); +}; +``` + +Attributes: + +- `colorMode: 'light' | 'dark'`: The effective color mode currently applied to the UI. It cannot be `null`. +- `colorModeChoice: 'light' | 'dark' | null`: The color mode explicitly chosen by the user. It can be `null` if user has not made any choice yet, or if they reset their choice to the system/default value. +- `setColorMode(colorModeChoice: 'light' | 'dark' | null, options: {persist: boolean}): void`: A function to call when the user explicitly chose a color mode. `null` permits to reset the choice to the system/default value. By default, the choice is persisted in `localStorage` and restored on page reload, but you can opt out with `{persist: false}`. + +:::warning + +Don't use `colorMode` and `colorModeChoice` while rendering React components. Doing so is likely to produce [FOUC](https://en.wikipedia.org/wiki/Flash_of_unstyled_content), layout shifts and [React hydration](https://18.react.dev/reference/react-dom/client/hydrateRoot) mismatches if you use them to render JSX content dynamically. + +However, these values are safe to use **after React hydration**, in `useEffect` and event listeners, like in the `MyColorModeButton` example above. + +If you need to render content dynamically depending on the current theme, the only way to avoid FOUC, layout shifts and hydration mismatch is to rely on CSS selectors to render content dynamically, based on the `html` data attributes that we set before the page displays anything: + +```html +<html data-theme="<light | dark>" data-theme-choice="<light | dark | system>"> + <!-- content --> +</html> +``` + +```css +[data-theme='light'] +[data-theme='dark'] + +[data-theme-choice='light'] +[data-theme-choice='dark'] +[data-theme-choice='system'] +``` + +<details> + <summary>Why are `colorMode` and `colorModeChoice` unsafe when rendering?</summary> + +To understand the problem, you need to understand how [React hydration](https://18.react.dev/reference/react-dom/client/hydrateRoot) works. + +During the static site generation phase, Docusaurus doesn't know what the user color mode choice is, and `useColorMode()` returns the following static values: + +- `colorMode = themeConfig.colorMode.defaultMode` +- `colorModeChoice = null` + +During the very first React client-side render (the hydration), React must produce the exact same HTML markup, and will also use these static values. + +The correct `colorMode` and `colorModeChoice` values will only be provided in the second React render. + +Typically, the following component will lead to **React hydration mismatches**. The label may switch from `light` to `dark` while React hydrates, leading to a confusing user experience. + +```jsx +import {useColorMode} from '@docusaurus/theme-common'; + +const DisplayCurrentColorMode = () => { + const {colorMode} = useColorMode(); + return <span>{colorMode}</span>; +}; +``` + +</details> + +::: + +:::note + +The component calling `useColorMode` must be a child of the `Layout` component. + +```jsx +function ExamplePage() { + return ( + <Layout> + <Example /> + </Layout> + ); +} +``` + +::: + +## i18n {#i18n} + +Read the [i18n introduction](../../i18n/i18n-introduction.mdx) first. + +### Translation files location {#translation-files-location} + +- **Base path**: `website/i18n/[locale]/docusaurus-theme-[themeName]` +- **Multi-instance path**: N/A +- **JSON files**: extracted with [`docusaurus write-translations`](../../cli.mdx#docusaurus-write-translations-sitedir) +- **Markdown files**: N/A + +### Example file-system structure {#example-file-system-structure} + +```bash +website/i18n/[locale]/docusaurus-theme-classic +│ +│ # translations for the theme +├── navbar.json +└── footer.json +``` diff --git a/website/versioned_docs/version-3.9.2/api/themes/theme-live-codeblock.mdx b/website/versioned_docs/version-3.9.2/api/themes/theme-live-codeblock.mdx new file mode 100644 index 0000000000..212c910b3e --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/themes/theme-live-codeblock.mdx @@ -0,0 +1,29 @@ +--- +sidebar_position: 3 +slug: /api/themes/@docusaurus/theme-live-codeblock +--- + +# 📦 theme-live-codeblock + +This theme provides a `@theme/CodeBlock` component that is powered by [react-live](https://commerce.nearform.com/open-source/react-live/). You can read more on [interactive code editor](../../guides/markdown-features/markdown-features-code-blocks.mdx#interactive-code-editor) documentation. + +```bash npm2yarn +npm install --save @docusaurus/theme-live-codeblock +``` + +### Configuration {#configuration} + +```js title="docusaurus.config.js" +export default { + plugins: ['@docusaurus/theme-live-codeblock'], + themeConfig: { + liveCodeBlock: { + /** + * The position of the live playground, above or under the editor + * Possible values: "top" | "bottom" + */ + playgroundPosition: 'bottom', + }, + }, +}; +``` diff --git a/website/versioned_docs/version-3.9.2/api/themes/theme-mermaid.mdx b/website/versioned_docs/version-3.9.2/api/themes/theme-mermaid.mdx new file mode 100644 index 0000000000..d9a2059535 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/themes/theme-mermaid.mdx @@ -0,0 +1,25 @@ +--- +sidebar_position: 5 +slug: /api/themes/@docusaurus/theme-mermaid +--- + +# 📦 theme-mermaid + +This theme provides a `@theme/Mermaid` component that is powered by [mermaid](https://mermaid-js.github.io/). You can read more on [diagrams](../../guides/markdown-features/markdown-features-diagrams.mdx) documentation. + +```bash npm2yarn +npm install --save @docusaurus/theme-mermaid +``` + +## Configuration {#configuration} + +```js title="docusaurus.config.js" +export default { + themes: ['@docusaurus/theme-mermaid'], + // In order for Mermaid code blocks in Markdown to work, + // you also need to enable the Remark plugin with this option + markdown: { + mermaid: true, + }, +}; +``` diff --git a/website/versioned_docs/version-3.9.2/api/themes/theme-search-algolia.mdx b/website/versioned_docs/version-3.9.2/api/themes/theme-search-algolia.mdx new file mode 100644 index 0000000000..f8aa09a99c --- /dev/null +++ b/website/versioned_docs/version-3.9.2/api/themes/theme-search-algolia.mdx @@ -0,0 +1,20 @@ +--- +sidebar_position: 4 +slug: /api/themes/@docusaurus/theme-search-algolia +--- + +# 📦 theme-search-algolia + +This theme provides a `@theme/SearchBar` component that integrates with Algolia DocSearch easily. Combined with `@docusaurus/theme-classic`, it provides a very easy search integration. You can read more on [search](../../search.mdx) documentation. + +```bash npm2yarn +npm install --save @docusaurus/theme-search-algolia +``` + +This theme also adds search page available at `/search` (as swizzlable `SearchPage` component) path with OpenSearch support. You can change this default path via `themeConfig.algolia.searchPagePath`. Use `false` to disable search page. + +:::tip + +If you have installed `@docusaurus/preset-classic`, you don't need to install it as a dependency. + +::: diff --git a/website/versioned_docs/version-3.9.2/assets/docusaurus-asset-example-banner.png b/website/versioned_docs/version-3.9.2/assets/docusaurus-asset-example-banner.png new file mode 100644 index 0000000000..ebe95f5ec8 Binary files /dev/null and b/website/versioned_docs/version-3.9.2/assets/docusaurus-asset-example-banner.png differ diff --git a/website/versioned_docs/version-3.9.2/assets/docusaurus-asset-example.docx b/website/versioned_docs/version-3.9.2/assets/docusaurus-asset-example.docx new file mode 100644 index 0000000000..3c51aea4e7 Binary files /dev/null and b/website/versioned_docs/version-3.9.2/assets/docusaurus-asset-example.docx differ diff --git a/website/versioned_docs/version-3.9.2/assets/docusaurus-asset-example.xyz b/website/versioned_docs/version-3.9.2/assets/docusaurus-asset-example.xyz new file mode 100644 index 0000000000..188262276a Binary files /dev/null and b/website/versioned_docs/version-3.9.2/assets/docusaurus-asset-example.xyz differ diff --git a/website/versioned_docs/version-3.9.2/blog.mdx b/website/versioned_docs/version-3.9.2/blog.mdx new file mode 100644 index 0000000000..92a9551150 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/blog.mdx @@ -0,0 +1,783 @@ +--- +description: Deploy a full-featured blog in no time with Docusaurus. +--- + +# Blog + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +The blog feature enables you to deploy a full-featured blog in no time. + +:::info + +Check the [Blog Plugin API Reference documentation](./api/plugins/plugin-content-blog.mdx) for an exhaustive list of options. + +::: + +## Initial setup {#initial-setup} + +To set up your site's blog, start by creating a `blog` directory. + +Then, add an item link to your blog within `docusaurus.config.js`: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + // ... + navbar: { + items: [ + // ... + // highlight-next-line + {to: 'blog', label: 'Blog', position: 'left'}, // or position: 'right' + ], + }, + }, +}; +``` + +## Adding posts {#adding-posts} + +To publish in the blog, create a Markdown file within the blog directory. + +For example, create a file at `website/blog/2019-09-05-hello-docusaurus.md`: + +```md title="website/blog/2019-09-05-hello-docusaurus.md" +--- +title: Welcome Docusaurus +description: This is my first post on Docusaurus. +slug: welcome-docusaurus-v2 +authors: + - name: Joel Marcey + title: Co-creator of Docusaurus 1 + url: https://github.com/JoelMarcey + image_url: https://github.com/JoelMarcey.png + socials: + x: joelmarcey + github: JoelMarcey + - name: Sébastien Lorber + title: Docusaurus maintainer + url: https://sebastienlorber.com + image_url: https://github.com/slorber.png + socials: + x: sebastienlorber + github: slorber + email: seb@example.com +tags: [hello, docusaurus-v2] +image: https://i.imgur.com/mErPwqL.png +hide_table_of_contents: false +--- + +Welcome to this blog. This blog is created with [**Docusaurus**](https://docusaurus.io/). + +<!-- truncate --> + +This is my first post on Docusaurus. + +A whole bunch of exploration to follow. +``` + +The [front matter](./guides/markdown-features/markdown-features-intro.mdx#front-matter) is useful to add more metadata to your blog post, for example, author information, but Docusaurus will be able to infer all necessary metadata without the front matter. For all possible fields, see [the API documentation](api/plugins/plugin-content-blog.mdx#markdown-front-matter). + +## Blog list {#blog-list} + +The blog's index page (by default, it is at `/blog`) is the _blog list page_, where all blog posts are collectively displayed. + +Use the `<!--truncate-->` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `<!--truncate-->` will be part of the summary. Note that the portion above the truncate marker must be standalone renderable Markdown. For example: + +```md title="website/blog/my-post.md" {7} +--- +title: Markdown blog truncation example +--- + +All these will be part of the blog post summary. + +<!-- truncate --> + +But anything from here on down will not be. +``` + +For files using the `.mdx` extension, use a [MDX](https://mdxjs.com/) comment `{/* truncate */}` instead: + +{/* prettier-ignore */} +```md title="website/blog/my-post.mdx" {7} +--- +title: MDX blog truncation Example +--- + +All these will be part of the blog post summary. + +{/* truncate */} + +But anything from here on down will not be. +``` + +By default, 10 posts are shown on each blog list page, but you can control pagination with the `postsPerPage` option in the plugin configuration. If you set `postsPerPage: 'ALL'`, pagination will be disabled and all posts will be displayed on the first page. You can also add a meta description to the blog list page for better SEO: + +```js title="docusaurus.config.js" +export default { + // ... + presets: [ + [ + '@docusaurus/preset-classic', + { + blog: { + // highlight-start + blogTitle: 'Docusaurus blog!', + blogDescription: 'A Docusaurus powered blog!', + postsPerPage: 'ALL', + // highlight-end + }, + }, + ], + ], +}; +``` + +## Blog sidebar {#blog-sidebar} + +The blog sidebar displays recent blog posts. The default number of items shown is 5, but you can customize with the `blogSidebarCount` option in the plugin configuration. By setting `blogSidebarCount: 0`, the sidebar will be completely disabled, with the container removed as well. This will increase the width of the main container. Specially, if you have set `blogSidebarCount: 'ALL'`, _all_ posts will be displayed. + +You can also alter the sidebar heading text with the `blogSidebarTitle` option. For example, if you have set `blogSidebarCount: 'ALL'`, instead of the default "Recent posts", you may rather make it say "All posts": + +```js title="docusaurus.config.js" +export default { + presets: [ + [ + '@docusaurus/preset-classic', + { + blog: { + // highlight-start + blogSidebarTitle: 'All posts', + blogSidebarCount: 'ALL', + // highlight-end + }, + }, + ], + ], +}; +``` + +## Blog post date {#blog-post-date} + +Docusaurus will extract a `YYYY-MM-DD` date from many patterns such as `YYYY-MM-DD-my-blog-post-title.md` or `YYYY/MM/DD/my-blog-post-title.md`. This enables you to easily group blog posts by year, by month, or to use a flat structure. + +<details> +<summary>Supported date extraction patterns</summary> + +| Pattern | Example | +| --- | --- | +| Single file | `2021-05-28-my-blog-post-title.md` | +| MDX file | `2021-05-28-my-blog-post-title.mdx` | +| Single folder + `index.md` | `2021-05-28-my-blog-post-title/index.md` | +| Folder named by date | `2021-05-28/my-blog-post-title.md` | +| Nested folders by date | `2021/05/28/my-blog-post-title.md` | +| Partially nested folders by date | `2021/05-28-my-blog-post-title.md` | +| Nested folders + `index.md` | `2021/05/28/my-blog-post-title/index.md` | +| Date in the middle of path | `category/2021/05-28-my-blog-post-title.md` | + +Docusaurus can extract the date from the posts using any of the naming patterns above. It is advisable to choose one pattern and apply it to all posts to avoid confusion. + +</details> + +:::tip + +Using a folder can be convenient to co-locate blog post images alongside the Markdown file. + +::: + +This naming convention is optional, and you can also provide the date as front matter. Since the front matter follows YAML syntax where the datetime notation is supported, you can use front matter if you need more fine-grained publish dates. For example, if you have multiple posts published on the same day, you can order them according to the time of the day: + +```md title="earlier-post.md" +--- +date: 2021-09-13T10:00 +--- +``` + +```md title="later-post.md" +--- +date: 2021-09-13T18:00 +--- +``` + +## Blog post authors {#blog-post-authors} + +Use the `authors` front matter field to declare blog post authors. An author should have at least a `name` or an `image_url`. Docusaurus uses information like `url`, `email`, and `title`, but any other information is allowed. + +### Inline authors {#inline-authors} + +Blog post authors can be declared directly inside the front matter: + +```mdx-code-block +<Tabs groupId="author-front-matter"> +<TabItem value="single" label="Single author"> +``` + +```md title="my-blog-post.md" +--- +authors: + name: Joel Marcey + title: Co-creator of Docusaurus 1 + url: https://github.com/JoelMarcey + image_url: https://github.com/JoelMarcey.png + email: jimarcey@gmail.com + socials: + x: joelmarcey + github: JoelMarcey +--- +``` + +```mdx-code-block +</TabItem> +<TabItem value="multiple" label="Multiple authors"> +``` + +```md title="my-blog-post.md" +--- +authors: + - name: Joel Marcey + title: Co-creator of Docusaurus 1 + url: https://github.com/JoelMarcey + image_url: https://github.com/JoelMarcey.png + email: jimarcey@gmail.com + socials: + x: joelmarcey + github: JoelMarcey + - name: Sébastien Lorber + title: Docusaurus maintainer + url: https://sebastienlorber.com + image_url: https://github.com/slorber.png + socials: + x: sebastienlorber + github: slorber +--- +``` + +```mdx-code-block +</TabItem> +</Tabs> +``` + +:::tip + +This option works best to get started, or for casual, irregular authors. + +::: + +:::info + +Prefer using the `authors` front matter, but the legacy `author_*` front matter remains supported: + +```md title="my-blog-post.md" +--- +author: Joel Marcey +author_title: Co-creator of Docusaurus 1 +author_url: https://github.com/JoelMarcey +author_image_url: https://github.com/JoelMarcey.png +--- +``` + +::: + +### Global authors {#global-authors} + +For regular blog post authors, it can be tedious to maintain authors' information inlined in each blog post. + +It is possible to declare those authors globally in a configuration file: + +```yml title="website/blog/authors.yml" +jmarcey: + name: Joel Marcey + title: Co-creator of Docusaurus 1 + url: https://github.com/JoelMarcey + image_url: https://github.com/JoelMarcey.png + email: jimarcey@gmail.com + socials: + x: joelmarcey + github: JoelMarcey + +slorber: + name: Sébastien Lorber + title: Docusaurus maintainer + url: https://sebastienlorber.com + image_url: https://github.com/slorber.png + socials: + x: sebastienlorber + github: slorber + email: seb@example.com +``` + +:::tip + +Use the `authorsMapPath` plugin option to configure the path. JSON is also supported. + +::: + +In blog posts front matter, you can reference the authors declared in the global configuration file: + +```mdx-code-block +<Tabs groupId="author-front-matter"> +<TabItem value="single" label="Single author"> +``` + +```md title="my-blog-post.md" +--- +authors: jmarcey +--- +``` + +```mdx-code-block +</TabItem> +<TabItem value="multiple" label="Multiple authors"> +``` + +```md title="my-blog-post.md" +--- +authors: [jmarcey, slorber] +--- +``` + +```mdx-code-block +</TabItem> +</Tabs> +``` + +:::info + +The `authors` system is very flexible and can suit more advanced use-case: + +<details> + <summary>Mix inline authors and global authors</summary> + +You can use global authors most of the time, and still use inline authors: + +```md title="my-blog-post.md" +--- +authors: + - jmarcey + - slorber + - name: Inline Author name + title: Inline Author Title + url: https://github.com/inlineAuthor + image_url: https://github.com/inlineAuthor +--- +``` + +</details> + +<details> + <summary>Local override of global authors</summary> + +You can customize the global author's data on per-blog-post basis: + +```md title="my-blog-post.md" +--- +authors: + - key: jmarcey + title: Joel Marcey's new title + - key: slorber + name: Sébastien Lorber's new name +--- +``` + +</details> + +<details> + <summary>Localize the author's configuration file</summary> + +The configuration file can be localized, just create a localized copy of it at: + +```bash +website/i18n/[locale]/docusaurus-plugin-content-blog/authors.yml +``` + +</details> + +::: + +An author, either declared through front matter or through the authors map, needs to have a name or an avatar, or both. If all authors of a post don't have names, Docusaurus will display their avatars compactly. See [this test post](/tests/blog/2022/01/20/image-only-authors) for the effect. + +:::warning Feed generation + +[RSS feeds](#feed) require the author's email to be set for the author to appear in the feed. + +::: + +### Authors pages {#authors-pages} + +The authors pages feature is optional, and mainly useful for multi-author blogs. + +You can activate it independently for each author by adding a `page: true` attribute to the [global author configuration](#global-authors): + +```yml title="website/blog/authors.yml" +slorber: + name: Sébastien Lorber + // highlight-start + page: true # Turns the feature on - route will be /authors/slorber + // highlight-end + +jmarcey: + name: Joel Marcey + // highlight-start + page: + # Turns the feature on - route will be /authors/custom-author-url + permalink: '/custom-author-url' + // highlight-end +``` + +The blog plugin will now generate: + +- a dedicated author page for each author ([example](/blog/authors/slorber)) listing all the blog posts they contributed to +- an authors index page ([example](/blog/authors)) listing all these authors, in the order they appear in `authors.yml` + +:::warning About inline authors + +Only [global authors](#global-authors) can activate this feature. [Inline authors](#inline-authors) are not supported. + +::: + +## Blog post tags {#blog-post-tags} + +Tags are declared in the front matter and introduce another dimension of categorization. + +It is possible to define tags inline, or to reference predefined tags declared in a [`tags file`](api/plugins/plugin-content-blog.mdx#tags-file) (optional, usually `blog/tags.yml`). + +In the following example: + +- `docusaurus` references a predefined tag key declared in `blog/tags.yml` +- `Releases` is an inline tag, because it does not exist in `blog/tags.yml` + +```md title="blog/my-post.md" +--- +title: 'My blog post' +tags: + - Releases + - docusaurus +--- + +Content +``` + +```yml title="blog/tags.yml" +docusaurus: + label: 'Docusaurus' + permalink: '/docusaurus' + description: 'Blog posts related to the Docusaurus framework' +``` + +## Reading time {#reading-time} + +Docusaurus generates a reading time estimation for each blog post based on word count. We provide an option to customize this. + +```js title="docusaurus.config.js" +export default { + presets: [ + [ + '@docusaurus/preset-classic', + { + blog: { + // highlight-start + showReadingTime: true, // When set to false, the "x min read" won't be shown + readingTime: ({content, locale, frontMatter, defaultReadingTime}) => + defaultReadingTime({ + content, + locale, + options: {wordsPerMinute: 300}, + }), + // highlight-end + }, + }, + ], + ], +}; +``` + +The `readingTime` callback receives the following parameters: + +- `content`: the blog content text as a string +- `frontMatter`: the front matter as a record of string keys and their values +- `locale`: the locale of the current Docusaurus site +- `defaultReadingTime`: the default built-in reading time function. It returns a number (reading time in minutes) or `undefined` (disable reading time for this page). + +The default reading time is able to accept additional options: + +- `wordsPerMinute` as a number (default: 300) + +:::tip + +Use the callback for all your customization needs: + +```mdx-code-block +<Tabs> +<TabItem value="disable-per-post" label="Per-post disabling"> +``` + +**Disable reading time on one page:** + +```js title="docusaurus.config.js" +export default { + presets: [ + [ + '@docusaurus/preset-classic', + { + blog: { + showReadingTime: true, + // highlight-start + readingTime: ({content, locale, frontMatter, defaultReadingTime}) => + frontMatter.hide_reading_time + ? undefined + : defaultReadingTime({content, locale}), + // highlight-end + }, + }, + ], + ], +}; +``` + +Usage: + +```md "my-blog-post.md" +--- +hide_reading_time: true +--- + +This page will no longer display the reading time stats! +``` + +```mdx-code-block +</TabItem> +<TabItem value="passing-options" label="Passing options"> +``` + +**Pass options to the default reading time function:** + +```js title="docusaurus.config.js" +export default { + presets: [ + [ + '@docusaurus/preset-classic', + { + blog: { + // highlight-start + readingTime: ({content, locale, defaultReadingTime}) => + defaultReadingTime({ + content, + locale, + options: {wordsPerMinute: 100}, + }), + // highlight-end + }, + }, + ], + ], +}; +``` + +```mdx-code-block +</TabItem> +<TabItem value="using-custom-algo" label="Using custom algorithms"> +``` + +**Use a custom implementation of reading time:** + +```js title="docusaurus.config.js" +import myReadingTime from './myReadingTime'; + +export default { + presets: [ + [ + '@docusaurus/preset-classic', + { + blog: { + // highlight-next-line + readingTime: ({content, locale}) => myReadingTime(content, locale), + }, + }, + ], + ], +}; +``` + +```mdx-code-block +</TabItem> +</Tabs> +``` + +::: + +## Feed {#feed} + +You can generate RSS / Atom / JSON feed by passing `feedOptions`. By default, RSS and Atom feeds are generated. To disable feed generation, set `feedOptions.type` to `null`. + +```ts +type FeedType = 'rss' | 'atom' | 'json'; + +type BlogOptions = { + feedOptions?: { + type?: FeedType | 'all' | FeedType[] | null; + title?: string; + description?: string; + copyright: string; + + language?: string; // possible values: http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes + limit?: number | false | null; // defaults to 20 + // XSLT permits browsers to style and render nicely the feed XML files + xslt?: + | boolean + | { + // + rss?: string | boolean; + atom?: string | boolean; + }; + // Allow control over the construction of BlogFeedItems + createFeedItems?: (params: { + blogPosts: BlogPost[]; + siteConfig: DocusaurusConfig; + outDir: string; + defaultCreateFeedItems: (params: { + blogPosts: BlogPost[]; + siteConfig: DocusaurusConfig; + outDir: string; + }) => Promise<BlogFeedItem[]>; + }) => Promise<BlogFeedItem[]>; + }; +}; +``` + +Example usage: + +```js title="docusaurus.config.js" +export default { + // ... + presets: [ + [ + '@docusaurus/preset-classic', + { + blog: { + // highlight-start + feedOptions: { + type: 'all', + copyright: `Copyright © ${new Date().getFullYear()} Facebook, Inc.`, + createFeedItems: async (params) => { + const {blogPosts, defaultCreateFeedItems, ...rest} = params; + return defaultCreateFeedItems({ + // keep only the 10 most recent blog posts in the feed + blogPosts: blogPosts.filter((item, index) => index < 10), + ...rest, + }); + }, + }, + // highlight-end + }, + }, + ], + ], +}; +``` + +The feeds can be found at: + +<Tabs> +<TabItem value="RSS"> + +```text +https://example.com/blog/rss.xml +``` + +</TabItem> +<TabItem value="Atom"> + +```text +https://example.com/blog/atom.xml +``` + +</TabItem> +<TabItem value="JSON"> + +```text +https://example.com/blog/feed.json +``` + +</TabItem> +</Tabs> + +## Advanced topics {#advanced-topics} + +### Blog-only mode {#blog-only-mode} + +You can run your Docusaurus site without a dedicated landing page and instead have your blog's post list page as the index page. Set the `routeBasePath` to be `'/'` to serve the blog through the root route `example.com/` instead of the subroute `example.com/blog/`. + +```js title="docusaurus.config.js" +export default { + // ... + presets: [ + [ + '@docusaurus/preset-classic', + { + // highlight-next-line + docs: false, // Optional: disable the docs plugin + blog: { + // highlight-next-line + routeBasePath: '/', // Serve the blog at the site's root + /* other blog options */ + }, + }, + ], + ], +}; +``` + +:::warning + +Don't forget to delete the existing homepage at `./src/pages/index.js` or else there will be two files mapping to the same route! + +::: + +:::warning + +If you disable the docs plugin, don't forget to delete references to the docs plugin elsewhere in your configuration file. Notably, make sure to remove the docs-related navbar items. + +::: + +:::tip + +There's also a "Docs-only mode" for those who only want to use the docs. Read [Docs-only mode](./guides/docs/docs-introduction.mdx) for detailed instructions or a more elaborate explanation of `routeBasePath`. + +::: + +### Multiple blogs {#multiple-blogs} + +By default, the classic theme assumes only one blog per website and hence includes only one instance of the blog plugin. If you would like to have multiple blogs on a single website, it's possible too! You can add another blog by specifying another blog plugin in the `plugins` option for `docusaurus.config.js`. + +Set the `routeBasePath` to the URL route that you want your second blog to be accessed on. Note that the `routeBasePath` here has to be different from the first blog or else there could be a collision of paths! Also, set `path` to the path to the directory containing your second blog's entries. + +As documented for [multi-instance plugins](./using-plugins.mdx#multi-instance-plugins-and-plugin-ids), you need to assign a unique ID to the plugins. + +```js title="docusaurus.config.js" +export default { + // ... + plugins: [ + [ + '@docusaurus/plugin-content-blog', + { + /** + * Required for any multi-instance plugin + */ + id: 'second-blog', + /** + * URL route for the blog section of your site. + * *DO NOT* include a trailing slash. + */ + routeBasePath: 'my-second-blog', + /** + * Path to data on filesystem relative to site dir. + */ + path: './my-second-blog', + }, + ], + ], +}; +``` + +As an example, we host a second blog [here](/tests/blog). diff --git a/website/versioned_docs/version-3.9.2/browser-support.mdx b/website/versioned_docs/version-3.9.2/browser-support.mdx new file mode 100644 index 0000000000..79c01861d7 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/browser-support.mdx @@ -0,0 +1,106 @@ +--- +description: How to keep a reasonable bundle size while ensuring sufficient browser support. +--- + +# Browser support + +Docusaurus allows sites to define the list of supported browsers through a [browserslist configuration](https://github.com/browserslist/browserslist). + +## Purpose {#purpose} + +Websites need to balance between backward compatibility and bundle size. As old browsers do not support modern APIs or syntax, more code is needed to implement the same functionality. + +For example, you may use the [optional chaining syntax](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Optional_chaining): + +```js +const value = obj?.prop?.val; +``` + +...which unfortunately is only recognized by browser versions released after 2020. To be compatible with earlier browser versions, when building your site for production, our JS loader will transpile your code to a more verbose syntax: + +```js +var _obj, _obj$prop; + +const value = + (_obj = obj) === null || _obj === void 0 + ? void 0 + : (_obj$prop = _obj.prop) === null || _obj$prop === void 0 + ? void 0 + : _obj$prop.val; +``` + +However, this penalizes all other users with increased site load time because the 29-character line now becomes 168 characters—a 6-fold increase! (In practice, it will be better because the names used will be shorter.) As a tradeoff, the JS loader only transpiles the syntax to the degree that's supported by all browser versions defined in the browser list. + +The browser list by default is provided through the `package.json` file as a root `browserslist` field. + +:::warning + +On old browsers, the compiled output will use unsupported (too recent) JS syntax, causing React to fail to initialize and end up with a static website with only HTML/CSS and no JS. + +::: + +## Default values {#default-values} + +Websites initialized with the default classic template has the following in `package.json`: + +```json title="package.json" +{ + "name": "docusaurus", + // ... + // highlight-start + "browserslist": { + "production": [">0.5%", "not dead", "not op_mini all"], + "development": [ + "last 1 chrome version", + "last 1 firefox version", + "last 1 safari version" + ] + } + // highlight-end + // ... +} +``` + +Explained in natural language, the browsers supported in production are those: + +- With more than 0.5% of market share; _and_ +- Has official support or updates in the past 24 months (the opposite of "dead"); _and_ +- Is not Opera Mini. + +And browsers used in development are: + +- The latest version of Chrome _or_ Firefox _or_ Safari. + +You can "evaluate" any config with the `browserslist` CLI to obtain the actual list: + +```bash +npx browserslist --env="production" +``` + +The output is all browsers supported in production. Below is the output in January 2022: + +```text +and_chr 96 +and_uc 12.12 +chrome 96 +chrome 95 +chrome 94 +edge 96 +firefox 95 +firefox 94 +ie 11 +ios_saf 15.2 +ios_saf 15.0-15.1 +ios_saf 14.5-14.8 +ios_saf 14.0-14.4 +ios_saf 12.2-12.5 +opera 82 +opera 81 +safari 15.1 +safari 14.1 +safari 13.1 +``` + +## Read more {#read-more} + +You may wish to visit the [browserslist documentation](https://github.com/browserslist/browserslist/blob/main/README.md) for more specifications, especially the accepted [query values](https://github.com/browserslist/browserslist/blob/main/README.md#queries) and [best practices](https://github.com/browserslist/browserslist/blob/main/README.md#best-practices). diff --git a/website/versioned_docs/version-3.9.2/cli.mdx b/website/versioned_docs/version-3.9.2/cli.mdx new file mode 100644 index 0000000000..1ec8120b49 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/cli.mdx @@ -0,0 +1,190 @@ +--- +description: Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. +--- + +# CLI + +Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. + +Once your website is bootstrapped, the website source will contain the Docusaurus scripts that you can invoke with your package manager: + +```json title="package.json" +{ + // ... + "scripts": { + "docusaurus": "docusaurus", + "start": "docusaurus start", + "build": "docusaurus build", + "swizzle": "docusaurus swizzle", + "deploy": "docusaurus deploy", + "clear": "docusaurus clear", + "serve": "docusaurus serve", + "write-translations": "docusaurus write-translations", + "write-heading-ids": "docusaurus write-heading-ids" + } +} +``` + +## Docusaurus CLI commands {#docusaurus-cli-commands} + +Below is a list of Docusaurus CLI commands and their usages: + +### `docusaurus start [siteDir]` {#docusaurus-start-sitedir} + +Builds and serves a preview of your site locally with [Webpack Dev Server](https://webpack.js.org/configuration/dev-server). + +#### Options {#options} + +| Name | Default | Description | +| --- | --- | --- | +| `--port` | `3000` | Specifies the port of the dev server. | +| `--host` | `localhost` | Specify a host to use. For example, if you want your server to be accessible externally, you can use `--host 0.0.0.0`. | +| `--locale` | | Specify site locale to be used. | +| `--hot-only` | `false` | Enables Hot Module Replacement without page refresh as a fallback in case of build failures. More information [here](https://webpack.js.org/configuration/dev-server/#devserverhotonly). | +| `--no-open` | `false` | Do not open the page automatically in the browser. | +| `--config` | `undefined` | Path to Docusaurus config file, default to `[siteDir]/docusaurus.config.js` | +| `--poll [optionalIntervalMs]` | `false` | Use polling of files rather than watching for live reload as a fallback in environments where watching doesn't work. More information [here](https://webpack.js.org/configuration/watch/#watchoptionspoll). | +| `--no-minify` | `false` | Build website without minimizing JS/CSS bundles. | + +:::info + +Please note that some functionality (for example, anchor links) will not work in development. The functionality will work as expected in production. + +::: + +:::info Development over network + +When forwarding port 3000 from a remote server or VM (e.g. GitHub Codespaces), you can run the dev server on `0.0.0.0` to make it listen on the local IP. + +```bash npm2yarn +npm run start -- --host 0.0.0.0 +``` + +::: + +#### Enabling HTTPS {#enabling-https} + +There are multiple ways to obtain a certificate. We will use [mkcert](https://github.com/FiloSottile/mkcert) as an example. + +1. Run `mkcert localhost` to generate `localhost.pem` + `localhost-key.pem` + +2. Run `mkcert -install` to install the cert in your trust store, and restart your browser + +3. Start the app with Docusaurus HTTPS env variables: + +```bash +HTTPS=true SSL_CRT_FILE=localhost.pem SSL_KEY_FILE=localhost-key.pem yarn start +``` + +4. Open `https://localhost:3000/` + +### `docusaurus build [siteDir]` {#docusaurus-build-sitedir} + +Compiles your site for production. + +#### Options {#options-1} + +| Name | Default | Description | +| --- | --- | --- | +| `--dev` | | Builds the website in dev mode, including full React error messages. | +| `--bundle-analyzer` | `false` | Analyze your bundle with the [webpack bundle analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer). | +| `--out-dir` | `build` | The full path for the new output directory, relative to the current workspace. | +| `--config` | `undefined` | Path to Docusaurus config file, default to `[siteDir]/docusaurus.config.js` | +| `--locale` | | Build the site in the specified locale(s). If not specified, all known locales are built. | +| `--no-minify` | `false` | Build website without minimizing JS/CSS bundles. | + +:::info + +For advanced minification of CSS bundle, we use the [advanced cssnano preset](https://github.com/cssnano/cssnano/tree/master/packages/cssnano-preset-advanced) (along with additional several PostCSS plugins) and [level 2 optimization of clean-css](https://github.com/jakubpawlowicz/clean-css#level-2-optimizations). If as a result of this advanced CSS minification you find broken CSS, build your website with the environment variable `USE_SIMPLE_CSS_MINIFIER=true` to minify CSS with the [default cssnano preset](https://github.com/cssnano/cssnano/tree/master/packages/cssnano-preset-default). **Please [fill out an issue](https://github.com/facebook/docusaurus/issues/new?labels=bug%2C+needs+triage&template=bug.md) if you experience CSS minification bugs.** + +You can skip the HTML minification with the environment variable `SKIP_HTML_MINIFICATION=true`. + +::: + +### `docusaurus swizzle [themeName] [componentName] [siteDir]` {#docusaurus-swizzle} + +[Swizzle](./swizzling.mdx) a theme component to customize it. + +```bash npm2yarn +npm run swizzle [themeName] [componentName] [siteDir] + +# Example (leaving out the siteDir to indicate this directory) +npm run swizzle @docusaurus/theme-classic Footer -- --eject +``` + +The swizzle CLI is interactive and will guide you through the whole [swizzle process](./swizzling.mdx). + +#### Options {#options-swizzle} + +| Name | Description | +| --- | --- | +| `themeName` | The name of the theme to swizzle from. | +| `componentName` | The name of the theme component to swizzle. | +| `--list` | Display components available for swizzling | +| `--eject` | [Eject](./swizzling.mdx#ejecting) the theme component | +| `--wrap` | [Wrap](./swizzling.mdx#wrapping) the theme component | +| `--danger` | Allow immediate swizzling of unsafe components | +| `--typescript` | Swizzle the TypeScript variant component | +| `--config` | Path to docusaurus config file, default to `[siteDir]/docusaurus.config.js` | + +:::warning + +Unsafe components have a higher risk of breaking changes due to internal refactorings. + +::: + +### `docusaurus deploy [siteDir]` {#docusaurus-deploy-sitedir} + +Deploys your site with [GitHub Pages](https://pages.github.com/). Check out the docs on [deployment](deployment.mdx#deploying-to-github-pages) for more details. + +#### Options {#options-3} + +| Name | Default | Description | +| --- | --- | --- | +| `--locale` | | Deploy the site in the specified locale(s). If not specified, all known locales are deployed. | +| `--out-dir` | `build` | The full path for the new output directory, relative to the current workspace. | +| `--skip-build` | `false` | Deploy website without building it. This may be useful when using a custom deploy script. | +| `--target-dir` | `.` | Path to the target directory to deploy to. | +| `--config` | `undefined` | Path to Docusaurus config file, default to `[siteDir]/docusaurus.config.js` | + +### `docusaurus serve [siteDir]` {#docusaurus-serve-sitedir} + +Serve your built website locally. + +| Name | Default | Description | +| --- | --- | --- | +| `--port` | `3000` | Use specified port | +| `--dir` | `build` | The full path for the output directory, relative to the current workspace | +| `--build` | `false` | Build website before serving | +| `--config` | `undefined` | Path to Docusaurus config file, default to `[siteDir]/docusaurus.config.js` | +| `--host` | `localhost` | Specify a host to use. For example, if you want your server to be accessible externally, you can use `--host 0.0.0.0`. | +| `--no-open` | `false` locally, `true` in CI | Do not open a browser window to the server location. | + +### `docusaurus clear [siteDir]` {#docusaurus-clear-sitedir} + +Clear a Docusaurus site's generated assets, caches, build artifacts. + +We recommend running this command before reporting bugs, after upgrading versions, or anytime you have issues with your Docusaurus site. + +### `docusaurus write-translations [siteDir]` {#docusaurus-write-translations-sitedir} + +Write the JSON translation files that you will have to translate. + +By default, the files are written in `website/i18n/<defaultLocale>/...`. + +| Name | Default | Description | +| --- | --- | --- | +| `--locale` | `<defaultLocale>` | Define which locale folder you want to write translations the JSON files in | +| `--override` | `false` | Override existing translation messages | +| `--config` | `undefined` | Path to Docusaurus config file, default to `[siteDir]/docusaurus.config.js` | +| `--messagePrefix` | `''` | Allows adding a prefix to each translation message, to help you highlight untranslated strings | + +### `docusaurus write-heading-ids [siteDir] [files]` {#docusaurus-write-heading-ids-sitedir} + +Add [explicit heading IDs](./guides/markdown-features/markdown-features-toc.mdx#heading-ids) to the Markdown documents of your site. + +| Name | Default | Description | +| --- | --- | --- | +| `files` | All MD files used by plugins | The files that you want heading IDs to be written to. | +| `--maintain-case` | `false` | Keep the headings' casing, otherwise make all lowercase. | +| `--overwrite` | `false` | Overwrite existing heading IDs. | diff --git a/website/versioned_docs/version-3.9.2/configuration.mdx b/website/versioned_docs/version-3.9.2/configuration.mdx new file mode 100644 index 0000000000..40e435afef --- /dev/null +++ b/website/versioned_docs/version-3.9.2/configuration.mdx @@ -0,0 +1,294 @@ +--- +description: Configuring your site's behavior through docusaurus.config.js and more. +--- + +# Configuration + +import TOCInline from '@theme/TOCInline'; + +:::info + +Check the [**`docusaurus.config.js` API reference**](api/docusaurus.config.js.mdx) for an exhaustive list of options. + +::: + +Docusaurus has a unique take on configurations. We encourage you to congregate information about your site into one place. We guard the fields of this file and facilitate making this data object accessible across your site. + +Keeping a well-maintained `docusaurus.config.js` helps you, your collaborators, and your open source contributors to be able to focus on documentation while still being able to customize the site. + +## Syntax to declare `docusaurus.config.js` {#syntax-to-declare-docusaurus-config} + +The `docusaurus.config.js` file is run in Node.js and should export either: + +- a **config object** +- a **function** that creates the config object + +:::info + +The `docusaurus.config.js` file supports: + +- [**ES Modules**](https://flaviocopes.com/es-modules/) +- [**CommonJS**](https://flaviocopes.com/commonjs/) +- [**TypeScript**](./typescript-support.mdx#typing-config) + +Constraints: + +- **Required:** use `export default /* your config*/` (or `module.exports`) to export your Docusaurus config +- **Optional:** use `import Lib from 'lib'` (or `require('lib')`) to import Node.js packages + +::: + +Docusaurus gives us the ability to declare its configuration in various **equivalent ways**, and all the following config examples lead to the exact same result: + +```js title="docusaurus.config.js" +export default { + title: 'Docusaurus', + url: 'https://docusaurus.io', + // your site config ... +}; +``` + +```js title="docusaurus.config.js" +module.exports = { + title: 'Docusaurus', + url: 'https://docusaurus.io', + // your site config ... +}; +``` + +```ts title="docusaurus.config.ts" +import type {Config} from '@docusaurus/types'; + +export default { + title: 'Docusaurus', + url: 'https://docusaurus.io', + // your site config ... +} satisfies Config; +``` + +```js title="docusaurus.config.js" +const config = { + title: 'Docusaurus', + url: 'https://docusaurus.io', + // your site config ... +}; + +export default config; +``` + +```js title="docusaurus.config.js" +export default function configCreator() { + return { + title: 'Docusaurus', + url: 'https://docusaurus.io', + // your site config ... + }; +} +``` + +```js title="docusaurus.config.js" +export default async function createConfigAsync() { + return { + title: 'Docusaurus', + url: 'https://docusaurus.io', + // your site config ... + }; +} +``` + +:::tip Using ESM-only packages + +Using an async config creator can be useful to import ESM-only modules (notably most Remark plugins). It is possible to import such modules thanks to dynamic imports: + +```js title="docusaurus.config.js" +export default async function createConfigAsync() { + // Use a dynamic import instead of require('esm-lib') + // highlight-next-line + const lib = await import('lib'); + + return { + title: 'Docusaurus', + url: 'https://docusaurus.io', + // rest of your site config... + }; +} +``` + +::: + +## What goes into a `docusaurus.config.js`? {#what-goes-into-a-docusaurusconfigjs} + +You should not have to write your `docusaurus.config.js` from scratch even if you are developing your site. All templates come with a `docusaurus.config.js` that includes defaults for the common options. + +However, it can be helpful if you have a high-level understanding of how the configurations are designed and implemented. + +The high-level overview of Docusaurus configuration can be categorized into: + +<TOCInline toc={toc} minHeadingLevel={3} maxHeadingLevel={3} /> + +### Site metadata {#site-metadata} + +Site metadata contains the essential global metadata such as `title`, `url`, `baseUrl`, and `favicon`. + +They are used in several places such as your site's title and headings, browser tab icon, social sharing (Facebook, X) information or even to generate the correct path to serve your static files. + +### Deployment configurations {#deployment-configurations} + +Deployment configurations such as `projectName`, `organizationName`, and optionally `deploymentBranch` are used when you deploy your site with the `deploy` command. + +It is recommended to check the [deployment docs](deployment.mdx) for more information. + +### Theme, plugin, and preset configurations {#theme-plugin-and-preset-configurations} + +List the [themes](./using-plugins.mdx#using-themes), [plugins](./using-plugins.mdx), and [presets](./using-plugins.mdx#using-presets) for your site in the `themes`, `plugins`, and `presets` fields, respectively. These are typically npm packages: + +```js title="docusaurus.config.js" +export default { + // ... + plugins: [ + '@docusaurus/plugin-content-blog', + '@docusaurus/plugin-content-pages', + ], + themes: ['@docusaurus/theme-classic'], +}; +``` + +:::tip + +Docusaurus supports [**module shorthands**](./using-plugins.mdx#module-shorthands), allowing you to simplify the above configuration as: + +```js title="docusaurus.config.js" +export default { + // ... + plugins: ['content-blog', 'content-pages'], + themes: ['classic'], +}; +``` + +::: + +They can also be loaded from local directories: + +```js title="docusaurus.config.js" +import path from 'path'; + +export default { + // ... + themes: [path.resolve(__dirname, '/path/to/docusaurus-local-theme')], +}; +``` + +To specify options for a plugin or theme, replace the name of the plugin or theme in the config file with an array containing the name and an options object: + +```js title="docusaurus.config.js" +export default { + // ... + plugins: [ + [ + 'content-blog', + { + path: 'blog', + routeBasePath: 'blog', + include: ['*.md', '*.mdx'], + // ... + }, + ], + 'content-pages', + ], +}; +``` + +To specify options for a plugin or theme that is bundled in a preset, pass the options through the `presets` field. In this example, `docs` refers to `@docusaurus/plugin-content-docs` and `theme` refers to `@docusaurus/theme-classic`. + +```js title="docusaurus.config.js" +export default { + // ... + presets: [ + [ + '@docusaurus/preset-classic', + { + docs: { + sidebarPath: './sidebars.js', + }, + theme: { + customCss: ['./src/css/custom.css'], + }, + }, + ], + ], +}; +``` + +:::tip + +The `presets: [['classic', {...}]]` shorthand works as well. + +::: + +For further help configuring themes, plugins, and presets, see [Using Plugins](./using-plugins.mdx). + +### Custom configurations {#custom-configurations} + +Docusaurus guards `docusaurus.config.js` from unknown fields. To add custom fields, define them in `customFields`. + +Example: + +```js title="docusaurus.config.js" +export default { + // ... + // highlight-start + customFields: { + image: '', + keywords: [], + }, + // highlight-end + // ... +}; +``` + +## Accessing configuration from components {#accessing-configuration-from-components} + +Your configuration object will be made available to all the components of your site. And you may access them via React context as `siteConfig`. + +Basic example: + +```jsx +import React from 'react'; +// highlight-next-line +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; + +const Hello = () => { + // highlight-start + const {siteConfig} = useDocusaurusContext(); + // highlight-end + const {title, tagline} = siteConfig; + + return <div>{`${title} · ${tagline}`}</div>; +}; +``` + +:::tip + +If you just want to use those fields on the client side, you could create your own JS files and import them as ES6 modules, there is no need to put them in `docusaurus.config.js`. + +::: + +## Customizing Babel Configuration {#customizing-babel-configuration} + +Docusaurus transpiles your site's source code using Babel by default. If you want to customize the Babel configuration, you can do so by creating a `babel.config.js` file in your project root. + +To use the built-in preset as a base configuration, install the following package and use it + +```bash npm2yarn +npm install --save @docusaurus/babel +``` + +Then use the preset in your `babel.config.js` file: + +```js title="babel.config.js" +export default { + presets: ['@docusaurus/babel/preset'], +}; +``` + +Most of the time, the default preset configuration will work just fine. If you want to customize your Babel configuration (e.g. to add support for Flow), you can directly edit this file. For your changes to take effect, you need to restart the Docusaurus dev server. diff --git a/website/versioned_docs/version-3.9.2/deployment.mdx b/website/versioned_docs/version-3.9.2/deployment.mdx new file mode 100644 index 0000000000..18b79e86e3 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/deployment.mdx @@ -0,0 +1,939 @@ +--- +description: Deploy your Docusaurus app for production on a range of static site hosting services. +--- + +# Deployment + +To build the static files of your website for production, run: + +```bash npm2yarn +npm run build +``` + +Once it finishes, the static files will be generated within the `build` directory. + +:::note + +The only responsibility of Docusaurus is to build your site and emit static files in `build`. + +It is now up to you to choose how to host those static files. + +::: + +You can deploy your site to static site hosting services such as [Vercel](https://vercel.com/), [GitHub Pages](https://pages.github.com/), [Netlify](https://www.netlify.com/), [Render](https://render.com/docs/static-sites), and [Surge](https://surge.sh/help/getting-started-with-surge). + +A Docusaurus site is statically rendered, and it can generally work without JavaScript! + +## Configuration {#configuration} + +The following parameters are required in `docusaurus.config.js` to optimize routing and serve files from the correct location: + +| Name | Description | +| --- | --- | +| `url` | URL for your site. For a site deployed at `https://my-org.com/my-project/`, `url` is `https://my-org.com/`. | +| `baseUrl` | Base URL for your project, with a trailing slash. For a site deployed at `https://my-org.com/my-project/`, `baseUrl` is `/my-project/`. | + +## Testing your Build Locally {#testing-build-locally} + +It is important to test your build locally before deploying it for production. Docusaurus provides a [`docusaurus serve`](cli.mdx#docusaurus-serve-sitedir) command for that: + +```bash npm2yarn +npm run serve +``` + +By default, this will load your site at [`http://localhost:3000/`](http://localhost:3000/). + +## Trailing slash configuration {#trailing-slashes} + +Docusaurus has a [`trailingSlash` config](./api/docusaurus.config.js.mdx#trailingSlash) to allow customizing URLs/links and emitted filename patterns. + +The default value generally works fine. Unfortunately, each static hosting provider has a **different behavior**, and deploying the exact same site to various hosts can lead to distinct results. Depending on your host, it can be useful to change this config. + +:::tip + +Use [slorber/trailing-slash-guide](https://github.com/slorber/trailing-slash-guide) to understand better the behavior of your host and configure `trailingSlash` appropriately. + +::: + +## Using environment variables {#using-environment-variables} + +Putting potentially sensitive information in the environment is common practice. However, in a typical Docusaurus website, the `docusaurus.config.js` file is the only interface to the Node.js environment (see [our architecture overview](advanced/architecture.mdx)), while everything else (MDX pages, React components, etc.) are client side and do not have direct access to the `process` global variable. In this case, you can consider using [`customFields`](api/docusaurus.config.js.mdx#customFields) to pass environment variables to the client side. + +```js title="docusaurus.config.js" +// If you are using dotenv (https://www.npmjs.com/package/dotenv) +import 'dotenv/config'; + +export default { + title: '...', + url: process.env.URL, // You can use environment variables to control site specifics as well + // highlight-start + customFields: { + // Put your custom environment here + teamEmail: process.env.EMAIL, + }, + // highlight-end +}; +``` + +```jsx title="home.jsx" +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; + +export default function Home() { + const { + siteConfig: {customFields}, + } = useDocusaurusContext(); + return <div>Contact us through {customFields.teamEmail}!</div>; +} +``` + +## Choosing a hosting provider {#choosing-a-hosting-provider} + +There are a few common hosting options: + +- [Self hosting](#self-hosting) with an HTTP server like Apache2 or Nginx. +- Jamstack providers (e.g. [Netlify](#deploying-to-netlify) and [Vercel](#deploying-to-vercel)). We will use them as references, but the same reasoning can apply to other providers. +- [GitHub Pages](#deploying-to-github-pages) (by definition, it is also Jamstack, but we compare it separately). + +If you are unsure of which one to choose, ask the following questions: + +<details> + +<summary> + How many resources (money, person-hours, etc.) am I willing to invest in this? +</summary> + +- 🔴 Self-hosting requires experience in networking as well as Linux and web server administration. It's the most difficult option, and would require the most time to manage successfully. Expense-wise, cloud services are almost never free, and purchasing/deploying an onsite server can be even more costly. +- 🟢 Jamstack providers can help you set up a working website in almost no time and offer features like server-side redirects that are easily configurable. Many providers offer generous build-time quotas even for free plans that you would almost never exceed. However, free plans have limits, and you would need to pay once you hit those limits. Check the pricing page of your provider for details. +- 🟡 The GitHub Pages deployment workflow can be tedious to set up. (Evidence: see the length of [Deploying to GitHub Pages](#deploying-to-github-pages)!) However, this service (including build and deployment) is always free for public repositories, and we have detailed instructions to help you make it work. + +</details> + +<details> + +<summary>How much server-side customization do I need?</summary> + +- 🟢 With self-hosting, you have access to the entire server's configuration. You can configure the virtual host to serve different content based on the request URL, you can do complicated server-side redirects, you can implement authentication, and so on. If you need a lot of server-side features, self-host your website. +- 🟡 Jamstack usually offers some server-side configuration (e.g. URL formatting (trailing slashes), server-side redirects, etc.). +- 🔴 GitHub Pages doesn't expose server-side configuration besides enforcing HTTPS and setting CNAME records. + +</details> + +<details> + +<summary>Do I need collaboration-friendly deployment workflows?</summary> + +- 🟡 Self-hosted services can leverage continuous deployment functionality like Netlify, but more heavy-lifting is involved. Usually, you would designate a specific person to manage the deployment, and the workflow wouldn't be very git-based as opposed to the other two options. +- 🟢 Netlify and Vercel have deploy previews for every pull request, which is useful for a team to review work before merging to production. You can also manage a team with different member access to the deployment. +- 🟡 GitHub Pages cannot do deploy previews in a non-convoluted way. One repo can only be associated with one site deployment. On the other hand, you can control who has write access to the site's deployment. + +</details> + +There isn't a silver bullet. You need to weigh your needs and resources before making a choice. + +## Self-Hosting {#self-hosting} + +Docusaurus can be self-hosted using [`docusaurus serve`](cli.mdx#docusaurus-serve-sitedir). Change port using `--port` and `--host` to change host. + +```bash npm2yarn +npm run serve -- --build --port 80 --host 0.0.0.0 +``` + +:::warning + +It is not the best option, compared to a static hosting provider / CDN. + +::: + +:::warning + +In the following sections, we will introduce a few common hosting providers and how they should be configured to deploy Docusaurus sites most efficiently. Docusaurus is not affiliated with any of these services, and this information is provided for convenience only. Some of the write-ups are provided by third-parties, and recent API changes may not be reflected on our side. If you see outdated content, PRs are welcome. + +Because we can only provide this content on a best-effort basis only, we have stopped accepting PRs adding new hosting options. You can, however, publish your writeup on a separate site (e.g. your blog, or the provider's official website), and ask us to include a link to your writeup. + +::: + +## Deploying to Netlify {#deploying-to-netlify} + +To deploy your Docusaurus sites to [Netlify](https://www.netlify.com/), first make sure the following options are properly configured: + +```js title="docusaurus.config.js" +export default { + // highlight-start + url: 'https://docusaurus-2.netlify.app', // Url to your site with no trailing slash + baseUrl: '/', // Base directory of your site relative to your repo + // highlight-end + // ... +}; +``` + +Then, [create your site with Netlify](https://app.netlify.com/start). + +While you set up the site, specify the build commands and directories as follows: + +- build command: `npm run build` +- publish directory: `build` + +If you did not configure these build options, you may still go to "Site settings" -> "Build & deploy" after your site is created. + +Once properly configured with the above options, your site should deploy and automatically redeploy upon merging to your deploy branch, which defaults to `main`. + +:::warning + +Some Docusaurus sites put the `docs` folder outside of `website` (most likely former Docusaurus v1 sites): + +```bash +repo # git root +├── docs # MD files +└── website # Docusaurus root +``` + +If you decide to use the `website` folder as Netlify's base directory, Netlify will not trigger builds when you update the `docs` folder, and you need to configure a [custom `ignore` command](https://docs.netlify.com/configure-builds/common-configurations/ignore-builds/): + +```toml title="website/netlify.toml" +[build] + ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF . ../docs/" +``` + +::: + +:::warning + +By default, Netlify adds trailing slashes to Docusaurus URLs. + +It is recommended to disable the Netlify setting `Post Processing > Asset Optimization > Pretty Urls` to prevent lowercase URLs, unnecessary redirects, and 404 errors. + +**Be very careful**: the `Disable asset optimization` global checkbox is broken and does not really disable the `Pretty URLs` setting in practice. Please make sure to **uncheck it independently**. + +If you want to keep the `Pretty Urls` Netlify setting on, adjust the `trailingSlash` Docusaurus config appropriately. + +Refer to [slorber/trailing-slash-guide](https://github.com/slorber/trailing-slash-guide) for more information. + +::: + +## Deploying to Vercel {#deploying-to-vercel} + +Deploying your Docusaurus project to [Vercel](https://vercel.com/) will provide you with [various benefits](https://vercel.com/) in the areas of performance and ease of use. + +To deploy your Docusaurus project with a [Vercel for Git Integration](https://vercel.com/docs/concepts/git), make sure it has been pushed to a Git repository. + +Import the project into Vercel using the [Import Flow](https://vercel.com/import/git). During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these [options](https://vercel.com/docs/build-step#build-&-development-settings). + +After your project has been imported, all subsequent pushes to branches will generate [Preview Deployments](https://vercel.com/docs/platform/deployments#preview), and all changes made to the [Production Branch](https://vercel.com/docs/git-integrations#production-branch) (usually "main" or "master") will result in a [Production Deployment](https://vercel.com/docs/platform/deployments#production). + +## Deploying to GitHub Pages {#deploying-to-github-pages} + +Docusaurus provides an easy way to publish to [GitHub Pages](https://pages.github.com/), which comes free with every GitHub repository. + +### Overview {#github-pages-overview} + +Usually, there are two repositories (at least two branches) involved in a publishing process: the branch containing the source files, and the branch containing the build output to be served with GitHub Pages. In the following tutorial, they will be referred to as **"source"** and **"deployment"**, respectively. + +Each GitHub repository is associated with a GitHub Pages service. If the deployment repository is called `my-org/my-project` (where `my-org` is the organization name or username), the deployed site will appear at `https://my-org.github.io/my-project/`. If the deployment repository is called `my-org/my-org.github.io` (the _organization GitHub Pages repo_), the site will appear at `https://my-org.github.io/`. + +:::info + +In case you want to use your custom domain for GitHub Pages, create a `CNAME` file in the `static` directory. Anything within the `static` directory will be copied to the root of the `build` directory for deployment. When using a custom domain, you should be able to move back from `baseUrl: '/projectName/'` to `baseUrl: '/'`, and also set your `url` to your custom domain. + +You may refer to GitHub Pages' documentation [User, Organization, and Project Pages](https://help.github.com/en/articles/user-organization-and-project-pages) for more details. + +::: + +GitHub Pages picks up deploy-ready files (the output from `docusaurus build`) from the default branch (`master` / `main`, usually) or the `gh-pages` branch, and either from the root or the `/docs` folder. You can configure that through `Settings > Pages` in your repository. This branch will be called the "deployment branch". + +We provide a `docusaurus deploy` command that helps you deploy your site from the source branch to the deployment branch in one command: clone, build, and commit. + +### `docusaurus.config.js` settings {#docusaurusconfigjs-settings} + +First, modify your `docusaurus.config.js` and add the following params: + +| Name | Description | +| --- | --- | +| `organizationName` | The GitHub user or organization that owns the deployment repository. | +| `projectName` | The name of the deployment repository. | +| `deploymentBranch` | The name of the deployment branch. It defaults to `'gh-pages'` for non-organization GitHub Pages repos (`projectName` not ending in `.github.io`). Otherwise, it needs to be explicit as a config field or environment variable. | + +These fields also have their environment variable counterparts which have a higher priority: `ORGANIZATION_NAME`, `PROJECT_NAME`, and `DEPLOYMENT_BRANCH`. + +:::warning + +GitHub Pages adds a trailing slash to Docusaurus URLs by default. It is recommended to set a `trailingSlash` config (`true` or `false`, not `undefined`). + +::: + +Example: + +```js title="docusaurus.config.js" +export default { + // ... + url: 'https://endiliey.github.io', // Your website URL + baseUrl: '/', + // highlight-start + projectName: 'endiliey.github.io', + organizationName: 'endiliey', + trailingSlash: false, + // highlight-end + // ... +}; +``` + +:::warning + +By default, GitHub Pages runs published files through [Jekyll](https://jekyllrb.com/). Since Jekyll will discard any files that begin with `_`, it is recommended that you disable Jekyll by adding an empty file named `.nojekyll` file to your `static` directory. + +::: + +### Environment settings {#environment-settings} + +| Name | Description | +| --- | --- | +| `USE_SSH` | Set to `true` to use SSH instead of the default HTTPS for the connection to the GitHub repo. If the source repo URL is an SSH URL (e.g. `git@github.com:facebook/docusaurus.git`), `USE_SSH` is inferred to be `true`. | +| `GIT_USER` | The username for a GitHub account that **has push access to the deployment repo**. For your own repositories, this will usually be your GitHub username. Required if not using SSH, and ignored otherwise. | +| `GIT_PASS` | Personal access token of the git user (specified by `GIT_USER`), to facilitate non-interactive deployment (e.g. continuous deployment) | +| `CURRENT_BRANCH` | The source branch. Usually, the branch will be `main` or `master`, but it could be any branch except for `gh-pages`. If nothing is set for this variable, then the current branch from which `docusaurus deploy` is invoked will be used. | +| `GIT_USER_NAME` | The `git config user.name` value to use when pushing to the deployment repo | +| `GIT_USER_EMAIL` | The `git config user.email` value to use when pushing to the deployment repo | + +GitHub enterprise installations should work in the same manner as github.com; you only need to set the organization's GitHub Enterprise host as an environment variable: + +| Name | Description | +| ------------- | ----------------------------------------------- | +| `GITHUB_HOST` | The domain name of your GitHub enterprise site. | +| `GITHUB_PORT` | The port of your GitHub enterprise site. | + +### Deploy {#deploy} + +Finally, to deploy your site to GitHub Pages, run: + +```mdx-code-block +<Tabs> +<TabItem value="bash" label="Bash"> +``` + +```bash +GIT_USER=<GITHUB_USERNAME> yarn deploy +``` + +```mdx-code-block +</TabItem> +<TabItem value="windows" label="Windows"> +``` + +```batch +cmd /C "set "GIT_USER=<GITHUB_USERNAME>" && yarn deploy" +``` + +```mdx-code-block +</TabItem> +<TabItem value="powershell" label="PowerShell"> +``` + +```powershell +cmd /C 'set "GIT_USER=<GITHUB_USERNAME>" && yarn deploy' +``` + +```mdx-code-block +</TabItem> +</Tabs> +``` + +:::warning + +Beginning in August 2021, GitHub requires every command-line sign-in to use the **personal access token** instead of the password. When GitHub prompts for your password, enter the PAT instead. See the [GitHub documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) for more information. + +Alternatively, you can use SSH (`USE_SSH=true`) to log in. + +::: + +### Triggering deployment with GitHub Actions {#triggering-deployment-with-github-actions} + +[GitHub Actions](https://help.github.com/en/actions) allow you to automate, customize, and execute your software development workflows right in your repository. + +The workflow examples below assume your website source resides in the `main` branch of your repository (the _source branch_ is `main`), and your [publishing source](https://help.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) is configured for [publishing with a custom GitHub Actions Workflow](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow). + +Our goal is that: + +1. When a new pull request is made to `main`, there's an action that ensures the site builds successfully, without actually deploying. This job will be called `test-deploy`. +2. When a pull request is merged to the `main` branch or someone pushes to the `main` branch directly, it will be built and deployed to GitHub Pages. This job will be called `deploy`. + +Here are two approaches to deploying your docs with GitHub Actions. Based on the location of your deployment repository, choose the relevant tab below: + +- Source repo and deployment repo are the **same** repository. +- The deployment repo is a **remote** repository, different from the source. Instructions for this scenario assume [publishing source](https://help.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) is the `gh-pages` branch. + +```mdx-code-block +<Tabs> +<TabItem value="same" label="Same"> +``` + +While you can have both jobs defined in the same workflow file, the original `deploy` workflow will always be listed as skipped in the PR check suite status, which is not indicative of the actual status and provides no value to the review process. We therefore propose to manage them as separate workflows instead. + +<details> +<summary>GitHub action files</summary> + +Add these two workflow files: + +:::warning Tweak the parameters for your setup + +If your Docusaurus project is not at the root of your repo, you may need to configure a [default working directory](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-set-the-default-shell-and-working-directory), and adjust the paths accordingly. + +::: + +<Tabs> + <TabItem value="npm" label="npm"> + +```yml title=".github/workflows/deploy.yml" +name: Deploy to GitHub Pages + +on: + push: + branches: + - main + # Review gh actions docs if you want to further define triggers, paths, etc + # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on + +jobs: + build: + name: Build Docusaurus + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: npm + + - name: Install dependencies + run: npm ci + - name: Build website + run: npm run build + + - name: Upload Build Artifact + uses: actions/upload-pages-artifact@v3 + with: + path: build + + deploy: + name: Deploy to GitHub Pages + needs: build + + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + + # Deploy to the github-pages environment + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 +``` + +```yml title=".github/workflows/test-deploy.yml" +name: Test deployment + +on: + pull_request: + branches: + - main + # Review gh actions docs if you want to further define triggers, paths, etc + # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on + +jobs: + test-deploy: + name: Test deployment + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: npm + + - name: Install dependencies + run: npm ci + - name: Test build website + run: npm run build +``` + + </TabItem> + <TabItem value="yarn" label="Yarn"> + +```yml title=".github/workflows/deploy.yml" +name: Deploy to GitHub Pages + +on: + push: + branches: + - main + # Review gh actions docs if you want to further define triggers, paths, etc + # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on + +jobs: + build: + name: Build Docusaurus + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: yarn + + - name: Install dependencies + run: yarn install --frozen-lockfile + - name: Build website + run: yarn build + + - name: Upload Build Artifact + uses: actions/upload-pages-artifact@v3 + with: + path: build + + deploy: + name: Deploy to GitHub Pages + needs: build + + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + + # Deploy to the github-pages environment + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 +``` + +```yml title=".github/workflows/test-deploy.yml" +name: Test deployment + +on: + pull_request: + branches: + - main + # Review gh actions docs if you want to further define triggers, paths, etc + # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on + +jobs: + test-deploy: + name: Test deployment + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: yarn + + - name: Install dependencies + run: yarn install --frozen-lockfile + - name: Test build website + run: yarn build +``` + + </TabItem> +</Tabs> + +</details> + +```mdx-code-block +</TabItem> +<TabItem value="remote" label="Remote"> +``` + +A cross-repo publish is more difficult to set up because you need to push to another repo with permission checks. We will be using SSH to do the authentication. + +1. Generate a new [SSH key](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). Since this SSH key will be used in CI, make sure to not enter any passphrase. +2. By default, your public key should have been created in `~/.ssh/id_rsa.pub`; otherwise, use the name you've provided in the previous step to add your key to [GitHub deploy keys](https://developer.github.com/v3/guides/managing-deploy-keys/). +3. Copy the key to clipboard with `pbcopy < ~/.ssh/id_rsa.pub` and paste it as a [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) in the deployment repository. Copy the file content if the command line doesn't work for you. Check the box for `Allow write access` before saving your deployment key. +4. You'll need your private key as a [GitHub secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) to allow Docusaurus to run the deployment for you. +5. Copy your private key with `pbcopy < ~/.ssh/id_rsa` and paste a GitHub secret with the name `GH_PAGES_DEPLOY` on your source repository. Copy the file content if the command line doesn't work for you. Save your secret. +6. Create your [documentation workflow](https://docs.github.com/en/actions/use-cases-and-examples/creating-an-example-workflow) in the `.github/workflows/` directory. In this example it's the `deploy.yml` file. + +At this point, you should have: + +- the source repo with the GitHub workflow set with the private SSH key as the GitHub Secret, and +- your deployment repo set with the public SSH key in GitHub Deploy Keys. + +<details> + +<summary>GitHub action file</summary> + +:::warning + +Please make sure that you replace `actions@github.com` with your GitHub email and `gh-actions` with your name. + +This file assumes you are using Yarn. If you use npm, change `cache: yarn`, `yarn install --frozen-lockfile`, `yarn build` to `cache: npm`, `npm ci`, `npm run build` accordingly. + +::: + +```yml title=".github/workflows/deploy.yml" +name: Deploy to GitHub Pages + +on: + pull_request: + branches: [main] + push: + branches: [main] + +permissions: + contents: write + +jobs: + test-deploy: + if: github.event_name != 'push' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: yarn + - name: Install dependencies + run: yarn install --frozen-lockfile + - name: Test build website + run: yarn build + deploy: + if: github.event_name != 'pull_request' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: yarn + - uses: webfactory/ssh-agent@v0.5.0 + with: + ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }} + - name: Deploy to GitHub Pages + env: + USE_SSH: true + run: | + git config --global user.email "actions@github.com" + git config --global user.name "gh-actions" + yarn install --frozen-lockfile + yarn deploy +``` + +</details> + +```mdx-code-block +</TabItem> +</Tabs> +``` + +<details> + +<summary>Site not deployed properly?</summary> + +After pushing to main, if you don't see your site published at the desired location (for example, it says "There isn't a GitHub Pages site here", or it's showing your repo's README.md file), try the following: + +- Wait about three minutes and refresh. It may take a few minutes for GitHub pages to pick up the new files. +- Check your repo's landing page for a little green tick next to the last commit's title, indicating the CI has passed. If you see a cross, it means the build or deployment failed, and you should check the log for more debugging information. +- Click on the tick and make sure you see a "Deploy to GitHub Pages" workflow. Names like "pages build and deployment / deploy" are GitHub's default workflows, indicating your custom deployment workflow failed to be triggered at all. Make sure the YAML files are placed under the `.github/workflows` folder, and that the trigger condition is set correctly (e.g., if your default branch is "master" instead of "main", you need to change the `on.push` property). +- Under your repo's Settings > Pages, make sure the "Source" (which is the source for the _deployment_ files, not "source" as in our terminology) is set to "gh-pages" + "/ (root)", since we are using `gh-pages` as the deployment branch. + +If you are using a custom domain: + +- Verify that you have the correct DNS records set up if you're using a custom domain. See [GitHub pages documentation on configuring custom domains](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages). Also, please be aware that it may take up to 24 hours for DNS changes to propagate through the internet. + +</details> + +### Triggering deployment with Travis CI {#triggering-deployment-with-travis-ci} + +Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to npm, and deploying changes to your website. All you need to do to automate the deployment of your website is to invoke the `yarn deploy` script whenever your website is updated. The following section covers how to do just that using [Travis CI](https://travis-ci.com/), a popular continuous integration service provider. + +1. Go to https://github.com/settings/tokens and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/). When creating the token, grant it the `repo` scope so that it has the permissions it needs. +2. Using your GitHub account, [add the Travis CI app](https://github.com/marketplace/travis-ci) to the repository you want to activate. +3. Open your Travis CI dashboard. The URL looks like `https://travis-ci.com/USERNAME/REPO`, and navigate to the `More options > Setting > Environment Variables` section of your repository. +4. Create a new environment variable named `GH_TOKEN` with your newly generated token as its value, then `GH_EMAIL` (your email address) and `GH_NAME` (your GitHub username). +5. Create a `.travis.yml` on the root of your repository with the following: + +```yml title=".travis.yml" +language: node_js +node_js: + - 20 +branches: + only: + - main +cache: + yarn: true +script: + - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - yarn install + - GIT_USER="${GH_NAME}" yarn deploy +``` + +Now, whenever a new commit lands in `main`, Travis CI will run your suite of tests and if everything passes, your website will be deployed via the `yarn deploy` script. + +### Triggering deployment with Buddy {#triggering-deployment-with-buddy} + +[Buddy](https://buddy.works/) is an easy-to-use CI/CD tool that allows you to automate the deployment of your portal to different environments, including GitHub Pages. + +Follow these steps to create a pipeline that automatically deploys a new version of your website whenever you push changes to the selected branch of your project: + +1. Go to https://github.com/settings/tokens and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/). When creating the token, grant it the `repo` scope so that it has the permissions it needs. +2. Sign in to your Buddy account and create a new project. +3. Choose GitHub as your git hosting provider and select the repository with the code of your website. +4. Using the left navigation panel, switch to the `Pipelines` view. +5. Create a new pipeline. Define its name, set the trigger mode to `On push`, and select the branch that triggers the pipeline execution. +6. Add a `Node.js` action. +7. Add these commands in the action's terminal: + +```bash +GIT_USER=<GH_PERSONAL_ACCESS_TOKEN> +git config --global user.email "<YOUR_GH_EMAIL>" +git config --global user.name "<YOUR_GH_USERNAME>" +yarn deploy +``` + +After creating this simple pipeline, each new commit pushed to the branch you selected deploys your website to GitHub Pages using `yarn deploy`. Read [this guide](https://buddy.works/guides/react-docusaurus) to learn more about setting up a CI/CD pipeline for Docusaurus. + +### Using Azure Pipelines {#using-azure-pipelines} + +1. Sign Up at [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) if you haven't already. +2. Create an organization. Within the organization, create a project and connect your repository from GitHub. +3. Go to https://github.com/settings/tokens and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) with the `repo` scope. +4. In the project page (which looks like `https://dev.azure.com/ORG_NAME/REPO_NAME/_build`), create a new pipeline with the following text. Also, click on edit and add a new environment variable named `GH_TOKEN` with your newly generated token as its value, then `GH_EMAIL` (your email address) and `GH_NAME` (your GitHub username). Make sure to mark them as secret. Alternatively, you can also add a file named `azure-pipelines.yml` at your repository root. + +```yml title="azure-pipelines.yml" +trigger: + - main + +pool: + vmImage: ubuntu-latest + +steps: + - checkout: self + persistCredentials: true + + - task: NodeTool@0 + inputs: + versionSpec: '20' + displayName: Install Node.js + + - script: | + git config --global user.name "${GH_NAME}" + git config --global user.email "${GH_EMAIL}" + git checkout -b main + echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + yarn install + GIT_USER="${GH_NAME}" yarn deploy + env: + GH_NAME: $(GH_NAME) + GH_EMAIL: $(GH_EMAIL) + GH_TOKEN: $(GH_TOKEN) + displayName: Install and build +``` + +### Using Drone {#using-drone} + +1. Create a new SSH key that will be the [deploy key](https://docs.github.com/en/free-pro-team@latest/developers/overview/managing-deploy-keys#deploy-keys) for your project. +2. Name your private and public keys to be specific and so that it does not overwrite your other [SSH keys](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). +3. Go to `https://github.com/USERNAME/REPO/settings/keys` and add a new deploy key by pasting in the public key you just generated. +4. Open your Drone.io dashboard and log in. The URL looks like `https://cloud.drone.io/USERNAME/REPO`. +5. Click on the repository, click on activate repository, and add a secret called `git_deploy_private_key` with your private key value that you just generated. +6. Create a `.drone.yml` on the root of your repository with the below text. + +```yml title=".drone.yml" +kind: pipeline +type: docker +trigger: + event: + - tag +- name: Website + image: node + commands: + - mkdir -p $HOME/.ssh + - ssh-keyscan -t rsa github.com >> $HOME/.ssh/known_hosts + - echo "$GITHUB_PRIVATE_KEY" > "$HOME/.ssh/id_rsa" + - chmod 0600 $HOME/.ssh/id_rsa + - cd website + - yarn install + - yarn deploy + environment: + USE_SSH: true + GITHUB_PRIVATE_KEY: + from_secret: git_deploy_private_key +``` + +Now, whenever you push a new tag to GitHub, this trigger will start the drone CI job to publish your website. + +## Deploying to Flightcontrol {#deploying-to-flightcontrol} + +[Flightcontrol](https://www.flightcontrol.dev/?ref=docusaurus) is a service that automatically builds and deploys your web apps to AWS Fargate directly from your Git repository. It gives you full access to inspect and make infrastructure changes without the limitations of a traditional PaaS. + +Get started by following [Flightcontrol's step-by-step Docusaurus guide](https://www.flightcontrol.dev/docs/reference/examples/docusaurus/?ref=docusaurus). + +## Deploying to Koyeb {#deploying-to-koyeb} + +[Koyeb](https://www.koyeb.com) is a developer-friendly serverless platform to deploy apps globally. The platform lets you seamlessly run Docker containers, web apps, and APIs with git-based deployment, native autoscaling, a global edge network, and built-in service mesh and discovery. Check out the [Koyeb's Docusaurus deployment guide](https://www.koyeb.com/tutorials/deploy-docusaurus-on-koyeb) to get started. + +## Deploying to Render {#deploying-to-render} + +[Render](https://render.com) offers [free static site hosting](https://render.com/docs/static-sites) with fully managed SSL, custom domains, a global CDN, and continuous auto-deploy from your Git repo. Get started in just a few minutes by following [Render's guide to deploying Docusaurus](https://render.com/docs/deploy-docusaurus). + +## Deploying to Qovery {#deploying-to-qovery} + +[Qovery](https://www.qovery.com) is a fully-managed cloud platform that runs on your AWS, Digital Ocean, and Scaleway account where you can host static sites, backend APIs, databases, cron jobs, and all your other apps in one place. + +1. Create a Qovery account. Visit the [Qovery dashboard](https://console.qovery.com) to create an account if you don't already have one. +2. Create a project. + - Click on **Create project** and give a name to your project. + - Click on **Next**. +3. Create a new environment. + - Click on **Create environment** and give a name (e.g. staging, production). +4. Add an application. + - Click on **Create an application**, give a name and select your GitHub or GitLab repository where your Docusaurus app is located. + - Define the main branch name and the root application path. + - Click on **Create**. After the application is created: + - Navigate to your application **Settings** + - Select **Port** + - Add port used by your Docusaurus application +5. Deploy + - All you have to do now is to navigate to your application and click on **Deploy**. + +![Deploy the app](https://hub.qovery.com/img/heroku/heroku-1.png) + +That's it. Watch the status and wait till the app is deployed. To open the application in your browser, click on **Action** and **Open** in your application overview. + +## Deploying to Hostman {#deploying-to-hostman} + +[Hostman](https://hostman.com/) allows you to host static websites for free. Hostman automates everything, you just need to connect your repository and follow these easy steps: + +1. Create a service. + + - To deploy a Docusaurus static website, click **Create** in the top-left corner of your [Dashboard](https://dashboard.hostman.com/) and choose **Front-end app or static website**. + +2. Select the project to deploy. + + - If you are logged in to Hostman with your GitHub, GitLab, or Bitbucket account, you will see the repository with your projects, including the private ones. + + - Choose the project you want to deploy. It must contain the directory with the project's files (e.g. `website`). + + - To access a different repository, click **Connect another repository**. + + - If you didn't use your Git account credentials to log in, you'll be able to access the necessary account now, and then select the project. + +3. Configure the build settings. + + - Next, the **Website customization** window will appear. Choose the **Static website** option from the list of frameworks. + + - The **Directory with app** points at the directory that will contain the project's files after the build. If you selected the repository with the contents of the website (or `my_website`) directory during Step 2, you can leave it empty. + + - The standard build command for Docusaurus is: + + ```bash npm2yarn + npm run build + ``` + + - You can modify the build command if needed. You can enter multiple commands separated by `&&`. + +4. Deploy. + + - Click **Deploy** to start the build process. + + - Once it starts, you will enter the deployment log. If there are any issues with the code, you will get warning or error messages in the log specifying the cause of the problem. Usually, the log contains all the debugging data you'll need. + + - When the deployment is complete, you will receive an email notification and also see a log entry. All done! Your project is up and ready. + +## Deploying to Surge {#deploying-to-surge} + +Surge is a [static web hosting platform](https://surge.sh/help/getting-started-with-surge) that you can use to deploy your Docusaurus project from the command line in seconds. Deploying your project to Surge is easy and free (including custom domains and SSL certs). + +Deploy your app in a matter of seconds using Surge with the following steps: + +1. First, install Surge using npm by running the following command: + ```bash npm2yarn + npm install -g surge + ``` +2. To build the static files of your site for production in the root directory of your project, run: + ```bash npm2yarn + npm run build + ``` +3. Then, run this command inside the root directory of your project: + ```bash + surge build/ + ``` + +First-time users of Surge would be prompted to create an account from the command line (which happens only once). + +Confirm that the site you want to publish is in the `build` directory. A randomly generated subdomain `*.surge.sh subdomain` is always given (which can be edited). + +### Using your domain {#using-your-domain} + +If you have a domain name you can deploy your site using the command: + +```bash +surge build/ your-domain.com +``` + +Your site is now deployed for free at `subdomain.surge.sh` or `your-domain.com` depending on the method you chose. + +### Setting up CNAME file {#setting-up-cname-file} + +Store your domain in a CNAME file for future deployments with the following command: + +```bash +echo subdomain.surge.sh > CNAME +``` + +You can deploy any other changes in the future with the command `surge`. + +## Deploying to Stormkit {#deploying-to-stormkit} + +You can deploy your Docusaurus project to [Stormkit](https://www.stormkit.io), a deployment platform for static websites, single-page applications (SPAs), and serverless functions. For detailed instructions, refer to this [guide](https://www.stormkit.io/blog/how-to-deploy-docusarous). + +## Deploying to QuantCDN {#deploying-to-quantcdn} + +1. Install [Quant CLI](https://docs.quantcdn.io/docs/cli/get-started) +2. Create a QuantCDN account by [signing up](https://dashboard.quantcdn.io/register) +3. Initialize your project with `quant init` and fill in your credentials: + ```bash + quant init + ``` +4. Deploy your site. + ```bash + quant deploy + ``` + +See [docs](https://docs.quantcdn.io/docs/cli/continuous-integration) and [blog](https://www.quantcdn.io/blog) for more examples and use cases for deploying to QuantCDN. + +## Deploying to Cloudflare Pages {#deploying-to-cloudflare-pages} + +[Cloudflare Pages](https://pages.cloudflare.com/) is a Jamstack platform for frontend developers to collaborate and deploy websites. Get started within a few minutes by following [this page](https://developers.cloudflare.com/pages/framework-guides/deploy-a-docusaurus-site/). + +## Deploying to Azure Static Web Apps {#deploying-to-azure-static-web-apps} + +[Azure Static Web Apps](https://docs.microsoft.com/en-us/azure/static-web-apps/overview) is a service that automatically builds and deploys full-stack web apps to Azure directly from the code repository, simplifying the developer experience for CI/CD. Static Web Apps separates the web application's static assets from its dynamic (API) endpoints. Static assets are served from globally-distributed content servers, making it faster for clients to retrieve files using servers nearby. Dynamic APIs are scaled with serverless architectures using an event-driven functions-based approach that is more cost-effective and scales on demand. Get started in a few minutes by following [this step-by-step guide](https://dev.to/azure/11-share-content-with-docusaurus-azure-static-web-apps-30hc). + +## Deploying to Kinsta {#deploying-to-kinsta} + +[Kinsta Static Site Hosting](https://kinsta.com/static-site-hosting) lets you deploy up to 100 static sites for free, custom domains with SSL, 100 GB monthly bandwidth, and 260+ Cloudflare CDN locations. + +Get started in just a few clicks by following our [Docusaurus on Kinsta](https://kinsta.com/docs/docusaurus-example/) article. diff --git a/website/versioned_docs/version-3.9.2/docusaurus-core.mdx b/website/versioned_docs/version-3.9.2/docusaurus-core.mdx new file mode 100644 index 0000000000..63f0f4ddd7 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/docusaurus-core.mdx @@ -0,0 +1,770 @@ +--- +sidebar_label: Client API +--- + +# Docusaurus Client API + +Docusaurus provides some APIs on the clients that can be helpful to you when building your site. + +## Components {#components} + +### `<ErrorBoundary />` {#errorboundary} + +This component creates a [React error boundary](https://reactjs.org/docs/error-boundaries.html). + +Use it to wrap components that might throw, and display a fallback when that happens instead of crashing the whole app. + +```jsx +import React from 'react'; +import ErrorBoundary from '@docusaurus/ErrorBoundary'; + +const SafeComponent = () => ( + <ErrorBoundary + fallback={({error, tryAgain}) => ( + <div> + <p>This component crashed because of error: {error.message}.</p> + <button onClick={tryAgain}>Try Again!</button> + </div> + )}> + <SomeDangerousComponentThatMayThrow /> + </ErrorBoundary> +); +``` + +```mdx-code-block +import ErrorBoundaryTestButton from '@site/src/components/ErrorBoundaryTestButton' +``` + +:::tip + +To see it in action, click here: <ErrorBoundaryTestButton/> + +::: + +:::info + +Docusaurus uses this component to catch errors within the theme's layout, and also within the entire app. + +::: + +:::note + +This component doesn't catch build-time errors and only protects against client-side render errors that can happen when using stateful React components. + +::: + +#### Props {#errorboundary-props} + +- `fallback`: an optional render callback returning a JSX element. It will receive an object with 2 attributes: `error`, the error that was caught, and `tryAgain`, a function (`() => void`) callback to reset the error in the component and try rendering it again. If not present, `@theme/Error` will be rendered instead. `@theme/Error` is used for the error boundaries wrapping the site, above the layout. + +:::warning + +The `fallback` prop is a callback, and **not a React functional component**. You can't use React hooks inside this callback. + +::: + +### `<Head/>` {#head} + +This reusable React component will manage all of your changes to the document head. It takes plain HTML tags and outputs plain HTML tags and is beginner-friendly. It is a wrapper around [React Helmet](https://github.com/nfl/react-helmet). + +Usage Example: + +```jsx +import React from 'react'; +// highlight-next-line +import Head from '@docusaurus/Head'; + +const MySEO = () => ( + // highlight-start + <Head> + <meta property="og:description" content="My custom description" /> + <meta charSet="utf-8" /> + <title>My Title + + + // highlight-end +); +``` + +Nested or latter components will override duplicate usages: + +```jsx + + {/* highlight-start */} + + My Title + + + {/* highlight-end */} + + {/* highlight-start */} + + Nested Title + + + {/* highlight-end */} + + +``` + +Outputs: + +```html + + Nested Title + + +``` + +### `` {#link} + +This component enables linking to internal pages as well as a powerful performance feature called preloading. Preloading is used to prefetch resources so that the resources are fetched by the time the user navigates with this component. We use an `IntersectionObserver` to fetch a low-priority request when the `` is in the viewport and then use an `onMouseOver` event to trigger a high-priority request when it is likely that a user will navigate to the requested resource. + +The component is a wrapper around react-router’s `` component that adds useful enhancements specific to Docusaurus. All props are passed through to react-router’s `` component. + +External links also work, and automatically have these props: `target="_blank" rel="noopener noreferrer"`. + +```jsx +import React from 'react'; +// highlight-next-line +import Link from '@docusaurus/Link'; + +const Page = () => ( +
    +

    + {/* highlight-next-line */} + Check out my blog! +

    +

    + {/* highlight-next-line */} + Follow me on X! +

    +
    +); +``` + +#### `to`: string {#to-string} + +The target location to navigate to. Example: `/docs/introduction`. + +```jsx + +``` + +:::tip + +Prefer this component to vanilla `` tags because Docusaurus does a lot of optimizations (e.g. broken path detection, prefetching, applying base URL...) if you use ``. + +::: + +### `` {#redirect} + +Rendering a `` will navigate to a new location. The new location will override the current location in the history stack like server-side redirects (HTTP 3xx) do. You can refer to [React Router's Redirect documentation](https://reacttraining.com/react-router/web/api/Redirect) for more info on available props. + +Example usage: + +```jsx +import React from 'react'; +// highlight-next-line +import {Redirect} from '@docusaurus/router'; + +const Home = () => { + // highlight-next-line + return ; +}; +``` + +:::note + +`@docusaurus/router` implements [React Router](https://reacttraining.com/react-router/web/guides/quick-start) and supports its features. + +::: + +### `` {#browseronly} + +The `` component permits to render React components only in the browser after the React app has hydrated. + +:::tip + +Use it for integrating with code that can't run in Node.js, because the `window` or `document` objects are being accessed. + +::: + +#### Props {#browseronly-props} + +- `children`: render function prop returning browser-only JSX. Will not be executed in Node.js +- `fallback` (optional): JSX to render on the server (Node.js) and until React hydration completes. + +#### Example with code {#browseronly-example-code} + +```jsx +// highlight-start +import BrowserOnly from '@docusaurus/BrowserOnly'; +// highlight-end + +const MyComponent = () => { + return ( + // highlight-start + + {() => page url = {window.location.href}} + + // highlight-end + ); +}; +``` + +#### Example with a library {#browseronly-example-library} + +```jsx +// highlight-start +import BrowserOnly from '@docusaurus/BrowserOnly'; +// highlight-end + +const MyComponent = (props) => { + return ( + // highlight-start + Loading...
    }> + {() => { + const LibComponent = require('some-lib').LibComponent; + return ; + }} + + // highlight-end + ); +}; +``` + +### `` {#interpolate} + +A simple interpolation component for text containing dynamic placeholders. + +The placeholders will be replaced with the provided dynamic values and JSX elements of your choice (strings, links, styled elements...). + +#### Props {#interpolate-props} + +- `children`: text containing interpolation placeholders like `{placeholderName}` +- `values`: object containing interpolation placeholder values + +```jsx +import React from 'react'; +import Link from '@docusaurus/Link'; +import Interpolate from '@docusaurus/Interpolate'; + +export default function VisitMyWebsiteMessage() { + return ( + // highlight-start + + website + + ), + }}> + {'Hello, {firstName}! How are you? Take a look at my {website}'} + + // highlight-end + ); +} +``` + +### `` {#translate} + +When [localizing your site](./i18n/i18n-introduction.mdx), the `` component will allow providing **translation support to React components**, such as your homepage. The `` component supports [interpolation](#interpolate). + +The translation strings will statically extracted from your code with the [`docusaurus write-translations`](./cli.mdx#docusaurus-write-translations-sitedir) CLI and a `code.json` translation file will be created in `website/i18n/[locale]`. + +:::note + +The `` props **must be hardcoded strings**. + +Apart from the `values` prop used for interpolation, it is **not possible to use variables**, or the static extraction wouldn't work. + +::: + +#### Props {#translate-props} + +- `children`: untranslated string in the default site locale (can contain [interpolation placeholders](#interpolate)) +- `id`: optional value to be used as the key in JSON translation files +- `description`: optional text to help the translator +- `values`: optional object containing interpolation placeholder values + +#### Example {#example} + +```jsx title="src/pages/index.js" +import React from 'react'; +import Layout from '@theme/Layout'; + +// highlight-start +import Translate from '@docusaurus/Translate'; +// highlight-end + +export default function Home() { + return ( + +

    + {/* highlight-start */} + + Welcome to my website + + {/* highlight-end */} +

    +
    + {/* highlight-start */} + + {'Welcome, {firstName}! How are you?'} + + {/* highlight-end */} +
    +
    + ); +} +``` + +:::note + +You can even omit the children prop and specify a translation string in your `code.json` file manually after running the `docusaurus write-translations` CLI command. + +```jsx + +``` + +::: + +:::info + +The `` component supports interpolation. You can also implement [string pluralization](https://github.com/facebook/docusaurus/pull/i18n/i18n-tutorial.mdx#pluralization) through some custom code and the [`translate` imperative API](#translate-imperative). + +::: + +## Hooks {#hooks} + +### `useDocusaurusContext` {#useDocusaurusContext} + +React hook to access Docusaurus Context. The context contains the `siteConfig` object from [docusaurus.config.js](api/docusaurus.config.js.mdx) and some additional site metadata. + +```ts +type PluginVersionInformation = + | {readonly type: 'package'; readonly version?: string} + | {readonly type: 'project'} + | {readonly type: 'local'} + | {readonly type: 'synthetic'}; + +type SiteMetadata = { + readonly docusaurusVersion: string; + readonly siteVersion?: string; + readonly pluginVersions: Record; +}; + +type I18nLocaleConfig = { + label: string; + direction: string; +}; + +type I18n = { + defaultLocale: string; + locales: [string, ...string[]]; + currentLocale: string; + localeConfigs: Record; +}; + +type DocusaurusContext = { + siteConfig: DocusaurusConfig; + siteMetadata: SiteMetadata; + globalData: Record; + i18n: I18n; + codeTranslations: Record; +}; +``` + +Usage example: + +```jsx +import React from 'react'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; + +const MyComponent = () => { + // highlight-next-line + const {siteConfig, siteMetadata} = useDocusaurusContext(); + return ( +
    + {/* highlight-start */} +

    {siteConfig.title}

    +
    {siteMetadata.siteVersion}
    +
    {siteMetadata.docusaurusVersion}
    + {/* highlight-end */} +
    + ); +}; +``` + +:::note + +The `siteConfig` object only contains **serializable values** (values that are preserved after `JSON.stringify()`). Functions, regexes, etc. would be lost on the client side. + +::: + +### `useIsBrowser` {#useIsBrowser} + +Returns `true` when the React app has successfully hydrated in the browser. + +:::warning + +Use this hook instead of `typeof windows !== 'undefined'` in React rendering logic. + +The first client-side render output (in the browser) **must be exactly the same** as the server-side render output (Node.js). Not following this rule can lead to unexpected hydration behaviors, as described in [The Perils of Rehydration](https://www.joshwcomeau.com/react/the-perils-of-rehydration/). + +::: + +Usage example: + +```jsx +import React from 'react'; +import useIsBrowser from '@docusaurus/useIsBrowser'; + +const MyComponent = () => { + // highlight-start + const isBrowser = useIsBrowser(); + // highlight-end + return
    {isBrowser ? 'Client' : 'Server'}
    ; +}; +``` + +### `useBaseUrl` {#useBaseUrl} + +React hook to prepend your site `baseUrl` to a string. + +:::warning + +**Don't use it for regular links!** + +The `/baseUrl/` prefix is automatically added to all **absolute paths** by default: + +- Markdown: `[link](/my/path)` will link to `/baseUrl/my/path` +- React: `link` will link to `/baseUrl/my/path` + +::: + +#### Options {#options} + +```ts +type BaseUrlOptions = { + forcePrependBaseUrl: boolean; + absolute: boolean; +}; +``` + +#### Example usage: {#example-usage} + +```jsx +import React from 'react'; +import useBaseUrl from '@docusaurus/useBaseUrl'; + +const SomeImage = () => { + // highlight-start + const imgSrc = useBaseUrl('/img/myImage.png'); + // highlight-end + return ; +}; +``` + +:::tip + +In most cases, you don't need `useBaseUrl`. + +Prefer a `require()` call for [assets](./guides/markdown-features/markdown-features-assets.mdx): + +```jsx + +``` + +::: + +### `useBaseUrlUtils` {#useBaseUrlUtils} + +Sometimes `useBaseUrl` is not good enough. This hook return additional utils related to your site's base URL. + +- `withBaseUrl`: useful if you need to add base URLs to multiple URLs at once. + +```jsx +import React from 'react'; +import {useBaseUrlUtils} from '@docusaurus/useBaseUrl'; + +const Component = () => { + const urls = ['/a', '/b']; + // highlight-start + const {withBaseUrl} = useBaseUrlUtils(); + const urlsWithBaseUrl = urls.map(withBaseUrl); + // highlight-end + return
    {/* ... */}
    ; +}; +``` + +### `useGlobalData` {#useGlobalData} + +React hook to access Docusaurus global data created by all the plugins. + +Global data is namespaced by plugin name then by plugin ID. + +:::info + +Plugin ID is only useful when a plugin is used multiple times on the same site. Each plugin instance is able to create its own global data. + +::: + +```ts +type GlobalData = Record< + PluginName, + Record< + PluginId, // "default" by default + any // plugin-specific data + > +>; +``` + +Usage example: + +```jsx +import React from 'react'; +// highlight-next-line +import useGlobalData from '@docusaurus/useGlobalData'; + +const MyComponent = () => { + // highlight-start + const globalData = useGlobalData(); + const myPluginData = globalData['my-plugin']['default']; + return
    {myPluginData.someAttribute}
    ; + // highlight-end +}; +``` + +:::tip + +Inspect your site's global data at `.docusaurus/globalData.json` + +::: + +### `usePluginData` {#usePluginData} + +Access global data created by a specific plugin instance. + +This is the most convenient hook to access plugin global data and should be used most of the time. + +`pluginId` is optional if you don't use multi-instance plugins. + +```ts +function usePluginData( + pluginName: string, + pluginId?: string, + options?: {failfast?: boolean}, +); +``` + +Usage example: + +```jsx +import React from 'react'; +// highlight-next-line +import {usePluginData} from '@docusaurus/useGlobalData'; + +const MyComponent = () => { + // highlight-start + const myPluginData = usePluginData('my-plugin'); + return
    {myPluginData.someAttribute}
    ; + // highlight-end +}; +``` + +### `useAllPluginInstancesData` {#useAllPluginInstancesData} + +Access global data created by a specific plugin. Given a plugin name, it returns the data of all the plugins instances of that name, by plugin id. + +```ts +function useAllPluginInstancesData( + pluginName: string, + options?: {failfast?: boolean}, +); +``` + +Usage example: + +```jsx +import React from 'react'; +// highlight-next-line +import {useAllPluginInstancesData} from '@docusaurus/useGlobalData'; + +const MyComponent = () => { + // highlight-start + const allPluginInstancesData = useAllPluginInstancesData('my-plugin'); + const myPluginData = allPluginInstancesData['default']; + return
    {myPluginData.someAttribute}
    ; + // highlight-end +}; +``` + +### `useBrokenLinks` {#useBrokenLinks} + +React hook to access the Docusaurus broken link checker APIs, exposing a way for a Docusaurus pages to report and collect their links and anchors. + +:::warning + +This is an **advanced** API that **most Docusaurus users don't need to use directly**. + +It is already **built-in** in existing high-level components: + +- the [``](#link) component will collect links for you +- the `@theme/Heading` (used for Markdown headings) will collect anchors + +Use `useBrokenLinks()` if you implement your own `` or `` component. + +::: + +Usage example: + +```js title="MyHeading.js" +import useBrokenLinks from '@docusaurus/useBrokenLinks'; + +export default function MyHeading(props) { + useBrokenLinks().collectAnchor(props.id); + return

    ; +} +``` + +```js title="MyLink.js" +import useBrokenLinks from '@docusaurus/useBrokenLinks'; + +export default function MyLink(props) { + useBrokenLinks().collectLink(props.href); + return ; +} +``` + +## Functions {#functions} + +### `interpolate` {#interpolate-1} + +The imperative counterpart of the [``](#interpolate) component. + +#### Signature {#signature} + +```ts +// Simple string interpolation +function interpolate(text: string, values: Record): string; + +// JSX interpolation +function interpolate( + text: string, + values: Record, +): ReactNode; +``` + +#### Example {#example-1} + +```js +// highlight-next-line +import {interpolate} from '@docusaurus/Interpolate'; + +const message = interpolate('Welcome {firstName}', {firstName: 'Sébastien'}); +``` + +### `translate` {#translate-imperative} + +The imperative counterpart of the [``](#translate) component. Also supporting [placeholders interpolation](#interpolate). + +:::tip + +Use the imperative API for the **rare cases** where a **component cannot be used**, such as: + +- the page `title` metadata +- the `placeholder` props of form inputs +- the `aria-label` props for accessibility + +::: + +#### Signature {#signature-1} + +```ts +function translate( + translation: {message: string; id?: string; description?: string}, + values: Record, +): string; +``` + +#### Example {#example-2} + +```jsx title="src/pages/index.js" +import React from 'react'; +import Layout from '@theme/Layout'; + +// highlight-next-line +import {translate} from '@docusaurus/Translate'; + +export default function Home() { + return ( + + + + ); +} +``` + +## Modules {#modules} + +### `ExecutionEnvironment` {#executionenvironment} + +A module that exposes a few boolean variables to check the current rendering environment. + +:::warning + +For React rendering logic, use [`useIsBrowser()`](#useIsBrowser) or [``](#browseronly) instead. + +::: + +Example: + +```js +import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment'; + +if (ExecutionEnvironment.canUseDOM) { + require('lib-that-only-works-client-side'); +} +``` + +| Field | Description | +| --- | --- | +| `ExecutionEnvironment.canUseDOM` | `true` if on client/browser, `false` on Node.js/prerendering. | +| `ExecutionEnvironment.canUseEventListeners` | `true` if on client and has `window.addEventListener`. | +| `ExecutionEnvironment.canUseIntersectionObserver` | `true` if on client and has `IntersectionObserver`. | +| `ExecutionEnvironment.canUseViewport` | `true` if on client and has `window.screen`. | + +### `constants` {#constants} + +A module exposing useful constants to client-side theme code. + +```js +import {DEFAULT_PLUGIN_ID} from '@docusaurus/constants'; +``` + +| Named export | Value | +| ------------------- | --------- | +| `DEFAULT_PLUGIN_ID` | `default` | diff --git a/website/versioned_docs/version-3.9.2/guides/creating-pages.mdx b/website/versioned_docs/version-3.9.2/guides/creating-pages.mdx new file mode 100644 index 0000000000..c256716078 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/guides/creating-pages.mdx @@ -0,0 +1,140 @@ +--- +slug: /creating-pages +sidebar_label: Pages +--- + +# Creating Pages + +In this section, we will learn about creating pages in Docusaurus. + +The `@docusaurus/plugin-content-pages` plugin empowers you to create **one-off standalone pages** like a showcase page, playground page, or support page. You can use React components, or Markdown. + +:::note + +Pages do not have sidebars, only [docs](./docs/docs-introduction.mdx) do. + +::: + +:::info + +Check the [Pages Plugin API Reference documentation](./../api/plugins/plugin-content-pages.mdx) for an exhaustive list of options. + +::: + +## Add a React page {#add-a-react-page} + +React is used as the UI library to create pages. Every page component should export a React component, and you can leverage the expressiveness of React to build rich and interactive content. + +Create a file `/src/pages/helloReact.js`: + +```jsx title="/src/pages/helloReact.js" +import React from 'react'; +import Layout from '@theme/Layout'; + +export default function Hello() { + return ( + +
    +

    + Edit pages/helloReact.js and save to reload. +

    +
    +
    + ); +} +``` + +Once you save the file, the development server will automatically reload the changes. Now open [`http://localhost:3000/helloReact`](http://localhost:3000/helloReact) and you will see the new page you just created. + +Each page doesn't come with any styling. You will need to import the `Layout` component from `@theme/Layout` and wrap your contents within that component if you want the navbar and/or footer to appear. + +:::tip + +You can also create TypeScript pages with the `.tsx` extension (`helloReact.tsx`). + +::: + +## Add a Markdown page {#add-a-markdown-page} + +Create a file `/src/pages/helloMarkdown.md`: + +```md title="/src/pages/helloMarkdown.md" +--- +title: my hello page title +description: my hello page description +hide_table_of_contents: true +--- + +# Hello + +How are you? +``` + +In the same way, a page will be created at [`http://localhost:3000/helloMarkdown`](http://localhost:3000/helloMarkdown). + +Markdown pages are less flexible than React pages because it always uses the theme layout. + +Here's an [example Markdown page](/examples/markdownPageExample). + +:::tip + +You can use the full power of React in Markdown pages too, refer to the [MDX](https://mdxjs.com/) documentation. + +::: + +## Routing {#routing} + +If you are familiar with other static site generators like Jekyll and Next, this routing approach will feel familiar to you. Any JavaScript file you create under `/src/pages/` directory will be automatically converted to a website page, following the `/src/pages/` directory hierarchy. For example: + +- `/src/pages/index.js` → `[baseUrl]` +- `/src/pages/foo.js` → `[baseUrl]/foo` +- `/src/pages/foo/test.js` → `[baseUrl]/foo/test` +- `/src/pages/foo/index.js` → `[baseUrl]/foo/` + +In this component-based development era, it is encouraged to co-locate your styling, markup, and behavior together into components. Each page is a component, and if you need to customize your page design with your own styles, we recommend co-locating your styles with the page component in its own directory. For example, to create a "Support" page, you could do one of the following: + +- Add a `/src/pages/support.js` file +- Create a `/src/pages/support/` directory and a `/src/pages/support/index.js` file. + +The latter is preferred as it has the benefits of letting you put files related to the page within that directory. For example, a CSS module file (`styles.module.css`) with styles meant to only be used on the "Support" page. + +:::note + +This is merely a recommended directory structure, and you will still need to manually import the CSS module file within your component module (`support/index.js`). + +::: + +By default, any Markdown or JavaScript file starting with `_` will be ignored and no routes will be created for that file (see the `exclude` option). + +```bash +my-website +├── src +│ └── pages +│ ├── styles.module.css +│ ├── index.js +│ ├── _ignored.js +│ ├── _ignored-folder +│ │ ├── Component1.js +│ │ └── Component2.js +│ └── support +│ ├── index.js +│ └── styles.module.css +. +``` + +:::warning + +All JavaScript/TypeScript files within the `src/pages/` directory will have corresponding website paths generated for them. If you want to create reusable components into that directory, use the `exclude` option (by default, files prefixed with `_`, test files(`.test.js`), and files in `__tests__` directory are not turned into pages). + +::: + +### Duplicate Routes {#duplicate-routes} + +You may accidentally create multiple pages that are meant to be accessed on the same route. When this happens, Docusaurus will warn you about duplicate routes when you run `yarn start` or `yarn build` (behavior configurable through the [`onDuplicateRoutes`](../api/docusaurus.config.js.mdx#onDuplicateRoutes) config), but the site will still be built successfully. The page that was created last will be accessible, but it will override other conflicting pages. To resolve this issue, you should modify or remove any conflicting routes. diff --git a/website/versioned_docs/version-3.9.2/guides/docs/docs-create-doc.mdx b/website/versioned_docs/version-3.9.2/guides/docs/docs-create-doc.mdx new file mode 100644 index 0000000000..b45cf6d331 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/guides/docs/docs-create-doc.mdx @@ -0,0 +1,202 @@ +--- +id: create-doc +description: Create a Markdown Document +slug: /create-doc +--- + +# Create a doc + +Create a Markdown file, `greeting.md`, and place it under the `docs` directory. + +```bash +website # root directory of your site +├── docs +│ └── greeting.md +├── src +│ └── pages +├── docusaurus.config.js +├── ... +``` + +```md +--- +description: Create a doc page with rich content. +--- + +# Hello from Docusaurus + +Are you ready to create the documentation site for your open source project? + +## Headers + +will show up on the table of contents on the upper right + +So that your users will know what this page is all about without scrolling down or even without reading too much. + +## Only h2 and h3 will be in the TOC by default. + +You can configure the TOC heading levels either per-document or in the theme configuration. + +The headers are well-spaced so that the hierarchy is clear. + +- lists will help you +- present the key points +- that you want your users to remember + - and you may nest them + - multiple times +``` + +:::note + +All files prefixed with an underscore (`_`) under the `docs` directory are treated as "partial" pages and will be ignored by default. + +Read more about [importing partial pages](../markdown-features/markdown-features-react.mdx#importing-markdown). + +::: + +## Doc front matter {#doc-front-matter} + +The [front matter](../markdown-features/markdown-features-intro.mdx#front-matter) is used to provide additional metadata for your doc page. Front matter is optional—Docusaurus will be able to infer all necessary metadata without the front matter. For example, the [doc tags](#doc-tags) feature introduced below requires using front matter. For all possible fields, see [the API documentation](../../api/plugins/plugin-content-docs.mdx#markdown-front-matter). + +## Doc tags {#doc-tags} + +Tags are declared in the front matter and introduce another dimension of categorization in addition to the [docs sidebar](./sidebar/index.mdx). + +It is possible to define tags inline, or to reference predefined tags declared in a [`tags file`](../../api/plugins/plugin-content-docs.mdx#tags-file) (optional, usually `docs/tags.yml`). + +In the following example: + +- `docusaurus` references a predefined tag key declared in `docs/tags.yml` +- `Releases` is an inline tag, because it does not exist in `docs/tags.yml` + +```md title="docs/my-doc.md" +--- +tags: + - Releases + - docusaurus +--- + +# Title + +Content +``` + +```yml title="docs/tags.yml" +docusaurus: + label: 'Docusaurus' + permalink: '/docusaurus' + description: 'Docs related to the Docusaurus framework' +``` + +:::tip + +Tags can also be declared with `tags: [Demo, Getting started]`. + +Read more about all the possible [Yaml array syntaxes](https://www.w3schools.io/file/yaml-arrays/). + +::: + +## Organizing folder structure {#organizing-folder-structure} + +How the Markdown files are arranged under the `docs` folder can have multiple impacts on Docusaurus content generation. However, most of them can be decoupled from the file structure. + +### Document ID {#document-id} + +Every document has a unique `id`. By default, a document `id` is the name of the document (without the extension) relative to the root docs directory. + +For example, the ID of `greeting.md` is `greeting`, and the ID of `guide/hello.md` is `guide/hello`. + +```bash +website # Root directory of your site +└── docs + ├── greeting.md + └── guide + └── hello.md +``` + +However, the **last part** of the `id` can be defined by the user in the front matter. For example, if `guide/hello.md`'s content is defined as below, its final `id` is `guide/part1`. + +```md +--- +id: part1 +--- + +Lorem ipsum +``` + +The ID is used to refer to a document when hand-writing sidebars, or when using docs-related layout components or hooks. + +### Doc URLs {#doc-urls} + +By default, the document's URL location is derived from the [document `id`](#document-id), which in turn is based on the document's file path. + +If a file is named one of the following, the file name won't be included in the URL: + +- Named as `index` (case-insensitive): `docs/Guides/index.md` +- Named as `README` (case-insensitive): `docs/Guides/README.mdx` +- Same name as parent folder: `docs/Guides/Guides.md` + +In all cases, the default `slug` would only be `/Guides`, without the `/index`, `/README`, or duplicate `/Guides` segment. + +:::note + +This convention is exactly the same as [the category index convention](./sidebar/autogenerated.mdx#category-index-convention). However, the `isCategoryIndex` configuration does _not_ affect the document URL. + +::: + +Use the `slug` front matter to provide an explicit document URL and override the default one. + +For example, suppose your site structure looks like this: + +```bash +website # Root directory of your site +└── docs + └── guide + └── hello.md +``` + +By default, `hello.md` will be available at `/docs/guide/hello`. You can change its URL location to `/docs/bonjour`: + +```md +--- +slug: /bonjour +--- + +Lorem ipsum +``` + +`slug` will be appended to the doc plugin's `routeBasePath`, which is `/docs` by default. See [Docs-only mode](docs-introduction.mdx#docs-only-mode) for how to remove the `/docs` part from the URL. + +:::note + +It is possible to use: + +- absolute slugs: `slug: /mySlug`, `slug: /`... +- relative slugs: `slug: mySlug`, `slug: ./../mySlug`... + +::: + +:::tip + +Changing a document's filename or `id`, will change its default URL. To prevent breaking permalinks when renaming files, we recommend setting an explicit `slug` to keep your URLs stable. + +::: + +#### Making a document available at the root + +If you want a document to be available at the root, and have a path like `https://docusaurus.io/docs/`, you can use the slug front matter: + +```md +--- +id: my-home-doc +slug: / +--- + +Lorem ipsum +``` + +### Sidebars {#sidebars} + +When using [autogenerated sidebars](./sidebar/autogenerated.mdx), the file structure will determine the sidebar structure. + +Our recommendation for file system organization is: make your file system mirror the sidebar structure (so you don't need to handwrite your `sidebars.js` file), and use the `slug` front matter to customize URLs of each document. diff --git a/website/versioned_docs/version-3.9.2/guides/docs/docs-introduction.mdx b/website/versioned_docs/version-3.9.2/guides/docs/docs-introduction.mdx new file mode 100644 index 0000000000..3892c316be --- /dev/null +++ b/website/versioned_docs/version-3.9.2/guides/docs/docs-introduction.mdx @@ -0,0 +1,120 @@ +--- +id: introduction +sidebar_label: Introduction +slug: /docs-introduction +--- + +# Docs Introduction + +The docs feature provides users with a way to organize Markdown files in a hierarchical format. + +:::info + +Check the [Docs Plugin API Reference documentation](./../../api/plugins/plugin-content-docs.mdx) for an exhaustive list of options. + +::: + +Your site's documentation is organized by four levels, from lowest to highest: + +1. Individual pages. +2. Sidebars. +3. Versions. +4. Plugin instances. + +The guide will introduce them in that order: starting from [how individual pages can be configured](./docs-create-doc.mdx), to [how to create a sidebar or multiple ones](./sidebar/index.mdx), to [how to create and manage versions](./versioning.mdx), to [how to use multiple docs plugin instances](./docs-multi-instance.mdx). + +## Docs-only mode {#docs-only-mode} + +A freshly initialized Docusaurus site has the following structure: + +``` +example.com/ -> generated from `src/pages/index.js` + +example.com/docs/intro -> generated from `docs/intro.md` +example.com/docs/tutorial-basics/... -> generated from `docs/tutorial-basics/...` +... + +example.com/blog/2021/08/26/welcome -> generated from `blog/2021-08-26-welcome/index.md` +example.com/blog/2021/08/01/mdx-blog-post -> generated from `blog/2021-08-01-mdx-blog-post.mdx` +... +``` + +All docs will be served under the subroute `docs/`. But what if **your site only has docs**, or you want to prioritize your docs by putting them at the root? + +Assume that you have the following in your configuration: + +```js title="docusaurus.config.js" +export default { + // ... + presets: [ + [ + '@docusaurus/preset-classic', + { + docs: { + /* docs plugin options */ + }, + blog: { + /* blog plugin options */ + }, + // ... + }, + ], + ], +}; +``` + +To enter docs-only mode, change it to like this: + +```js title="docusaurus.config.js" +export default { + // ... + presets: [ + [ + '@docusaurus/preset-classic', + { + docs: { + // highlight-next-line + routeBasePath: '/', // Serve the docs at the site's root + /* other docs plugin options */ + }, + // highlight-next-line + blog: false, // Optional: disable the blog plugin + // ... + }, + ], + ], +}; +``` + +Note that you **don't necessarily have to give up on using the blog** or other plugins; all that `routeBasePath: '/'` does is that instead of serving the docs through `https://example.com/docs/some-doc`, they are now at the site root: `https://example.com/some-doc`. The blog, if enabled, can still be accessed through the `blog/` subroute. + +Don't forget to put some page at the root (`https://example.com/`) through adding the front matter: + +```md title="docs/intro.md" +--- +# highlight-next-line +slug: / +--- + +This page will be the home page when users visit https://example.com/. +``` + +:::warning + +If you added `slug: /` to a doc to make it the homepage, you should delete the existing homepage at `./src/pages/index.js`, or else there will be two files mapping to the same route! + +::: + +Now, the site's structure will be like the following: + +``` +example.com/ -> generated from `docs/intro.md` +example.com/tutorial-basics/... -> generated from `docs/tutorial-basics/...` +... +``` + +:::tip + +There's also a "blog-only mode" for those who only want to use the blog feature of Docusaurus. You can use the same method detailed above. Follow the setup instructions on [Blog-only mode](../../blog.mdx#blog-only-mode). + +::: diff --git a/website/versioned_docs/version-3.9.2/guides/docs/docs-multi-instance.mdx b/website/versioned_docs/version-3.9.2/guides/docs/docs-multi-instance.mdx new file mode 100644 index 0000000000..3fd9a607f9 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/guides/docs/docs-multi-instance.mdx @@ -0,0 +1,213 @@ +--- +id: multi-instance +description: Use multiple docs plugin instances on a single Docusaurus site. +slug: /docs-multi-instance +--- + +# Docs Multi-instance + +The `@docusaurus/plugin-content-docs` plugin can support [multi-instance](../../using-plugins.mdx#multi-instance-plugins-and-plugin-ids). + +:::note + +This feature is only useful for [versioned documentation](./versioning.mdx). It is recommended to be familiar with docs versioning before reading this page. If you just want [multiple sidebars](./sidebar/multiple-sidebars.mdx), you can do so within one plugin. + +::: + +## Use-cases {#use-cases} + +Sometimes you want a Docusaurus site to host 2 distinct sets of documentation (or more). + +These documentations may even have different versioning/release lifecycles. + +### Mobile SDKs documentation {#mobile-sdks-documentation} + +If you build a cross-platform mobile SDK, you may have 2 documentations: + +- Android SDK documentation (`v1.0`, `v1.1`) +- iOS SDK documentation (`v1.0`, `v2.0`) + +In this case, you can use a distinct docs plugin instance per mobile SDK documentation. + +:::warning + +If each documentation instance is very large, you should rather create 2 distinct Docusaurus sites. + +If someone edits the iOS documentation, is it really useful to rebuild everything, including the whole Android documentation that did not change? + +::: + +### Versioned and unversioned doc {#versioned-and-unversioned-doc} + +Sometimes, you want some documents to be versioned, while other documents are more "global", and it feels useless to version them. + +We use this pattern on the Docusaurus website itself: + +- The [/docs/\*](/docs) section is versioned +- The [/community/\*](/community/support) section is unversioned + +## Setup {#setup} + +Suppose you have 2 documentations: + +- Product: some versioned doc about your product +- Community: some unversioned doc about the community around your product + +In this case, you should use the same plugin twice in your site configuration. + +:::warning + +`@docusaurus/preset-classic` already includes a docs plugin instance for you! + +::: + +When using the preset: + +```js title="docusaurus.config.js" +export default { + presets: [ + [ + '@docusaurus/preset-classic', + { + docs: { + // highlight-start + // id: 'product', // omitted => default instance + // highlight-end + path: 'product', + routeBasePath: 'product', + sidebarPath: './sidebarsProduct.js', + // ... other options + }, + }, + ], + ], + plugins: [ + [ + '@docusaurus/plugin-content-docs', + { + // highlight-start + id: 'community', + // highlight-end + path: 'community', + routeBasePath: 'community', + sidebarPath: './sidebarsCommunity.js', + // ... other options + }, + ], + ], +}; +``` + +When not using the preset: + +```js title="docusaurus.config.js" +export default { + plugins: [ + [ + '@docusaurus/plugin-content-docs', + { + // highlight-start + // id: 'product', // omitted => default instance + // highlight-end + path: 'product', + routeBasePath: 'product', + sidebarPath: './sidebarsProduct.js', + // ... other options + }, + ], + [ + '@docusaurus/plugin-content-docs', + { + // highlight-start + id: 'community', + // highlight-end + path: 'community', + routeBasePath: 'community', + sidebarPath: './sidebarsCommunity.js', + // ... other options + }, + ], + ], +}; +``` + +Don't forget to assign a unique `id` attribute to plugin instances. + +:::note + +We consider that the `product` instance is the most important one, and make it the "default" instance by not assigning any ID. + +::: + +## Versioned paths {#versioned-paths} + +Each plugin instance will store versioned docs in a distinct folder. + +The default plugin instance will use these paths: + +- `website/versions.json` +- `website/versioned_docs` +- `website/versioned_sidebars` + +The other plugin instances (with an `id` attribute) will use these paths: + +- `website/[pluginId]_versions.json` +- `website/[pluginId]_versioned_docs` +- `website/[pluginId]_versioned_sidebars` + +:::tip + +You can omit the `id` attribute (defaults to `default`) for one of the docs plugin instances. + +The instance paths will be simpler, and retro-compatible with a single-instance setup. + +::: + +## Tagging new versions {#tagging-new-versions} + +Each plugin instance will have its own CLI command to tag a new version. They will be displayed if you run: + +```bash npm2yarn +npm run docusaurus -- --help +``` + +To version the product/default docs plugin instance: + +```bash npm2yarn +npm run docusaurus docs:version 1.0.0 +``` + +To version the non-default/community docs plugin instance: + +```bash npm2yarn +npm run docusaurus docs:version:community 1.0.0 +``` + +## Docs navbar items {#docs-navbar-items} + +Each docs-related [theme navbar items](../../api/themes/theme-configuration.mdx#navbar) take an optional `docsPluginId` attribute. + +For example, if you want to have one version dropdown for each mobile SDK (iOS and Android), you could do: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + items: [ + { + type: 'docsVersionDropdown', + // highlight-start + docsPluginId: 'ios', + // highlight-end + }, + { + type: 'docsVersionDropdown', + // highlight-start + docsPluginId: 'android', + // highlight-end + }, + ], + }, + }, +}; +``` diff --git a/website/versioned_docs/version-3.9.2/guides/docs/sidebar/autogenerated.mdx b/website/versioned_docs/version-3.9.2/guides/docs/sidebar/autogenerated.mdx new file mode 100644 index 0000000000..f59ae806dc --- /dev/null +++ b/website/versioned_docs/version-3.9.2/guides/docs/sidebar/autogenerated.mdx @@ -0,0 +1,499 @@ +--- +slug: /sidebar/autogenerated +--- + +# Autogenerated + +```mdx-code-block +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +``` + +Docusaurus can **create a sidebar automatically** from your **filesystem structure**: each folder creates a sidebar category, and each file creates a doc link. + +```ts +type SidebarItemAutogenerated = { + type: 'autogenerated'; + dirName: string; // Source folder to generate the sidebar slice from (relative to docs) +}; +``` + +Docusaurus can generate a full sidebar from your docs folder: + +```js title="sidebars.js" +export default { + myAutogeneratedSidebar: [ + // highlight-start + { + type: 'autogenerated', + dirName: '.', // '.' means the current docs folder + }, + // highlight-end + ], +}; +``` + +An `autogenerated` item is converted by Docusaurus to a **sidebar slice** (also discussed in [category shorthands](items.mdx#category-shorthand)): a list of items of type `doc` or `category`, so you can splice **multiple `autogenerated` items** from multiple directories, interleaving them with regular sidebar items, in one sidebar level. + +
    +A real-world example + +Consider this file structure: + +```bash +docs +├── api +│ ├── product1-api +│ │ └── api.md +│ └── product2-api +│ ├── basic-api.md +│ └── pro-api.md +├── intro.md +└── tutorials + ├── advanced + │ ├── advanced1.md + │ ├── advanced2.md + │ └── read-more + │ ├── resource1.md + │ └── resource2.md + ├── easy + │ ├── easy1.md + │ └── easy2.md + ├── tutorial-end.md + ├── tutorial-intro.md + └── tutorial-medium.md +``` + +And assume every doc's ID is just its file name. If you define an autogenerated sidebar like this: + +```js title="sidebars.js" +export default { + mySidebar: [ + 'intro', + { + type: 'category', + label: 'Tutorials', + items: [ + 'tutorial-intro', + // highlight-start + { + type: 'autogenerated', + dirName: 'tutorials/easy', // Generate sidebar slice from docs/tutorials/easy + }, + // highlight-end + 'tutorial-medium', + // highlight-start + { + type: 'autogenerated', + dirName: 'tutorials/advanced', // Generate sidebar slice from docs/tutorials/advanced + }, + // highlight-end + 'tutorial-end', + ], + }, + // highlight-start + { + type: 'autogenerated', + dirName: 'api', // Generate sidebar slice from docs/api + }, + // highlight-end + { + type: 'category', + label: 'Community', + items: ['team', 'chat'], + }, + ], +}; +``` + +It would be resolved as: + +```js title="sidebars.js" +export default { + mySidebar: [ + 'intro', + { + type: 'category', + label: 'Tutorials', + items: [ + 'tutorial-intro', + // highlight-start + // Two files in docs/tutorials/easy + 'easy1', + 'easy2', + // highlight-end + 'tutorial-medium', + // highlight-start + // Two files and a folder in docs/tutorials/advanced + 'advanced1', + 'advanced2', + { + type: 'category', + label: 'read-more', + items: ['resource1', 'resource2'], + }, + // highlight-end + 'tutorial-end', + ], + }, + // highlight-start + // Two folders in docs/api + { + type: 'category', + label: 'product1-api', + items: ['api'], + }, + { + type: 'category', + label: 'product2-api', + items: ['basic-api', 'pro-api'], + }, + // highlight-end + { + type: 'category', + label: 'Community', + items: ['team', 'chat'], + }, + ], +}; +``` + +Note how the autogenerate source directories themselves don't become categories: only the items they contain do. This is what we mean by "sidebar slice". + +
    + +## Category index convention {#category-index-convention} + +Docusaurus can automatically link a category to its index document. + +A category index document is a document following one of those filename conventions: + +- Named as `index` (case-insensitive): `docs/Guides/index.md` +- Named as `README` (case-insensitive): `docs/Guides/README.mdx` +- Same name as parent folder: `docs/Guides/Guides.md` + +This is equivalent to using a category with a [doc link](items.mdx#category-doc-link): + +```js title="sidebars.js" +export default { + docs: [ + // highlight-start + { + type: 'category', + label: 'Guides', + link: {type: 'doc', id: 'Guides/index'}, + items: [], + }, + // highlight-end + ], +}; +``` + +:::tip + +Naming your introductory document `README.md` makes it show up when browsing the folder using the GitHub interface, while using `index.md` makes the behavior more in line with how HTML files are served. + +::: + +:::tip + +If a folder only has one index page, it will be turned into a link instead of a category. This is useful for **asset collocation**: + +``` +some-doc +├── index.md +├── img1.png +└── img2.png +``` + +::: + +
    + +Customizing category index matching + +It is possible to opt out any of the category index conventions, or define even more conventions. You can inject your own `isCategoryIndex` matcher through the [`sidebarItemsGenerator`](#customize-the-sidebar-items-generator) callback. For example, you can also pick `intro` as another file name eligible for automatically becoming the category index. + +```js title="docusaurus.config.js" +export default { + plugins: [ + [ + '@docusaurus/plugin-content-docs', + { + async sidebarItemsGenerator({ + ...args, + isCategoryIndex: defaultCategoryIndexMatcher, // The default matcher implementation, given below + defaultSidebarItemsGenerator, + }) { + return defaultSidebarItemsGenerator({ + ...args, + // highlight-start + isCategoryIndex(doc) { + return ( + // Also pick intro.md in addition to the default ones + doc.fileName.toLowerCase() === 'intro' || + defaultCategoryIndexMatcher(doc) + ); + }, + // highlight-end + }); + }, + }, + ], + ], +}; +``` + +Or choose to not have any category index convention. + +```js title="docusaurus.config.js" +export default { + plugins: [ + [ + '@docusaurus/plugin-content-docs', + { + async sidebarItemsGenerator({ + ...args, + isCategoryIndex: defaultCategoryIndexMatcher, // The default matcher implementation, given below + defaultSidebarItemsGenerator, + }) { + return defaultSidebarItemsGenerator({ + ...args, + // highlight-start + isCategoryIndex() { + // No doc will be automatically picked as category index + return false; + }, + // highlight-end + }); + }, + }, + ], + ], +}; +``` + +The `isCategoryIndex` matcher will be provided with three fields: + +- `fileName`, the file's name without extension and with casing preserved +- `directories`, the list of directory names _from the lowest level to the highest level_, relative to the docs root directory +- `extension`, the file's extension, with a leading dot. + +For example, for a doc file at `guides/sidebar/autogenerated.md`, the props the matcher receives are + +```js +const props = { + fileName: 'autogenerated', + directories: ['sidebar', 'guides'], + extension: '.md', +}; +``` + +The default implementation is: + +```js +function isCategoryIndex({fileName, directories}) { + const eligibleDocIndexNames = [ + 'index', + 'readme', + directories[0].toLowerCase(), + ]; + return eligibleDocIndexNames.includes(fileName.toLowerCase()); +} +``` + +
    + +## Autogenerated sidebar metadata {#autogenerated-sidebar-metadata} + +For handwritten sidebar definitions, you would provide metadata to sidebar items through `sidebars.js`; for autogenerated, Docusaurus would read them from the item's respective file. In addition, you may want to adjust the relative position of each item because, by default, items within a sidebar slice will be generated in **alphabetical order** (using file and folder names). + +### Doc item metadata {#doc-item-metadata} + +The `label`, `className`, `key`, and `customProps` attributes are declared in front matter as `sidebar_label`, `sidebar_class_name`, `sidebar_key` and `sidebar_custom_props`, respectively. Position can be specified in the same way, via `sidebar_position` front matter. + +```md title="docs/tutorials/tutorial-easy.md" +--- +# highlight-start +sidebar_position: 2 +sidebar_label: Easy +sidebar_class_name: green +sidebar_key: unique-sidebar-item-key +# highlight-end +--- + +# Easy Tutorial + +This is the easy tutorial! +``` + +### Category item metadata {#category-item-metadata} + +Add a `_category_.json` or `_category_.yml` file in the respective folder. You can specify any category metadata and also the `position` metadata. `label`, `className`, `key`, `position`, and `customProps` will default to the respective values of the category's linked doc, if there is one. + + + + +```json title="docs/tutorials/_category_.json" +{ + "position": 2.5, + "label": "Tutorial", + "key": "unique-sidebar-item-key", + "collapsible": true, + "collapsed": false, + "className": "red", + "link": { + "type": "generated-index", + "title": "Tutorial overview" + }, + "customProps": { + "description": "This description can be used in the swizzled DocCard" + } +} +``` + + + + +```yml title="docs/tutorials/_category_.yml" +position: 2.5 # float position is supported +label: 'Tutorial' +collapsible: true # make the category collapsible +collapsed: false # keep the category open by default +className: red +link: + type: generated-index + title: Tutorial overview +customProps: + description: This description can be used in the swizzled DocCard +``` + + + + +:::info + +If the `link` is explicitly specified, Docusaurus will not apply any [default conventions](#category-index-convention). + +The doc links can be specified relatively, e.g. if the category is generated with the `guides` directory, `"link": {"type": "doc", "id": "intro"}` will be resolved to the ID `guides/intro`, only falling back to `intro` if a doc with the former ID doesn't exist. + +You can also use `link: null` to opt out of default conventions and not generate any category index page. + +::: + +:::info + +The position metadata is only used **within a sidebar slice**: Docusaurus does not re-order other items of your sidebar. + +::: + +## Using number prefixes {#using-number-prefixes} + +A simple way to order an autogenerated sidebar is to prefix docs and folders by number prefixes, which also makes them appear in the file system in the same order when sorted by file name: + +```bash +docs +├── 01-Intro.md +├── 02-Tutorial Easy +│ ├── 01-First Part.md +│ ├── 02-Second Part.md +│ └── 03-End.md +├── 03-Tutorial Advanced +│ ├── 01-First Part.md +│ ├── 02-Second Part.md +│ ├── 03-Third Part.md +│ └── 04-End.md +└── 04-End.md +``` + +To make it **easier to adopt**, Docusaurus supports **multiple number prefix patterns**. + +By default, Docusaurus will **remove the number prefix** from the doc id, title, label, and URL paths. + +:::warning + +**Prefer using [additional metadata](#autogenerated-sidebar-metadata)**. + +Updating a number prefix can be annoying, as it can require **updating multiple existing Markdown links**: + +```diff title="docs/02-Tutorial Easy/01-First Part.md" +- Check the [Tutorial End](../04-End.mdx); ++ Check the [Tutorial End](../05-End.mdx); +``` + +::: + +## Customize the sidebar items generator {#customize-the-sidebar-items-generator} + +You can provide a custom `sidebarItemsGenerator` function in the docs plugin (or preset) config: + +```js title="docusaurus.config.js" +export default { + plugins: [ + [ + '@docusaurus/plugin-content-docs', + { + // highlight-start + async sidebarItemsGenerator({ + defaultSidebarItemsGenerator, + numberPrefixParser, + item, + version, + docs, + categoriesMetadata, + isCategoryIndex, + }) { + // Example: return an hardcoded list of static sidebar items + return [ + {type: 'doc', id: 'doc1'}, + {type: 'doc', id: 'doc2'}, + ]; + }, + // highlight-end + }, + ], + ], +}; +``` + +:::tip + +**Re-use and enhance the default generator** instead of writing a generator from scratch: [the default generator we provide](https://github.com/facebook/docusaurus/blob/main/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts) is 250 lines long. + +**Add, update, filter, re-order** the sidebar items according to your use case: + +```js title="docusaurus.config.js" +// highlight-start +// Reverse the sidebar items ordering (including nested category items) +function reverseSidebarItems(items) { + // Reverse items in categories + const result = items.map((item) => { + if (item.type === 'category') { + return {...item, items: reverseSidebarItems(item.items)}; + } + return item; + }); + // Reverse items at current level + result.reverse(); + return result; +} +// highlight-end + +export default { + plugins: [ + [ + '@docusaurus/plugin-content-docs', + { + // highlight-start + async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) { + const sidebarItems = await defaultSidebarItemsGenerator(args); + return reverseSidebarItems(sidebarItems); + }, + // highlight-end + }, + ], + ], +}; +``` + +::: diff --git a/website/versioned_docs/version-3.9.2/guides/docs/sidebar/index.mdx b/website/versioned_docs/version-3.9.2/guides/docs/sidebar/index.mdx new file mode 100644 index 0000000000..82cf0499ae --- /dev/null +++ b/website/versioned_docs/version-3.9.2/guides/docs/sidebar/index.mdx @@ -0,0 +1,254 @@ +--- +slug: /sidebar +--- + +# Sidebar + +Creating a sidebar is useful to: + +- Group multiple **related documents** into an ordered tree +- **Display a common sidebar** on each of those documents +- Provide **paginated navigation**, with next/previous button + +To use sidebars on your Docusaurus site: + +1. Define a sidebars file that exports a dictionary of [sidebar objects](#sidebar-object). +2. Pass its path to the `@docusaurus/plugin-docs` plugin directly or via `@docusaurus/preset-classic`. + +```js title="docusaurus.config.js" +export default { + presets: [ + [ + '@docusaurus/preset-classic', + { + docs: { + // highlight-next-line + sidebarPath: './sidebars.js', + }, + }, + ], + ], +}; +``` + +:::important Node.js runtime + +The sidebars file is run with Node.js. You can't use or import browsers APIs, React or JSX in it. + +::: + +This section serves as an overview of miscellaneous features of the doc sidebar. In the following sections, we will more systematically introduce the following concepts: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; + + +``` + +## Default sidebar {#default-sidebar} + +If the `sidebarPath` is unspecified, Docusaurus [automatically generates a sidebar](autogenerated.mdx) for you, by using the filesystem structure of the `docs` folder: + +```js title="sidebars.js" +export default { + mySidebar: [ + { + type: 'autogenerated', + dirName: '.', // generate sidebar from the docs folder (or versioned_docs/) + }, + ], +}; +``` + +You can also define your sidebars explicitly. + +## Sidebar object {#sidebar-object} + +A sidebar is a hierarchy of categories, doc links, and other hyperlinks. + +```ts +type Sidebar = + // Normal syntax + | SidebarItem[] + // Shorthand syntax + | {[categoryLabel: string]: SidebarItem[]}; +``` + +For example: + +```js title="sidebars.js" +export default { + mySidebar: [ + { + type: 'category', + label: 'Getting Started', + items: [ + { + type: 'doc', + id: 'doc1', + }, + ], + }, + { + type: 'category', + label: 'Docusaurus', + items: [ + { + type: 'doc', + id: 'doc2', + }, + { + type: 'doc', + id: 'doc3', + }, + ], + }, + { + type: 'link', + label: 'Learn more', + href: 'https://example.com', + }, + ], +}; +``` + +This is a sidebars file that exports one sidebar, called `mySidebar`. It has three top-level items: two categories and one external link. Within each category, there are a few doc links. + +A sidebars file can contain [**multiple sidebar objects**](multiple-sidebars.mdx), identified by their object keys. + +```ts +type SidebarsFile = { + [sidebarID: string]: Sidebar; +}; +``` + +## Theme configuration {#theme-configuration} + +### Hideable sidebar {#hideable-sidebar} + +By enabling the `themeConfig.docs.sidebar.hideable` option, you can make the entire sidebar hideable, allowing users to better focus on the content. This is especially useful when content is consumed on medium-sized screens (e.g. tablets). + +```js title="docusaurus.config.js" +export default { + themeConfig: { + // highlight-start + docs: { + sidebar: { + hideable: true, + }, + }, + // highlight-end + }, +}; +``` + +### Auto-collapse sidebar categories {#auto-collapse-sidebar-categories} + +The `themeConfig.docs.sidebar.autoCollapseCategories` option would collapse all sibling categories when expanding one category. This saves the user from having too many categories open and helps them focus on the selected section. + +```js title="docusaurus.config.js" +export default { + themeConfig: { + // highlight-start + docs: { + sidebar: { + autoCollapseCategories: true, + }, + }, + // highlight-end + }, +}; +``` + +## Passing CSS classes {#passing-css-classes} + +To pass CSS classes to a sidebar item, add the optional `className` attribute to any of the items. This is useful to apply visual customizations to specific sidebar items. + +```js +{ + type: 'doc', + id: 'doc1', + // highlight-start + className: 'sidebar-item--highlighted', + // highlight-end +}; +``` + +## Passing custom props {#passing-custom-props} + +To pass in custom props to a sidebar item, add the optional `customProps` object to any of the items. This is useful to apply site customizations by swizzling React components rendering sidebar items. + +```js +{ + type: 'doc', + id: 'doc1', + // highlight-start + customProps: { + badges: ['new', 'green'], + featured: true, + }, + // highlight-end +}; +``` + +## Passing a unique key {#passing-unique-key} + +Passing a unique `key` attribute can help uniquely identify a sidebar item. Sometimes other attributes (such as `label`) are not enough to distinguish two sidebar items from each other. + +```js +{ + type: 'category', + // highlight-start + label: 'API', // You may have multiple categories with this widespread label + key: 'api-for-feature-1', // and now, they can be uniquely identified + // highlight-end +}; +``` + +:::info How is this useful? + +Docusaurus only uses the `key` attribute to generate unique i18n translation keys. When a translation key conflict happens ([issue](https://github.com/facebook/docusaurus/issues/10913)), Docusaurus will tell you to apply a `key` to distinguish sidebar items. + +Alternatively, you may have your own reasons for using the `key` attribute that will be passed to the respective sidebar item React components. + +::: + +## Sidebar Breadcrumbs {#sidebar-breadcrumbs} + +By default, breadcrumbs are rendered at the top, using the "sidebar path" of the current page. + +This behavior can be disabled with plugin options: + +```js title="docusaurus.config.js" +export default { + presets: [ + [ + '@docusaurus/preset-classic', + { + docs: { + // highlight-next-line + breadcrumbs: false, + }, + }, + ], + ], +}; +``` + +## Complex sidebars example {#complex-sidebars-example} + +A real-world example from the Docusaurus site: + +```mdx-code-block +import CodeBlock from '@theme/CodeBlock'; + + + {require('!!raw-loader!@site/sidebars.ts') + .default + .split('\n') + // remove comments + .map((line) => !['//','/*','*'].some(commentPattern => line.trim().startsWith(commentPattern)) && line) + .filter(Boolean) + .join('\n')} + +``` diff --git a/website/versioned_docs/version-3.9.2/guides/docs/sidebar/items.mdx b/website/versioned_docs/version-3.9.2/guides/docs/sidebar/items.mdx new file mode 100644 index 0000000000..12c4a518ee --- /dev/null +++ b/website/versioned_docs/version-3.9.2/guides/docs/sidebar/items.mdx @@ -0,0 +1,626 @@ +--- +toc_max_heading_level: 4 +slug: /sidebar/items +--- + +# Sidebar items + +```mdx-code-block +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import BrowserWindow from '@site/src/components/BrowserWindow'; +``` + +The sidebar supports various item types: + +- **[Doc](#sidebar-item-doc)**: link to a doc page, associating it with the sidebar +- **[Link](#sidebar-item-link)**: link to any internal or external page +- **[Category](#sidebar-item-category)**: creates a dropdown of sidebar items +- **[Autogenerated](autogenerated.mdx)**: generate a sidebar slice automatically +- **[HTML](#sidebar-item-html)**: renders pure HTML in the item's position +- **[Ref](multiple-sidebars.mdx#sidebar-item-ref)**: link to a doc page, without making the item take part in navigation generation + +## Doc: link to a doc {#sidebar-item-doc} + +Use the `doc` type to link to a doc page and assign that doc to a sidebar: + +```ts +type SidebarItemDoc = + // Normal syntax + | { + type: 'doc'; + id: string; + label: string; // Sidebar label text + key?: string; // Sidebar key to uniquely identify the item + className?: string; // Class name for sidebar label + customProps?: Record; // Custom props + } + + // Shorthand syntax + | string; // docId shortcut +``` + +Example: + +```js title="sidebars.js" +export default { + mySidebar: [ + // Normal syntax: + // highlight-start + { + type: 'doc', + id: 'doc1', // document ID + label: 'Getting started', // sidebar label + }, + // highlight-end + + // Shorthand syntax: + // highlight-start + 'doc2', // document ID + // highlight-end + ], +}; +``` + +If you use the doc shorthand or [autogenerated](autogenerated.mdx) sidebar, you would lose the ability to customize the sidebar label through item definition. You can, however, use the `sidebar_label` Markdown front matter within that doc, which has higher precedence over the `label` key in the sidebar item. Similarly, you can use `sidebar_custom_props` to declare custom metadata for a doc page. + +:::note + +A `doc` item sets an [implicit sidebar association](./multiple-sidebars.mdx#sidebar-association). Don't assign the same doc to multiple sidebars: change the type to `ref` instead. + +::: + +:::tip + +Sidebar custom props is a useful way to propagate arbitrary doc metadata to the client side, so you can get additional information when using any doc-related hook that fetches a doc object. + +::: + +## Link: link to any page {#sidebar-item-link} + +Use the `link` type to link to any page (internal or external) that is not a doc. + +```ts +type SidebarItemLink = { + type: 'link'; + label: string; + href: string; + description?: string; + key?: string; + className?: string; + customProps?: Record; +}; +``` + +Example: + +```js title="sidebars.js" +export default { + myLinksSidebar: [ + // highlight-start + // External link + { + type: 'link', + label: 'Facebook', // The link label + href: 'https://facebook.com', // The external URL + }, + // highlight-end + + // highlight-start + // Internal link + { + type: 'link', + label: 'Home', // The link label + href: '/', // The internal path + }, + // highlight-end + ], +}; +``` + +## HTML: render custom markup {#sidebar-item-html} + +Use the `html` type to render custom HTML within the item's `
  • ` tag. + +This can be useful for inserting custom items such as dividers, section titles, ads, and images. + +```ts +type SidebarItemHtml = { + type: 'html'; + value: string; + defaultStyle?: boolean; // Use default menu item styles + key?: string; + className?: string; + customProps?: Record; +}; +``` + +Example: + +```js title="sidebars.js" +export default { + myHtmlSidebar: [ + // highlight-start + { + type: 'html', + value: 'Sponsor', // The HTML to be rendered + defaultStyle: true, // Use the default menu item styling + }, + // highlight-end + ], +}; +``` + +:::tip + +The menu item is already wrapped in an `
  • ` tag, so if your custom item is simple, such as a title, just supply a string as the value and use the `className` property to style it: + +```js title="sidebars.js" +export default { + myHtmlSidebar: [ + { + type: 'html', + value: 'Core concepts', + className: 'sidebar-title', + }, + ], +}; +``` + +::: + +## Category: create a hierarchy {#sidebar-item-category} + +Use the `category` type to create a hierarchy of sidebar items. + +```ts +type SidebarItemCategory = { + type: 'category'; + label: string; // Sidebar label text. + items: SidebarItem[]; // Array of sidebar items. + description?: string; + key?: string; + className?: string; + customProps?: Record; + + // Category options: + collapsible: boolean; // Set the category to be collapsible + collapsed: boolean; // Set the category to be initially collapsed or open by default + link: SidebarItemCategoryLinkDoc | SidebarItemCategoryLinkGeneratedIndex; +}; +``` + +Example: + +```js title="sidebars.js" +export default { + docs: [ + { + type: 'category', + label: 'Guides', + collapsible: true, + collapsed: false, + items: [ + 'creating-pages', + { + type: 'category', + label: 'Docs', + items: ['introduction', 'sidebar', 'markdown-features', 'versioning'], + }, + ], + }, + ], +}; +``` + +:::tip + +Use the [**shorthand syntax**](#category-shorthand) when you don't need customizations: + +```js title="sidebars.js" +export default { + docs: { + Guides: [ + 'creating-pages', + { + Docs: ['introduction', 'sidebar', 'markdown-features', 'versioning'], + }, + ], + }, +}; +``` + +::: + +### Category links {#category-link} + +With category links, clicking on a category can navigate you to another page. + +:::tip + +Use category links to introduce a category of documents. + +Autogenerated categories can use the [`_category_.yml`](./autogenerated.mdx#category-item-metadata) file to declare the link. + +::: + +#### Generated index page {#generated-index-page} + +You can auto-generate an index page that displays all the direct children of this category. The `slug` allows you to customize the generated page's route, which defaults to `/category/[categoryName]`. + +```js title="sidebars.js" +export default { + docs: [ + { + type: 'category', + label: 'Guides', + // highlight-start + link: { + type: 'generated-index', + title: 'Docusaurus Guides', + description: 'Learn about the most important Docusaurus concepts!', + slug: '/category/docusaurus-guides', + keywords: ['guides'], + image: '/img/docusaurus.png', + }, + // highlight-end + items: ['pages', 'docs', 'blog', 'search'], + }, + ], +}; +``` + +See it in action on the [Docusaurus Guides page](/docs/category/guides). + +:::tip + +Use `generated-index` links as a quick way to get an introductory document. + +::: + +#### Doc link {#category-doc-link} + +A category can link to an existing document. + +```js title="sidebars.js" +export default { + docs: [ + { + type: 'category', + label: 'Guides', + // highlight-start + link: {type: 'doc', id: 'introduction'}, + // highlight-end + items: ['pages', 'docs', 'blog', 'search'], + }, + ], +}; +``` + +See it in action on the [i18n introduction page](../../../i18n/i18n-introduction.mdx). + +#### Embedding generated index in doc page {#embedding-generated-index-in-doc-page} + +You can embed the generated cards list in a normal doc page as well with the `DocCardList` component. It will display all the sidebar items of the parent category of the current document. + +```md title="docs/sidebar/index.md" +import DocCardList from '@theme/DocCardList'; + + +``` + +```mdx-code-block + + +import DocCardList from '@theme/DocCardList'; + + + + +``` + +### Collapsible categories {#collapsible-categories} + +We support the option to expand/collapse categories. Categories are collapsible by default, but you can disable collapsing with `collapsible: false`. + +```js title="sidebars.js" +export default { + docs: [ + { + type: 'category', + label: 'Guides', + items: [ + 'creating-pages', + { + type: 'category', + // highlight-next-line + collapsible: false, + label: 'Docs', + items: ['introduction', 'sidebar', 'markdown-features', 'versioning'], + }, + ], + }, + ], +}; +``` + +To make all categories non-collapsible by default, set the `sidebarCollapsible` option in `plugin-content-docs` to `false`: + +```js title="docusaurus.config.js" +export default { + presets: [ + [ + '@docusaurus/preset-classic', + { + docs: { + // highlight-next-line + sidebarCollapsible: false, + }, + }, + ], + ], +}; +``` + +:::note + +The option in `sidebars.js` takes precedence over plugin configuration, so it is possible to make certain categories collapsible when `sidebarCollapsible` is set to `false` globally. + +::: + +### Expanded categories by default {#expanded-categories-by-default} + +Collapsible categories are collapsed by default. If you want them to be expanded on the first render, you can set `collapsed` to `false`: + +```js title="sidebars.js" +export default { + docs: { + Guides: [ + 'creating-pages', + { + type: 'category', + label: 'Docs', + // highlight-next-line + collapsed: false, + items: ['markdown-features', 'sidebar', 'versioning'], + }, + ], + }, +}; +``` + +Similar to `collapsible`, you can also set the global configuration `options.sidebarCollapsed` to `false`. Individual `collapsed` options in `sidebars.js` will still take precedence over this configuration. + +```js title="docusaurus.config.js" +export default { + presets: [ + [ + '@docusaurus/preset-classic', + { + docs: { + // highlight-next-line + sidebarCollapsed: false, + }, + }, + ], + ], +}; +``` + +:::warning + +When a category has `collapsed: true` but `collapsible: false` (either through `sidebars.js` or through plugin configuration), the latter takes precedence and the category is still rendered as expanded. + +::: + +## Using shorthands {#using-shorthands} + +You can express typical sidebar items without much customization more concisely with **shorthand syntaxes**. There are two parts to this: [**doc shorthand**](#doc-shorthand) and [**category shorthand**](#category-shorthand). + +### Doc shorthand {#doc-shorthand} + +An item with type `doc` can be simply a string representing its ID: + +```mdx-code-block + + +``` + +```js title="sidebars.js" +export default { + sidebar: [ + // highlight-start + { + type: 'doc', + id: 'myDoc', + }, + // highlight-end + ], +}; +``` + +```mdx-code-block + + +``` + +```js title="sidebars.js" +export default { + sidebar: [ + // highlight-start + 'myDoc', + // highlight-end + ], +}; +``` + +```mdx-code-block + + +``` + +So it's possible to simplify the example above to: + +```js title="sidebars.js" +export default { + mySidebar: [ + { + type: 'category', + label: 'Getting Started', + items: [ + // highlight-next-line + 'doc1', + ], + }, + { + type: 'category', + label: 'Docusaurus', + items: [ + // highlight-start + 'doc2', + 'doc3', + // highlight-end + ], + }, + { + type: 'link', + label: 'Learn more', + href: 'https://example.com', + }, + ], +}; +``` + +### Category shorthand {#category-shorthand} + +A category item can be represented by an object whose key is its label, and the value is an array of subitems. + +```mdx-code-block + + +``` + +```js title="sidebars.js" +export default { + sidebar: [ + // highlight-start + { + type: 'category', + label: 'Getting started', + items: ['doc1', 'doc2'], + }, + // highlight-end + ], +}; +``` + +```mdx-code-block + + +``` + +```js title="sidebars.js" +export default { + sidebar: [ + // highlight-start + { + 'Getting started': ['doc1', 'doc2'], + }, + // highlight-end + ], +}; +``` + +```mdx-code-block + + +``` + +This permits us to simplify that example to: + +```js title="sidebars.js" +export default { + mySidebar: [ + // highlight-start + { + 'Getting started': ['doc1'], + }, + { + Docusaurus: ['doc2', 'doc3'], + }, + // highlight-end + { + type: 'link', + label: 'Learn more', + href: 'https://example.com', + }, + ], +}; +``` + +Each shorthand object after this transformation will contain exactly one entry. Now consider the further simplified example below: + +```js title="sidebars.js" +export default { + mySidebar: [ + // highlight-start + { + 'Getting started': ['doc1'], + Docusaurus: ['doc2', 'doc3'], + }, + // highlight-end + { + type: 'link', + label: 'Learn more', + href: 'https://example.com', + }, + ], +}; +``` + +Note how the two consecutive category shorthands are compressed into one object with two entries. This syntax generates a **sidebar slice**: you shouldn't see that object as one bulk item—this object is unwrapped, with each entry becoming a separate item, and they spliced together with the rest of the items (in this case, the "Learn more" link) to form the final sidebar level. Sidebar slices are also important when discussing [autogenerated sidebars](autogenerated.mdx). + +Wherever you have an array of items that is reduced to one category shorthand, you can omit that enclosing array as well. + +```mdx-code-block + + +``` + +```js title="sidebars.js" +export default { + sidebar: [ + { + 'Getting started': ['doc1'], + Docusaurus: [ + { + 'Basic guides': ['doc2', 'doc3'], + 'Advanced guides': ['doc4', 'doc5'], + }, + ], + }, + ], +}; +``` + +```mdx-code-block + + +``` + +```js title="sidebars.js" +export default { + sidebar: { + 'Getting started': ['doc1'], + Docusaurus: { + 'Basic guides': ['doc2', 'doc3'], + 'Advanced guides': ['doc4', 'doc5'], + }, + }, +}; +``` + +```mdx-code-block + + +``` diff --git a/website/versioned_docs/version-3.9.2/guides/docs/sidebar/multiple-sidebars.mdx b/website/versioned_docs/version-3.9.2/guides/docs/sidebar/multiple-sidebars.mdx new file mode 100644 index 0000000000..d5fa60cb92 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/guides/docs/sidebar/multiple-sidebars.mdx @@ -0,0 +1,143 @@ +--- +slug: /sidebar/multiple-sidebars +--- + +# Using multiple sidebars + +You can create a sidebar for each **set of Markdown files** that you want to **group together**. + +:::tip + +The Docusaurus site is a good example of using multiple sidebars: + +- [Docs](../../../introduction.mdx) +- [API](../../../cli.mdx) + +::: + +Consider this example: + +```js title="sidebars.js" +export default { + tutorialSidebar: { + 'Category A': ['doc1', 'doc2'], + }, + apiSidebar: ['doc3', 'doc4'], +}; +``` + +When browsing `doc1` or `doc2`, the `tutorialSidebar` will be displayed; when browsing `doc3` or `doc4`, the `apiSidebar` will be displayed. + +## Understanding sidebar association {#sidebar-association} + +Following the example above, if a `commonDoc` is included in both sidebars: + +```js title="sidebars.js" +export default { + tutorialSidebar: { + 'Category A': ['doc1', 'doc2', 'commonDoc'], + }, + apiSidebar: ['doc3', 'doc4', 'commonDoc'], +}; +``` + +How does Docusaurus know which sidebar to display when browsing `commonDoc`? Answer: it doesn't, and we don't guarantee which sidebar it will pick. + +When you add doc Y to sidebar X, it creates a two-way binding: sidebar X contains a link to doc Y, and when browsing doc Y, sidebar X will be displayed. But sometimes, we want to break either implicit binding: + +1. _How do I generate a link to doc Y in sidebar X without making sidebar X displayed on Y?_ For example, when I include doc Y in multiple sidebars as in the example above, and I want to explicitly tell Docusaurus to display one sidebar? +2. _How do I make sidebar X displayed when browsing doc Y, but sidebar X shouldn't contain the link to Y?_ For example, when Y is a "doc home page" and the sidebar is purely used for navigation? + +Front matter option `displayed_sidebar` will forcibly set the sidebar association. For the same example, you can still use doc shorthands without any special configuration: + +```js title="sidebars.js" +export default { + tutorialSidebar: { + 'Category A': ['doc1', 'doc2'], + }, + apiSidebar: ['doc3', 'doc4'], +}; +``` + +And then add a front matter: + +```md title="commonDoc.md" +--- +displayed_sidebar: apiSidebar +--- +``` + +Which explicitly tells Docusaurus to display `apiSidebar` when browsing `commonDoc`. Using the same method, you can make sidebar X which doesn't contain doc Y appear on doc Y: + +```md title="home.md" +--- +displayed_sidebar: tutorialSidebar +--- +``` + +Even when `tutorialSidebar` doesn't contain a link to `home`, it will still be displayed when viewing `home`. + +If you set `displayed_sidebar: null`, no sidebar will be displayed whatsoever on this page, and subsequently, no pagination either. + +## Generating pagination {#generating-pagination} + +Docusaurus uses the sidebar to generate the "next" and "previous" pagination links at the bottom of each doc page. It strictly uses the sidebar that is displayed: if no sidebar is associated, it doesn't generate pagination either. However, the docs linked as "next" and "previous" are not guaranteed to display the same sidebar: they are included in this sidebar, but in their front matter, they may have a different `displayed_sidebar`. + +If a sidebar is displayed by setting `displayed_sidebar` front matter, and this sidebar doesn't contain the doc itself, no pagination is displayed. + +You can customize pagination with front matter `pagination_next` and `pagination_prev`. Consider this sidebar: + +```js title="sidebars.js" +export default { + tutorial: [ + 'introduction', + { + installation: ['windows', 'linux', 'macos'], + }, + 'getting-started', + ], +}; +``` + +The pagination next link on "windows" points to "linux", but that doesn't make sense: you would want readers to proceed to "getting started" after installation. In this case, you can set the pagination manually: + +```md title="windows.md" +--- +# highlight-next-line +pagination_next: getting-started +--- + +# Installation on Windows +``` + +You can also disable displaying a pagination link with `pagination_next: null` or `pagination_prev: null`. + +The pagination label by default is the sidebar label. You can use the front matter `pagination_label` to customize how this doc appears in the pagination. + +## The `ref` item {#sidebar-item-ref} + +The `ref` type is identical to the [`doc` type](./items.mdx#sidebar-item-doc) in every way, except that it doesn't participate in generating navigation metadata. It only registers itself as a link. When [generating pagination](#generating-pagination) and [displaying sidebar](#sidebar-association), `ref` items are completely ignored. + +It is particularly useful where you wish to link to the same document from multiple sidebars. The document only belongs to one sidebar (the one where it's registered as `type: 'doc'` or from an autogenerated directory), but its link will appear in all sidebars that it's registered in. + +Consider this example: + +```js title="sidebars.js" +export default { + tutorialSidebar: { + 'Category A': [ + 'doc1', + 'doc2', + // highlight-next-line + {type: 'ref', id: 'commonDoc'}, + 'doc5', + ], + }, + apiSidebar: ['doc3', 'doc4', 'commonDoc'], +}; +``` + +You can think of the `ref` type as the equivalent to doing the following: + +- Setting `displayed_sidebar: tutorialSidebar` for `commonDoc` (`ref` is ignored in sidebar association) +- Setting `pagination_next: doc5` for `doc2` and setting `pagination_prev: doc2` for `doc5` (`ref` is ignored in pagination generation) diff --git a/website/versioned_docs/version-3.9.2/guides/docs/versioning.mdx b/website/versioned_docs/version-3.9.2/guides/docs/versioning.mdx new file mode 100644 index 0000000000..196f7a3790 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/guides/docs/versioning.mdx @@ -0,0 +1,375 @@ +--- +slug: /versioning +--- + +# Versioning + +You can use the versioning CLI to create a new documentation version based on the latest content in the `docs` directory. That specific set of documentation will then be preserved and accessible even as the documentation in the `docs` directory continues to evolve. + +```mdx-code-block +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +``` + +:::warning + +Think about it before starting to version your documentation - it can become difficult for contributors to help improve it! + +::: + +Most of the time, you don't need versioning as it will just increase your build time, and introduce complexity to your codebase. Versioning is **best suited for websites with high-traffic and rapid changes to documentation between versions**. If your documentation rarely changes, don't add versioning to your documentation. + +To better understand how versioning works and see if it suits your needs, you can read on below. + +## Overview {#overview} + +A typical versioned doc site looks like below: + +```bash +website +├── sidebars.json # sidebar for the current docs version +├── docs # docs directory for the current docs version +│ ├── foo +│ │ └── bar.md # https://mysite.com/docs/next/foo/bar +│ └── hello.md # https://mysite.com/docs/next/hello +├── versions.json # file to indicate what versions are available +├── versioned_docs +│ ├── version-1.1.0 +│ │ ├── foo +│ │ │ └── bar.md # https://mysite.com/docs/foo/bar +│ │ └── hello.md +│ └── version-1.0.0 +│ ├── foo +│ │ └── bar.md # https://mysite.com/docs/1.0.0/foo/bar +│ └── hello.md +├── versioned_sidebars +│ ├── version-1.1.0-sidebars.json +│ └── version-1.0.0-sidebars.json +├── docusaurus.config.js +└── package.json +``` + +The `versions.json` file is a list of version names, ordered from newest to oldest. + +The table below explains how a versioned file maps to its version and the generated URL. + +| Path | Version | URL | +| --------------------------------------- | -------------- | ----------------- | +| `versioned_docs/version-1.0.0/hello.md` | 1.0.0 | /docs/1.0.0/hello | +| `versioned_docs/version-1.1.0/hello.md` | 1.1.0 (latest) | /docs/hello | +| `docs/hello.md` | current | /docs/next/hello | + +:::tip + +The files in the `docs` directory belong to the `current` docs version. + +By default, the `current` docs version is labeled as `Next` and hosted under `/docs/next/*`, but it is entirely configurable to fit your project's release lifecycle. + +::: + +### Terminology {#terminology} + +Note the terminology we use here. + +
    +
    + Current version +
    +
    + {'The version placed in the '} + ./docs + {' folder.'} +
    +
    + Latest version / last version +
    +
    + {'The version served by default for docs navbar items. Usually has path '} + /docs + {'.'} +
    +
    + +Current version is defined by the **file system location**, while latest version is defined by the **the navigation behavior**. They may or may not be the same version! (And the default configuration, as shown in the table above, would treat them as different: current version at `/docs/next` and latest at `/docs`.) + +## Tutorials {#tutorials} + +### Tagging a new version {#tagging-a-new-version} + +1. First, make sure the current docs version (the `./docs` directory) is ready to be frozen. +2. Enter a new version number. + +```bash npm2yarn +npm run docusaurus docs:version 1.1.0 +``` + +When tagging a new version, the document versioning mechanism will: + +- Copy the full `docs/` folder contents into a new `versioned_docs/version-[versionName]/` folder. +- Create a versioned sidebars file based from your current [sidebar](./sidebar/index.mdx) configuration (if it exists) - saved as `versioned_sidebars/version-[versionName]-sidebars.json`. +- Append the new version number to `versions.json`. + +### Creating new docs {#creating-new-docs} + +1. Place the new file into the corresponding version folder. +2. Include the reference to the new file in the corresponding sidebar file according to the version number. + +```mdx-code-block + + +``` + +```bash +# The new file. +docs/new.md + +# Edit the corresponding sidebar file. +sidebars.js +``` + +```mdx-code-block + + +``` + +```bash +# The new file. +versioned_docs/version-1.0.0/new.md + +# Edit the corresponding sidebar file. +versioned_sidebars/version-1.0.0-sidebars.json +``` + +```mdx-code-block + + +``` + +:::tip + +Versioned sidebar files are, like standard sidebar files, relative to the content root for the given version — so for the example above, your versioned sidebar file may look like: + +```json +{ + "sidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} +``` + +or for a manual sidebar: + +```json +{ + "sidebar": [ + { + "type": "doc", + "id": "new", + "label": "New" + } + ] +} +``` + +::: + +### Updating an existing version {#updating-an-existing-version} + +You can update multiple docs versions at the same time because each directory in `versioned_docs/` represents specific routes when published. + +1. Edit any file. +2. Commit and push changes. +3. It will be published to the version. + +Example: When you change any file in `versioned_docs/version-2.6/`, it will only affect the docs for version `2.6`. + +### Deleting an existing version {#deleting-an-existing-version} + +You can delete/remove versions as well. + +1. Remove the version from `versions.json`. + +Example: + +```diff +[ + "2.0.0", + "1.9.0", + // highlight-next-line +- "1.8.0" +] +``` + +2. Delete the versioned docs directory. Example: `versioned_docs/version-1.8.0`. +3. Delete the versioned sidebars file. Example: `versioned_sidebars/version-1.8.0-sidebars.json`. + +## Configuring versioning behavior {#configuring-versioning-behavior} + +The "current" version is the version name for the `./docs` folder. There are different ways to manage versioning, but two very common patterns are: + +- You release v1, and start immediately working on v2 (including its docs). In this case, the **current version** is v2, which is in the `./docs` source folder, and can be browsed at `example.com/docs/next`. The **latest version** is v1, which is in the `./versioned_docs/version-1` source folder, and is browsed by most of your users at `example.com/docs`. +- You release v1, and will maintain it for some time before thinking about v2. In this case, the **current version** and **latest version** will both be point to v1, since the v2 docs doesn't even exist yet! + +Docusaurus defaults work great for the first use case. We will label the current version as "next" and you can even choose not to publish it. + +**For the 2nd use case**: if you release v1 and don't plan to work on v2 anytime soon, instead of versioning v1 and having to maintain the docs in 2 folders (`./docs` + `./versioned_docs/version-1.0.0`), you may consider "pretending" that the current version is a cut version by giving it a path and a label: + +```js title="docusaurus.config.js" +export default { + presets: [ + '@docusaurus/preset-classic', + docs: { + // highlight-start + lastVersion: 'current', + versions: { + current: { + label: '1.0.0', + path: '1.0.0', + }, + }, + // highlight-end + }, + ], +}; +``` + +The docs in `./docs` will be served at `/docs/1.0.0` instead of `/docs/next`, and `1.0.0` will become the default version we link to in the navbar dropdown, and you will only need to maintain a single `./docs` folder. + +We offer these plugin options to customize versioning behavior: + +- `disableVersioning`: Explicitly disable versioning even with versions. This will make the site only include the current version. +- `includeCurrentVersion`: Include the current version (the `./docs` folder) of your docs. + - **Tip**: turn it off if the current version is a work-in-progress, not ready to be published. +- `lastVersion`: Sets which version "latest version" (the `/docs` route) refers to. + - **Tip**: `lastVersion: 'current'` makes sense if your current version refers to a major version that's constantly patched and released. The actual route base path and label of the latest version are configurable. +- `onlyIncludeVersions`: Defines a subset of versions from `versions.json` to be deployed. + - **Tip**: limit to 2 or 3 versions in dev and deploy previews to improve startup and build time. +- `versions`: A dictionary of version metadata. For each version, you can customize the following: + - `label`: the label displayed in the versions dropdown and banner. + - `path`: the route base path of this version. By default, latest version has `/` and current version has `/next`. + - `banner`: one of `'none'`, `'unreleased'`, and `'unmaintained'`. Determines what's displayed at the top of every doc page. Any version above the latest version would be "unreleased", and any version below would be "unmaintained". + - `badge`: show a badge with the version name at the top of a doc of that version. + - `className`: add a custom `className` to the `` element of doc pages of that version. + +See [docs plugin configuration](../../api/plugins/plugin-content-docs.mdx#configuration) for more details. + +## Navbar items {#navbar-items} + +We offer several docs navbar items to help you quickly set up navigation without worrying about versioned routes. + +- [`doc`](../../api/themes/theme-configuration.mdx#navbar-doc-link): a link to a doc. +- [`docSidebar`](../../api/themes/theme-configuration.mdx#navbar-doc-sidebar): a link to the first item in a sidebar. +- [`docsVersion`](../../api/themes/theme-configuration.mdx#navbar-docs-version): a link to the main doc of the currently viewed version. +- [`docsVersionDropdown`](../../api/themes/theme-configuration.mdx#navbar-docs-version-dropdown): a dropdown containing all the versions available. + +These links would all look for an appropriate version to link to, in the following order: + +1. **Active version**: the version that the user is currently browsing, if she is on a page provided by this doc plugin. If she's not on a doc page, fall back to... +2. **Preferred version**: the version that the user last viewed. If there's no history, fall back to... +3. **Latest version**: the default version that we navigate to, configured by the `lastVersion` option. + +## `docsVersionDropdown` {#docsVersionDropdown} + +By default, the [`docsVersionDropdown`](../../api/themes/theme-configuration.mdx#navbar-docs-version-dropdown) displays a dropdown with all the available docs versions. + +The `versions` attribute allows you to display a subset of the available docs versions in a given order: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + items: [ + { + type: 'docsVersionDropdown', + // highlight-start + versions: ['current', '3.0', '2.0'], + // highlight-end + }, + ], + }, + }, +}; +``` + +Passing a `versions` object, lets you override the display label of each version: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + items: [ + { + type: 'docsVersionDropdown', + // highlight-start + versions: { + current: {label: 'Version 4.0'}, + '3.0': {label: 'Version 3.0'}, + '2.0': {label: 'Version 2.0'}, + }, + // highlight-end + }, + ], + }, + }, +}; +``` + +## Recommended practices {#recommended-practices} + +### Version your documentation only when needed {#version-your-documentation-only-when-needed} + +For example, you are building documentation for your npm package `foo` and you are currently in version 1.0.0. You then release a patch version for a minor bug fix and it's now 1.0.1. + +Should you cut a new documentation version 1.0.1? **You probably shouldn't**. 1.0.1 and 1.0.0 docs shouldn't differ according to semver because there are no new features!. Cutting a new version for it will only just create unnecessary duplicated files. + +### Keep the number of versions small {#keep-the-number-of-versions-small} + +As a good rule of thumb, try to keep the number of your versions below 10. You will **very likely** to have a lot of obsolete versioned documentation that nobody even reads anymore. For example, [Jest](https://jestjs.io/versions) is currently in version `27.4`, and only maintains several latest documentation versions with the lowest being `25.X`. Keep it small 😊 + +:::tip archive older versions + +If you deploy your site on a Jamstack provider (e.g. [Netlify](../../deployment.mdx)), the provider will save each production build as a snapshot under an immutable URL. You can include archived versions that will never be rebuilt as external links to these immutable URLs. The Jest website and the Docusaurus website both use such pattern to keep the number of actively built versions low. + +::: + +### Use absolute import within the docs {#use-absolute-import-within-the-docs} + +Don't use relative paths import within the docs. Because when we cut a version the paths no longer work (the nesting level is different, among other reasons). You can utilize the `@site` alias provided by Docusaurus that points to the `website` directory. Example: + +```diff +- import Foo from '../src/components/Foo'; ++ import Foo from '@site/src/components/Foo'; +``` + +### Link docs by file paths {#link-docs-by-file-paths} + +Refer to other docs by relative file paths with the `.md` extension, so that Docusaurus can rewrite them to actual URL paths during building. Files will be linked to the correct corresponding version. + +```md +The [@hello](hello.mdx#paginate) document is great! + +See the [Tutorial](../getting-started/tutorial.mdx) for more info. +``` + +### Global or versioned collocated assets {#global-or-versioned-collocated-assets} + +You should decide if assets like images and files are per-version or shared between versions. + +If your assets should be versioned, put them in the docs version, and use relative paths: + +```md +![img alt](./myImage.png) + +[download this file](./file.pdf) +``` + +If your assets are global, put them in `/static` and use absolute paths: + +```md +![img alt](/myImage.png) + +[download this file](/file.pdf) +``` diff --git a/website/versioned_docs/version-3.9.2/guides/markdown-features/_markdown-partial-example.mdx b/website/versioned_docs/version-3.9.2/guides/markdown-features/_markdown-partial-example.mdx new file mode 100644 index 0000000000..5eb3f3bf11 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/guides/markdown-features/_markdown-partial-example.mdx @@ -0,0 +1,3 @@ +Hello {props.name} + +This is text some content from `_markdown-partial-example.md`. diff --git a/website/versioned_docs/version-3.9.2/guides/markdown-features/markdown-features-admonitions.mdx b/website/versioned_docs/version-3.9.2/guides/markdown-features/markdown-features-admonitions.mdx new file mode 100644 index 0000000000..39353f5873 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/guides/markdown-features/markdown-features-admonitions.mdx @@ -0,0 +1,372 @@ +--- +id: admonitions +description: Handling admonitions/callouts in Docusaurus Markdown +slug: /markdown-features/admonitions +--- + +# Admonitions + +import BrowserWindow from '@site/src/components/BrowserWindow'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import Admonition from '@theme/Admonition'; + +In addition to the basic Markdown syntax, we have a special admonitions syntax by wrapping text with a set of 3 colons, followed by a label denoting its type. + +Example: + +```md +:::note + +Some **content** with _Markdown_ `syntax`. Check [this `api`](#). + +::: + +:::tip + +Some **content** with _Markdown_ `syntax`. Check [this `api`](#). + +::: + +:::info + +Some **content** with _Markdown_ `syntax`. Check [this `api`](#). + +::: + +:::warning + +Some **content** with _Markdown_ `syntax`. Check [this `api`](#). + +::: + +:::danger + +Some **content** with _Markdown_ `syntax`. Check [this `api`](#). + +::: +``` + +```mdx-code-block + + +:::note + +Some **content** with _Markdown_ `syntax`. Check [this `api`](#). + +::: + +:::tip + +Some **content** with _Markdown_ `syntax`. Check [this `api`](#). + +::: + +:::info + +Some **content** with _Markdown_ `syntax`. Check [this `api`](#). + +::: + +:::warning + +Some **content** with _Markdown_ `syntax`. Check [this `api`](#). + +::: + +:::danger + +Some **content** with _Markdown_ `syntax`. Check [this `api`](#). + +::: + + +``` + +## Usage with Prettier {#usage-with-prettier} + +If you use [Prettier](https://prettier.io) to format your Markdown files, Prettier might auto-format your code to invalid admonition syntax. To avoid this problem, add empty lines around the starting and ending directives. This is also why the examples we show here all have empty lines around the content. + +{/* prettier-ignore */} +```md + +:::note + +Hello world + +::: + + +:::note +Hello world +::: + + +::: note Hello world::: +``` + +## Specifying title {#specifying-title} + +You may also specify an optional title. + +```md +:::note[Your Title **with** some _Markdown_ `syntax`!] + +Some **content** with some _Markdown_ `syntax`. + +::: +``` + +```mdx-code-block + + +:::note[Your Title **with** some _Markdown_ `syntax`!] + +Some **content** with some _Markdown_ `syntax`. + +::: + + +``` + +## Nested admonitions {#nested-admonitions} + +Admonitions can be nested. Use more colons `:` for each parent admonition level. + +```md +:::::info Parent + +Parent content + +::::danger Child + +Child content + +:::tip Deep Child + +Deep child content + +::: + +:::: + +::::: +``` + +```mdx-code-block + + +:::::info Parent + +Parent content + +::::danger Child + +Child content + +:::tip Deep Child + +Deep child content + +::: + +:::: + +::::: + + +``` + +## Admonitions with MDX {#admonitions-with-mdx} + +You can use MDX inside admonitions too! + +```jsx +import Tabs from '@theme/Tabs'; + +import TabItem from '@theme/TabItem'; + +:::tip[Use tabs in admonitions] + + + This is an apple 🍎 + This is an orange 🍊 + This is a banana 🍌 + + +::: +``` + +```mdx-code-block + + +:::tip[Use tabs in admonitions] + + + This is an apple 🍎 + This is an orange 🍊 + This is a banana 🍌 + + +::: + + +``` + +## Usage in JSX {#usage-in-jsx} + +Outside of Markdown, you can use the `@theme/Admonition` component to get the same output. + +```jsx title="MyReactPage.jsx" +import Admonition from '@theme/Admonition'; + +export default function MyReactPage() { + return ( +
    + +

    Some information

    +
    +
    + ); +} +``` + +The types that are accepted are the same as above: `note`, `tip`, `danger`, `info`, `warning`. Optionally, you can specify an icon by passing a JSX element or a string, or a title: + +```jsx title="MyReactPage.jsx" + + Use plugins to introduce shorter syntax for the most commonly used JSX + elements in your project. + +``` + +```mdx-code-block + + + Use plugins to introduce shorter syntax for the most commonly used JSX + elements in your project. + + +``` + +## Customizing admonitions {#customizing-admonitions} + +There are two kinds of customizations possible with admonitions: **parsing** and **rendering**. + +### Customizing rendering behavior {#customizing-rendering-behavior} + +You can customize how each individual admonition type is rendered through [swizzling](../../swizzling.mdx). You can often achieve your goal through a simple wrapper. For example, in the follow example, we swap out the icon for `info` admonitions only. + +```jsx title="src/theme/Admonition.js" +import React from 'react'; +import Admonition from '@theme-original/Admonition'; +import MyCustomNoteIcon from '@site/static/img/info.svg'; + +export default function AdmonitionWrapper(props) { + if (props.type !== 'info') { + return ; + } + return } {...props} />; +} +``` + +### Customizing parsing behavior {#customizing-parsing-behavior} + +Admonitions are implemented with a [Remark plugin](./markdown-features-plugins.mdx). The plugin is designed to be configurable. To customize the Remark plugin for a specific content plugin (docs, blog, pages), pass the options through the `admonitions` key. + +```js title="docusaurus.config.js" +export default { + presets: [ + [ + '@docusaurus/preset-classic', + { + docs: { + admonitions: { + keywords: ['note', 'tip', 'info', 'warning', 'danger'], + extendDefaults: true, + }, + }, + }, + ], + ], +}; +``` + +The plugin accepts the following options: + +- `keywords`: An array of keywords that can be used as the type for the admonition. +- `extendDefaults`: Should the provided options (such as `keywords`) be merged into the existing defaults. Defaults to `true`. + +The `keyword` will be passed as the `type` prop of the `Admonition` component. + +### Custom admonition type components {#custom-admonition-type-components} + +By default, the theme doesn't know what do to with custom admonition keywords such as `:::my-custom-admonition`. It is your responsibility to map each admonition keyword to a React component so that the theme knows how to render them. + +If you registered a new admonition type `my-custom-admonition` via the following config: + +```js title="docusaurus.config.js" +export default { + // ... + presets: [ + [ + 'classic', + { + // ... + docs: { + admonitions: { + keywords: ['my-custom-admonition'], + extendDefaults: true, + }, + }, + }, + ], + ], +}; +``` + +You can provide the corresponding React component for `:::my-custom-admonition` by creating the following file (unfortunately, since it's not a React component file, it's not swizzlable): + +```js title="src/theme/Admonition/Types.js" +import React from 'react'; +import DefaultAdmonitionTypes from '@theme-original/Admonition/Types'; + +function MyCustomAdmonition(props) { + return ( +
    +
    {props.title}
    +
    {props.children}
    +
    + ); +} + +const AdmonitionTypes = { + ...DefaultAdmonitionTypes, + + // Add all your custom admonition types here... + // You can also override the default ones if you want + 'my-custom-admonition': MyCustomAdmonition, +}; + +export default AdmonitionTypes; +``` + +Now you can use your new admonition keyword in a Markdown file, and it will be parsed and rendered with your custom logic: + +```md +:::my-custom-admonition[My Title] + +It works! + +::: +``` + + + +:::my-custom-admonition[My Title] + +It works! + +::: + + diff --git a/website/versioned_docs/version-3.9.2/guides/markdown-features/markdown-features-assets.mdx b/website/versioned_docs/version-3.9.2/guides/markdown-features/markdown-features-assets.mdx new file mode 100644 index 0000000000..fa75c8f676 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/guides/markdown-features/markdown-features-assets.mdx @@ -0,0 +1,235 @@ +--- +id: assets +description: Handling assets in Docusaurus Markdown +slug: /markdown-features/assets +--- + +# Assets + +import BrowserWindow from '@site/src/components/BrowserWindow'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Sometimes you want to link to assets (e.g. docx files, images...) directly from Markdown files, and it is convenient to co-locate the asset next to the Markdown file using it. + +Let's imagine the following file structure: + +``` +# Your doc +/website/docs/myFeature.mdx + +# Some assets you want to use +/website/docs/assets/docusaurus-asset-example-banner.png +/website/docs/assets/docusaurus-asset-example.docx +``` + +## Images {#images} + +You can display images in three different ways: Markdown syntax, CJS require, or ES imports syntax. + +```mdx-code-block + + +``` + +Display images using simple Markdown syntax: + +```md +![Example banner](./assets/docusaurus-asset-example-banner.png) +``` + +```mdx-code-block + + +``` + +Display images using inline CommonJS `require` in JSX image tag: + +```jsx +Example banner +``` + +```mdx-code-block + + +``` + +Display images using ES `import` syntax and JSX image tag: + +```jsx +import myImageUrl from './assets/docusaurus-asset-example-banner.png'; + +Example banner; +``` + +```mdx-code-block + + +``` + +All of the above result in displaying the image: + + + +![My image alternative text](../../assets/docusaurus-asset-example-banner.png) + + + +:::note + +If you are using [@docusaurus/plugin-ideal-image](../../api/plugins/plugin-ideal-image.mdx), you need to use the dedicated image component, as documented. + +::: + +## Files {#files} + +In the same way, you can link to existing assets by `require`'ing them and using the returned URL in `video`s, `a` anchor links, etc. + +```md +# My Markdown page + +
    Download this docx + +or + +[Download this docx using Markdown](./assets/docusaurus-asset-example.docx) +``` + + + + + {'Download this docx'} + + +[Download this docx using Markdown](../../assets/docusaurus-asset-example.docx) + + + +:::info Markdown links are always file paths + +If you use the Markdown image or link syntax, all asset paths will be resolved as file paths by Docusaurus and automatically converted to `require()` calls. You don't need to use `require()` in Markdown unless you use the JSX syntax, which you do have to handle yourself. + +::: + +## Inline SVGs {#inline-svgs} + +Docusaurus supports inlining SVGs out of the box. + +```jsx +import DocusaurusSvg from './docusaurus.svg'; + +; +``` + + + +import DocusaurusSvg from '@site/static/img/docusaurus.svg'; + + + + + +This can be useful if you want to alter the part of the SVG image via CSS. For example, you can change one of the SVG colors based on the current theme. + +```jsx +import DocusaurusSvg from './docusaurus.svg'; + +; +``` + +```css +[data-theme='light'] .themedDocusaurus [fill='#FFFF50'] { + fill: greenyellow; +} + +[data-theme='dark'] .themedDocusaurus [fill='#FFFF50'] { + fill: seagreen; +} +``` + + + + + +## Themed Images {#themed-images} + +Docusaurus supports themed images: the `ThemedImage` component (included in the themes) allows you to switch the image source based on the current theme. + +```jsx +import useBaseUrl from '@docusaurus/useBaseUrl'; +import ThemedImage from '@theme/ThemedImage'; + +; +``` + +```mdx-code-block +import useBaseUrl from '@docusaurus/useBaseUrl'; +import ThemedImage from '@theme/ThemedImage'; + + + + +``` + +### GitHub-style themed images {#github-style-themed-images} + +GitHub uses its own [image theming approach](https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/) with path fragments, which you can easily implement yourself. + +To toggle the visibility of an image using the path fragment (for GitHub, it's `#gh-dark-mode-only` and `#gh-light-mode-only`), add the following to your custom CSS (you can also use your own suffix if you don't want to be coupled to GitHub): + +```css title="src/css/custom.css" +[data-theme='light'] img[src$='#gh-dark-mode-only'], +[data-theme='dark'] img[src$='#gh-light-mode-only'] { + display: none; +} +``` + +```md +![Docusaurus themed image](/img/docusaurus_keytar.svg#gh-light-mode-only)![Docusaurus themed image](/img/docusaurus_speed.svg#gh-dark-mode-only) +``` + + + +![Docusaurus themed image](/img/docusaurus_keytar.svg#gh-light-mode-only)![Docusaurus themed image](/img/docusaurus_speed.svg#gh-dark-mode-only) + + + +## Static assets {#static-assets} + +If a Markdown link or image has an absolute path, the path will be seen as a file path and will be resolved from the static directories. For example, if you have configured [static directories](../../static-assets.mdx) to be `['public', 'static']`, then for the following image: + +```md title="my-doc.md" +![An image from the static](/img/docusaurus.png) +``` + +Docusaurus will try to look for it in both `static/img/docusaurus.png` and `public/img/docusaurus.png`. The link will then be converted to a `require()` call instead of staying as a URL. This is desirable in two regards: + +1. You don't have to worry about the base URL, which Docusaurus will take care of when serving the asset; +2. The image enters Webpack's build pipeline and its name will be appended by a hash, which enables browsers to aggressively cache the image and improves your site's performance. + +If you intend to write URLs, you can use the `pathname://` protocol to disable automatic asset linking. + +```md +![banner](pathname:///img/docusaurus-asset-example-banner.png) +``` + +This link will be generated as `banner`, without any processing or file existence checking. diff --git a/website/versioned_docs/version-3.9.2/guides/markdown-features/markdown-features-code-blocks.mdx b/website/versioned_docs/version-3.9.2/guides/markdown-features/markdown-features-code-blocks.mdx new file mode 100644 index 0000000000..f55442b973 --- /dev/null +++ b/website/versioned_docs/version-3.9.2/guides/markdown-features/markdown-features-code-blocks.mdx @@ -0,0 +1,864 @@ +--- +id: code-blocks +description: Handling code blocks in Docusaurus Markdown +slug: /markdown-features/code-blocks +--- + +# Code blocks + +import BrowserWindow from '@site/src/components/BrowserWindow'; +import CodeBlock from '@theme/CodeBlock'; + +Code blocks within documentation are super-powered 💪. + +## Code title {#code-title} + +You can add a title to the code block by adding a `title` key after the language (leave a space between them). + +````md +```jsx title="/src/components/HelloCodeTitle.js" +function HelloCodeTitle(props) { + return

    Hello, {props.name}

    ; +} +``` +```` + +```mdx-code-block + +``` + +```jsx title="/src/components/HelloCodeTitle.js" +function HelloCodeTitle(props) { + return

    Hello, {props.name}

    ; +} +``` + +```mdx-code-block +
    +``` + +## Syntax highlighting {#syntax-highlighting} + +Code blocks are text blocks wrapped around by strings of 3 backticks. You may check out [this reference](https://mdxjs.com/docs/) for the specifications of MDX. + +````md +```js +console.log('Every repo must come with a mascot.'); +``` +```` + +Use the matching language meta string for your code block, and Docusaurus will pick up syntax highlighting automatically, powered by [Prism React Renderer](https://github.com/FormidableLabs/prism-react-renderer). + + + +```js +console.log('Every repo must come with a mascot.'); +``` + + + +### Theming {#theming} + +By default, the Prism [syntax highlighting theme](https://github.com/FormidableLabs/prism-react-renderer#theming) we use is [Palenight](https://github.com/FormidableLabs/prism-react-renderer/blob/master/packages/prism-react-renderer/src/themes/palenight.ts). You can change this to another theme by passing `theme` field in `prism` as `themeConfig` in your docusaurus.config.js. + +For example, if you prefer to use the `dracula` highlighting theme: + +```js title="docusaurus.config.js" +import {themes as prismThemes} from 'prism-react-renderer'; + +export default { + themeConfig: { + prism: { + // highlight-next-line + theme: prismThemes.dracula, + }, + }, +}; +``` + +Because a Prism theme is just a JS object, you can also write your own theme if you are not satisfied with the default. Docusaurus enhances the `github` and `vsDark` themes to provide richer highlight, and you can check our implementations for the [light](https://github.com/facebook/docusaurus/blob/main/website/src/utils/prismLight.ts) and [dark](https://github.com/facebook/docusaurus/blob/main/website/src/utils/prismDark.ts) code block themes. + +### Supported Languages {#supported-languages} + +By default, Docusaurus comes with a subset of [commonly used languages](https://github.com/FormidableLabs/prism-react-renderer/blob/master/packages/generate-prism-languages/index.ts#L10-L25). + +:::warning + +Some popular languages like Java, C#, or PHP are not enabled by default. + +::: + +To add syntax highlighting for any of the other [Prism-supported languages](https://prismjs.com/#supported-languages), define it in an array of additional languages. + +:::note + +Each additional language has to be a valid Prism component name. For example, Prism would map the _language_ `cs` to `csharp`, but only `prism-csharp.js` exists as a _component_, so you need to use `additionalLanguages: ['csharp']`. You can look into `node_modules/prismjs/components` to find all components (languages) available. + +::: + +For example, if you want to add highlighting for the PowerShell language: + +```js title="docusaurus.config.js" +export default { + // ... + themeConfig: { + prism: { + // highlight-next-line + additionalLanguages: ['powershell'], + }, + // ... + }, +}; +``` + +After adding `additionalLanguages`, restart Docusaurus. + +If you want to add highlighting for languages not yet supported by Prism, you can swizzle `prism-include-languages`: + +```bash npm2yarn +npm run swizzle @docusaurus/theme-classic prism-include-languages +``` + +It will produce `prism-include-languages.js` in your `src/theme` folder. You can add highlighting support for custom languages by editing `prism-include-languages.js`: + +```js title="src/theme/prism-include-languages.js" +const prismIncludeLanguages = (Prism) => { + // ... + + additionalLanguages.forEach((lang) => { + require(`prismjs/components/prism-${lang}`); + }); + + // highlight-next-line + require('/path/to/your/prism-language-definition'); + + // ... +}; +``` + +You can refer to [Prism's official language definitions](https://github.com/PrismJS/prism/tree/master/components) when you are writing your own language definitions. + +When adding a custom language definition, you do not need to add the language to the `additionalLanguages` config array, since Docusaurus only looks up the `additionalLanguages` strings in languages that Prism provides. Adding the language import in `prism-include-languages.js` is sufficient. + +## Line highlighting {#line-highlighting} + +### Highlighting with comments {#highlighting-with-comments} + +You can use comments with `highlight-next-line`, `highlight-start`, and `highlight-end` to select which lines are highlighted. + +````md +```js +function HighlightSomeText(highlight) { + if (highlight) { + // highlight-next-line + return 'This text is highlighted!'; + } + + return 'Nothing highlighted'; +} + +function HighlightMoreText(highlight) { + // highlight-start + if (highlight) { + return 'This range is highlighted!'; + } + // highlight-end + + return 'Nothing highlighted'; +} +``` +```` + +```mdx-code-block + +``` + +```js +function HighlightSomeText(highlight) { + if (highlight) { + // highlight-next-line + return 'This text is highlighted!'; + } + + return 'Nothing highlighted'; +} + +function HighlightMoreText(highlight) { + // highlight-start + if (highlight) { + return 'This range is highlighted!'; + } + // highlight-end + + return 'Nothing highlighted'; +} +``` + +```mdx-code-block + +``` + +Supported commenting syntax: + +| Style | Syntax | +| ---------- | ------------------------ | +| C-style | `/* ... */` and `// ...` | +| JSX-style | `{/* ... */}` | +| Bash-style | `# ...` | +| HTML-style | `` | + +We will do our best to infer which set of comment styles to use based on the language, and default to allowing _all_ comment styles. If there's a comment style that is not currently supported, we are open to adding them! Pull requests welcome. Note that different comment styles have no semantic difference, only their content does. + +You can set your own background color for highlighted code line in your `src/css/custom.css` which will better fit to your selected syntax highlighting theme. The color given below works for the default highlighting theme (Palenight), so if you are using another theme, you will have to tweak the color accordingly. + +```css title="/src/css/custom.css" +:root { + --docusaurus-highlighted-code-line-bg: rgb(72, 77, 91); +} + +/* If you have a different syntax highlighting theme for dark mode. */ +[data-theme='dark'] { + /* Color which works with dark mode syntax highlighting theme */ + --docusaurus-highlighted-code-line-bg: rgb(100, 100, 100); +} +``` + +If you also need to style the highlighted code line in some other way, you can target on `theme-code-block-highlighted-line` CSS class. + +### Highlighting with metadata string {#highlighting-with-metadata-string} + +You can also specify highlighted line ranges within the language meta string (leave a space after the language). To highlight multiple lines, separate the line numbers by commas or use the range syntax to select a chunk of lines. This feature uses the `parse-number-range` library and you can find [more syntax](https://www.npmjs.com/package/parse-numeric-range) on their project details. + +````md +```jsx {1,4-6,11} +import React from 'react'; + +function MyComponent(props) { + if (props.isBar) { + return
    Bar
    ; + } + + return
    Foo
    ; +} + +export default MyComponent; +``` +```` + +```mdx-code-block + +``` + +```jsx {1,4-6,11} +import React from 'react'; + +function MyComponent(props) { + if (props.isBar) { + return
    Bar
    ; + } + + return
    Foo
    ; +} + +export default MyComponent; +``` + +```mdx-code-block +
    +``` + +:::tip prefer comments + +Prefer highlighting with comments where you can. By inlining highlight in the code, you don't have to manually count the lines if your code block becomes long. If you add/remove lines, you also don't have to offset your line ranges. + +````diff +- ```jsx {3} ++ ```jsx {4} + function HighlightSomeText(highlight) { + if (highlight) { ++ console.log('Highlighted text found'); + return 'This text is highlighted!'; + } + + return 'Nothing highlighted'; + } + ``` +```` + +Below, we will introduce how the magic comment system can be extended to define custom directives and their functionalities. The magic comments would only be parsed if a highlight metastring is not present. + +::: + +### Custom magic comments {#custom-magic-comments} + +`// highlight-next-line` and `// highlight-start` etc. are called "magic comments", because they will be parsed and removed, and their purposes are to add metadata to the next line, or the section that the pair of start- and end-comments enclose. + +You can declare custom magic comments through theme config. For example, you can register another magic comment that adds a `code-block-error-line` class name: + +```mdx-code-block + + +``` + +```js +export default { + themeConfig: { + prism: { + magicComments: [ + // Remember to extend the default highlight class name as well! + { + className: 'theme-code-block-highlighted-line', + line: 'highlight-next-line', + block: {start: 'highlight-start', end: 'highlight-end'}, + }, + // highlight-start + { + className: 'code-block-error-line', + line: 'This will error', + }, + // highlight-end + ], + }, + }, +}; +``` + +```mdx-code-block + + +``` + +```css +.code-block-error-line { + background-color: #ff000020; + display: block; + margin: 0 calc(-1 * var(--ifm-pre-padding)); + padding: 0 var(--ifm-pre-padding); + border-left: 3px solid #ff000080; +} +``` + +```mdx-code-block + + +``` + +````md +In JavaScript, trying to access properties on `null` will error. + +```js +const name = null; +// This will error +console.log(name.toUpperCase()); +// Uncaught TypeError: Cannot read properties of null (reading 'toUpperCase') +``` +```` + +```mdx-code-block + + +``` + +```mdx-code-block + +``` + +In JavaScript, trying to access properties on `null` will error. + +```js +const name = null; +// This will error +console.log(name.toUpperCase()); +// Uncaught TypeError: Cannot read properties of null (reading 'toUpperCase') +``` + +```mdx-code-block + +``` + +If you use number ranges in metastring (the `{1,3-4}` syntax), Docusaurus will apply the **first `magicComments` entry**'s class name. This, by default, is `theme-code-block-highlighted-line`, but if you change the `magicComments` config and use a different entry as the first one, the meaning of the metastring range will change as well. + +You can disable the default line highlighting comments with `magicComments: []`. If there's no magic comment config, but Docusaurus encounters a code block containing a metastring range, it will error because there will be no class name to apply—the highlighting class name, after all, is just a magic comment entry. + +Every magic comment entry will contain three keys: `className` (required), `line`, which applies to the directly next line, or `block` (containing `start` and `end`), which applies to the entire block enclosed by the two comments. + +Using CSS to target the class can already do a lot, but you can unlock the full potential of this feature through [swizzling](../../swizzling.mdx). + +```bash npm2yarn +npm run swizzle @docusaurus/theme-classic CodeBlock/Line +``` + +The `Line` component will receive the list of class names, based on which you can conditionally render different markup. + +## Line numbering {#line-numbering} + +You can enable line numbering for your code block by using `showLineNumbers` key within the language meta string (don't forget to add space directly before the key). + +````md +```jsx showLineNumbers +import React from 'react'; + +export default function MyComponent(props) { + return
    Foo
    ; +} +``` +```` + +```mdx-code-block + +``` + +```jsx showLineNumbers +import React from 'react'; + +export default function MyComponent(props) { + return
    Foo
    ; +} +``` + +```mdx-code-block +
    +``` + +By default, the counter starts at line number 1. It's possible to pass a custom counter start value to split large code blocks for readability: + +````md +```jsx showLineNumbers=3 +export default function MyComponent(props) { + return
    Foo
    ; +} +``` +```` + +```mdx-code-block + +``` + +```jsx showLineNumbers=3 +export default function MyComponent(props) { + return
    Foo
    ; +} +``` + +```mdx-code-block +
    +``` + +## Interactive code editor {#interactive-code-editor} + +(Powered by [React Live](https://github.com/FormidableLabs/react-live)) + +You can create an interactive coding editor with the `@docusaurus/theme-live-codeblock` plugin. First, add the plugin to your package. + +```bash npm2yarn +npm install --save @docusaurus/theme-live-codeblock +``` + +You will also need to add the plugin to your `docusaurus.config.js`. + +```js {3} +export default { + // ... + themes: ['@docusaurus/theme-live-codeblock'], + // ... +}; +``` + +To use the plugin, create a code block with `live` attached to the language meta string. + +````md +```jsx live +function Clock(props) { + const [date, setDate] = useState(new Date()); + useEffect(() => { + const timerID = setInterval(() => tick(), 1000); + + return function cleanup() { + clearInterval(timerID); + }; + }); + + function tick() { + setDate(new Date()); + } + + return ( +
    +

    It is {date.toLocaleTimeString()}.

    +
    + ); +} +``` +```` + +The code block will be rendered as an interactive editor. Changes to the code will reflect on the result panel live. + +```mdx-code-block + +``` + +```jsx live +function Clock(props) { + const [date, setDate] = useState(new Date()); + useEffect(() => { + const timerID = setInterval(() => tick(), 1000); + + return function cleanup() { + clearInterval(timerID); + }; + }); + + function tick() { + setDate(new Date()); + } + + return ( +
    +

    It is {date.toLocaleTimeString()}.

    +
    + ); +} +``` + +```mdx-code-block +
    +``` + +### Imports {#imports} + +:::warning react-live and imports + +It is not possible to import components directly from the react-live code editor, you have to define available imports upfront. + +::: + +By default, all React imports are available. If you need more imports available, swizzle the react-live scope: + +```bash npm2yarn +npm run swizzle @docusaurus/theme-live-codeblock ReactLiveScope -- --eject +``` + +```jsx title="src/theme/ReactLiveScope/index.js" +import React from 'react'; + +// highlight-start +const ButtonExample = (props) => ( +