mirror of
https://github.com/facebook/docusaurus.git
synced 2025-04-28 17:57:48 +02:00
Compare commits
139 commits
Author | SHA1 | Date | |
---|---|---|---|
|
67924ca979 | ||
|
bf6f574383 | ||
|
730ce485ba | ||
|
5b944d6b64 | ||
|
ac0a6f7d5b | ||
|
72b8621515 | ||
|
535c1c9835 | ||
|
29d19a6884 | ||
|
387157205a | ||
|
e9dfecbce7 | ||
|
df5f465605 | ||
|
67248f8e66 | ||
|
e8e67e9b9e | ||
|
08467e5f51 | ||
|
abdd0c7995 | ||
|
979ae084a7 | ||
|
6215983cdd | ||
|
b7ba0b54fb | ||
|
31b279fea6 | ||
|
d28210d35b | ||
|
f6bdc3123b | ||
|
16e3002911 | ||
|
a05629eeb5 | ||
|
3176a2ccba | ||
|
c0f3755d51 | ||
|
dae29a2782 | ||
|
37d8844506 | ||
|
8881fd1a59 | ||
|
e64e0e7c96 | ||
|
43fdb825e8 | ||
|
fcee060f40 | ||
|
502b9007be | ||
|
3782244ce7 | ||
|
e88f1aaf96 | ||
|
1d4d17da18 | ||
|
b0b95ccff9 | ||
|
579bb5ad37 | ||
|
7d36e2a8ff | ||
|
39eded7b69 | ||
|
cb69b40c86 | ||
|
7cf94c03a4 | ||
|
fd51384cab | ||
|
549ab795c3 | ||
|
e2e85e6b50 | ||
|
15b0ef6d13 | ||
|
d33004da1e | ||
|
dec3bcbbd7 | ||
|
2976dfea72 | ||
|
4d3930f944 | ||
|
7f4a37949e | ||
|
a6ef3897e0 | ||
|
396deedba4 | ||
|
9d7ceec189 | ||
|
154c95c11c | ||
|
f31bfec3c9 | ||
|
ca035d8562 | ||
|
c10a18d51d | ||
|
e641568e7f | ||
|
5b848cb2f0 | ||
|
cdc3ba31d9 | ||
|
1a71b3863a | ||
|
871af414a5 | ||
|
75e5a00a66 | ||
|
af272bdefa | ||
|
a72a06ecb1 | ||
|
04f7972f32 | ||
|
45065e8d2b | ||
|
cd7875bf84 | ||
|
5331de2962 | ||
|
c5a793de9d | ||
|
cd2792775e | ||
|
3fde4a0d6a | ||
|
b76f0feadc | ||
|
0162f6abc6 | ||
|
801bc7f74a | ||
|
987eb1c6d2 | ||
|
f73d401d3a | ||
|
a0248ed404 | ||
|
3198de8c45 | ||
|
dee39835a1 | ||
|
7ca3aa5144 | ||
|
884f93eea8 | ||
|
3b72bb43db | ||
|
bc3445c344 | ||
|
78f44d0ae7 | ||
|
4d7a28963a | ||
|
8bc3e8a092 | ||
|
d025403f73 | ||
|
5dc472759f | ||
|
b6d9fe2843 | ||
|
98aab81388 | ||
|
042070cf9d | ||
|
9700d47d69 | ||
|
9df5aae6de | ||
|
67207bc5e5 | ||
|
e59355be76 | ||
|
fcc9e5c56a | ||
|
5a50522905 | ||
|
97690abc94 | ||
|
35259521e0 | ||
|
431526ecbc | ||
|
0df69844b6 | ||
|
c17b55b58f | ||
|
71d682c53b | ||
|
cacb973326 | ||
|
94a56fef08 | ||
|
1b44d7ae3c | ||
|
bdbdd5aff5 | ||
|
9800180f57 | ||
|
56ccf19063 | ||
|
43795fcabb | ||
|
cc97d66dbb | ||
|
e8ad3923ea | ||
|
e7a8c9db82 | ||
|
092238d0fa | ||
|
4a1ec52922 | ||
|
37184e581d | ||
|
e5ed9a3894 | ||
|
0f29a37b3a | ||
|
f196a1eb29 | ||
|
2565601af3 | ||
|
87a5ab9177 | ||
|
b5359db47e | ||
|
c5a6c26d94 | ||
|
9cefca42df | ||
|
91c0b5bf35 | ||
|
4966dce36e | ||
|
f9825af43e | ||
|
e9f0641620 | ||
|
01cad20b5a | ||
|
a995865314 | ||
|
df6f53a2f5 | ||
|
750edc78ff | ||
|
8098741245 | ||
|
1777b14566 | ||
|
fb7ad2c1bb | ||
|
ffdd415129 | ||
|
60499e2cdc | ||
|
fd43036ab8 |
929 changed files with 38850 additions and 8045 deletions
|
@ -21,11 +21,14 @@
|
|||
],
|
||||
"ignorePaths": [
|
||||
"CHANGELOG.md",
|
||||
"patches",
|
||||
"packages/docusaurus-theme-translations/locales",
|
||||
"packages/docusaurus-plugin-ideal-image/src/theme/IdealImageLegacy",
|
||||
"package.json",
|
||||
"yarn.lock",
|
||||
"project-words.txt",
|
||||
"__snapshots__",
|
||||
"admin/scripts",
|
||||
"website/src/data/users.tsx",
|
||||
"website/src/data/tweets.tsx",
|
||||
"website/docusaurus.config.localized.json",
|
||||
|
|
|
@ -1,32 +1,36 @@
|
|||
{
|
||||
"image": "mcr.microsoft.com/devcontainers/base:ubuntu-22.04",
|
||||
"settings": {
|
||||
"[typescript]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
||||
"editor.formatOnSave": true
|
||||
},
|
||||
"[json]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
||||
"editor.formatOnSave": true
|
||||
},
|
||||
"[jsonc]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
||||
"editor.formatOnSave": true
|
||||
"image": "mcr.microsoft.com/devcontainers/base:ubuntu-24.04",
|
||||
"customizations": {
|
||||
"vscode": {
|
||||
"settings": {
|
||||
"[typescript]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
||||
"editor.formatOnSave": true
|
||||
},
|
||||
"[json]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
||||
"editor.formatOnSave": true
|
||||
},
|
||||
"[jsonc]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
||||
"editor.formatOnSave": true
|
||||
}
|
||||
},
|
||||
"extensions": [
|
||||
"dbaeumer.vscode-eslint",
|
||||
"orta.vscode-jest",
|
||||
"esbenp.prettier-vscode",
|
||||
"streetsidesoftware.code-spell-checker"
|
||||
]
|
||||
}
|
||||
},
|
||||
"extensions": [
|
||||
"dbaeumer.vscode-eslint",
|
||||
"orta.vscode-jest",
|
||||
"esbenp.prettier-vscode",
|
||||
"streetsidesoftware.code-spell-checker"
|
||||
],
|
||||
"forwardPorts": [3000],
|
||||
"containerUser": "vscode",
|
||||
"postCreateCommand": "yarn install",
|
||||
"waitFor": "postCreateCommand", // otherwise automated jest tests fail
|
||||
"features": {
|
||||
"node": {
|
||||
"version": "18"
|
||||
"version": "22"
|
||||
},
|
||||
"github-cli": "latest"
|
||||
}
|
||||
|
|
|
@ -22,3 +22,6 @@ packages/create-docusaurus/templates/facebook
|
|||
|
||||
website/_dogfooding/_swizzle_theme_tests
|
||||
website/_dogfooding/_asset-tests/badSyntax.js
|
||||
|
||||
|
||||
packages/docusaurus-plugin-ideal-image/src/theme/IdealImageLegacy
|
||||
|
|
13
.eslintrc.js
vendored
13
.eslintrc.js
vendored
|
@ -60,6 +60,7 @@ module.exports = {
|
|||
},
|
||||
reportUnusedDisableDirectives: true,
|
||||
plugins: [
|
||||
'react-compiler',
|
||||
'react-hooks',
|
||||
'header',
|
||||
'jest',
|
||||
|
@ -68,6 +69,7 @@ module.exports = {
|
|||
'@docusaurus',
|
||||
],
|
||||
rules: {
|
||||
'react-compiler/react-compiler': ERROR,
|
||||
'react/jsx-uses-react': OFF, // JSX runtime: automatic
|
||||
'react/react-in-jsx-scope': OFF, // JSX runtime: automatic
|
||||
'array-callback-return': WARNING,
|
||||
|
@ -296,7 +298,7 @@ module.exports = {
|
|||
'jest/expect-expect': OFF,
|
||||
'jest/no-large-snapshots': [
|
||||
WARNING,
|
||||
{maxSize: Infinity, inlineMaxSize: 10},
|
||||
{maxSize: Infinity, inlineMaxSize: 50},
|
||||
],
|
||||
'jest/no-test-return-statement': ERROR,
|
||||
'jest/prefer-expect-resolves': WARNING,
|
||||
|
@ -380,7 +382,14 @@ module.exports = {
|
|||
// We don't provide any escape hatches for this rule. Rest siblings and
|
||||
// function placeholder params are always ignored, and any other unused
|
||||
// locals must be justified with a disable comment.
|
||||
'@typescript-eslint/no-unused-vars': [ERROR, {ignoreRestSiblings: true}],
|
||||
'@typescript-eslint/no-unused-vars': [
|
||||
ERROR,
|
||||
{
|
||||
ignoreRestSiblings: true,
|
||||
argsIgnorePattern: '^_',
|
||||
varsIgnorePattern: '^_',
|
||||
},
|
||||
],
|
||||
'@typescript-eslint/prefer-optional-chain': ERROR,
|
||||
'@docusaurus/no-html-links': ERROR,
|
||||
'@docusaurus/prefer-docusaurus-heading': ERROR,
|
||||
|
|
2
.github/workflows/argos.yml
vendored
2
.github/workflows/argos.yml
vendored
|
@ -30,7 +30,7 @@ jobs:
|
|||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
|
||||
- name: Use Node.js
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: lts/*
|
||||
|
||||
|
|
2
.github/workflows/build-blog-only.yml
vendored
2
.github/workflows/build-blog-only.yml
vendored
|
@ -24,7 +24,7 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
- name: Set up Node
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: lts/*
|
||||
cache: yarn
|
||||
|
|
2
.github/workflows/build-hash-router.yml
vendored
2
.github/workflows/build-hash-router.yml
vendored
|
@ -27,7 +27,7 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
- name: Set up Node
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: lts/*
|
||||
cache: yarn
|
||||
|
|
11
.github/workflows/build-perf.yml
vendored
11
.github/workflows/build-perf.yml
vendored
|
@ -43,12 +43,12 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
- name: Set up Node
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: lts/*
|
||||
cache: yarn
|
||||
- name: Track build size changes
|
||||
uses: preactjs/compressed-size-action@6fa0e7ca017120c754863b31123c5ee2860fd434 # v2
|
||||
uses: preactjs/compressed-size-action@946a292cd35bd1088e0d7eb92b69d1a8d5b5d76a # v2
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
build-script: build:website:fast
|
||||
|
@ -75,7 +75,7 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
- name: Set up Node
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: lts/*
|
||||
cache: yarn
|
||||
|
@ -85,14 +85,15 @@ jobs:
|
|||
# Ensure build with a cold cache does not increase too much
|
||||
- name: Build (cold cache)
|
||||
run: yarn build:website:fast
|
||||
timeout-minutes: ${{ matrix.DOCUSAURUS_INFRA == 'SLOWER' && 3 || 1 }}
|
||||
timeout-minutes: ${{ matrix.DOCUSAURUS_INFRA == 'SLOWER' && 3 || 2 }}
|
||||
env:
|
||||
DOCUSAURUS_SLOWER: ${{ matrix.DOCUSAURUS_INFRA == 'SLOWER' && 'true' || 'false' }}
|
||||
|
||||
# Ensure build with a warm cache does not increase too much
|
||||
- name: Build (warm cache)
|
||||
run: yarn build:website:fast
|
||||
timeout-minutes: 1
|
||||
# Temporary: upper value for Rspack until incremental cache works better
|
||||
timeout-minutes: ${{ matrix.DOCUSAURUS_INFRA == 'SLOWER' && 1 || 2 }}
|
||||
env:
|
||||
DOCUSAURUS_SLOWER: ${{ matrix.DOCUSAURUS_INFRA == 'SLOWER' && 'true' || 'false' }}
|
||||
|
||||
|
|
2
.github/workflows/canary-release.yml
vendored
2
.github/workflows/canary-release.yml
vendored
|
@ -24,7 +24,7 @@ jobs:
|
|||
with:
|
||||
fetch-depth: 0 # Needed to get the commit number with "git rev-list --count HEAD"
|
||||
- name: Set up Node
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: lts/*
|
||||
cache: yarn
|
||||
|
|
2
.github/workflows/continuous-releases.yml
vendored
2
.github/workflows/continuous-releases.yml
vendored
|
@ -21,7 +21,7 @@ jobs:
|
|||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
|
||||
- name: Set up Node
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: lts/*
|
||||
cache: yarn
|
||||
|
|
2
.github/workflows/dependency-review.yml
vendored
2
.github/workflows/dependency-review.yml
vendored
|
@ -15,4 +15,4 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
- name: Dependency Review
|
||||
uses: actions/dependency-review-action@4081bf99e2866ebe428fc0477b69eb4fcda7220a # 4.4.0
|
||||
uses: actions/dependency-review-action@ce3cf9537a52e8119d91fd484ab5b8a807627bf8 # 4.6.0
|
||||
|
|
4
.github/workflows/lighthouse-report.yml
vendored
4
.github/workflows/lighthouse-report.yml
vendored
|
@ -24,7 +24,7 @@ jobs:
|
|||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
|
||||
- name: Use Node.js
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: lts/*
|
||||
|
||||
|
@ -64,7 +64,7 @@ jobs:
|
|||
|
||||
- name: Add Lighthouse stats as comment
|
||||
id: comment_to_pr
|
||||
uses: marocchino/sticky-pull-request-comment@331f8f5b4215f0445d3c07b4967662a32a2d3e31 # 2.9.0
|
||||
uses: marocchino/sticky-pull-request-comment@67d0dec7b07ed060a405f9b2a64b8ab319fdd7db # 2.9.2
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
number: ${{ github.event.pull_request.number }}
|
||||
|
|
4
.github/workflows/lint.yml
vendored
4
.github/workflows/lint.yml
vendored
|
@ -22,7 +22,7 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
- name: Set up Node
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: lts/*
|
||||
cache: yarn
|
||||
|
@ -33,7 +33,7 @@ jobs:
|
|||
|
||||
- name: Check for suspicious yarn.lock
|
||||
# for allowed aliases, see https://github.com/yargs/cliui/pull/139/files#r1670711112
|
||||
run: yarn lockfile-lint --path yarn.lock --type yarn --allowed-hosts yarn --validate-https --validate-package-names --validate-integrity --empty-hostname=false --allowed-package-name-aliases react-loadable string-width-cjs strip-ansi-cjs wrap-ansi-cjs
|
||||
run: yarn lockfile-lint --path yarn.lock --type yarn --allowed-hosts yarn --validate-https --validate-package-names --validate-integrity --empty-hostname=false --allowed-package-name-aliases react-loadable react-helmet-async string-width-cjs strip-ansi-cjs wrap-ansi-cjs
|
||||
|
||||
- name: Lint
|
||||
run: |
|
||||
|
|
2
.github/workflows/showcase-test.yml
vendored
2
.github/workflows/showcase-test.yml
vendored
|
@ -24,7 +24,7 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
- name: Set up Node
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: lts/*
|
||||
cache: yarn
|
||||
|
|
14
.github/workflows/tests-e2e.yml
vendored
14
.github/workflows/tests-e2e.yml
vendored
|
@ -43,7 +43,7 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
- name: Use Node.js ${{ matrix.node }}
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: ${{ matrix.node }}
|
||||
cache: yarn
|
||||
|
@ -68,7 +68,7 @@ jobs:
|
|||
env:
|
||||
# Our website should build even with limited memory
|
||||
# See https://github.com/facebook/docusaurus/pull/10590
|
||||
NODE_OPTIONS: '--max-old-space-size=250'
|
||||
NODE_OPTIONS: '--max-old-space-size=300'
|
||||
DOCUSAURUS_PERF_LOGGER: 'true'
|
||||
working-directory: ../test-website
|
||||
|
||||
|
@ -84,7 +84,7 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
- name: Use Node.js LTS
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: lts/*
|
||||
cache: yarn
|
||||
|
@ -153,7 +153,7 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
- name: Use Node.js LTS
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: lts/*
|
||||
cache: yarn
|
||||
|
@ -181,7 +181,7 @@ jobs:
|
|||
env:
|
||||
# Our website should build even with limited memory
|
||||
# See https://github.com/facebook/docusaurus/pull/10590
|
||||
NODE_OPTIONS: '--max-old-space-size=250'
|
||||
NODE_OPTIONS: '--max-old-space-size=300'
|
||||
DOCUSAURUS_PERF_LOGGER: 'true'
|
||||
working-directory: ../test-website
|
||||
|
||||
|
@ -193,7 +193,7 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
- name: Use Node.js LTS
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: lts/*
|
||||
cache: yarn
|
||||
|
@ -223,6 +223,6 @@ jobs:
|
|||
env:
|
||||
# Our website should build even with limited memory
|
||||
# See https://github.com/facebook/docusaurus/pull/10590
|
||||
NODE_OPTIONS: '--max-old-space-size=250'
|
||||
NODE_OPTIONS: '--max-old-space-size=300'
|
||||
DOCUSAURUS_PERF_LOGGER: 'true'
|
||||
working-directory: ../test-website
|
||||
|
|
2
.github/workflows/tests-swizzle.yml
vendored
2
.github/workflows/tests-swizzle.yml
vendored
|
@ -28,7 +28,7 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
- name: Set up Node LTS
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: lts/*
|
||||
cache: yarn
|
||||
|
|
2
.github/workflows/tests-windows.yml
vendored
2
.github/workflows/tests-windows.yml
vendored
|
@ -34,7 +34,7 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
- name: Use Node.js ${{ matrix.node }}
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: ${{ matrix.node }}
|
||||
- name: Installation
|
||||
|
|
4
.github/workflows/tests.yml
vendored
4
.github/workflows/tests.yml
vendored
|
@ -32,7 +32,7 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||
- name: Use Node.js ${{ matrix.node }}
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version: ${{ matrix.node }}
|
||||
cache: yarn
|
||||
|
@ -49,7 +49,7 @@ jobs:
|
|||
env:
|
||||
# Our website should build even with limited memory
|
||||
# See https://github.com/facebook/docusaurus/pull/10590
|
||||
NODE_OPTIONS: '--max-old-space-size=400'
|
||||
NODE_OPTIONS: '--max-old-space-size=450'
|
||||
DOCUSAURUS_PERF_LOGGER: 'true'
|
||||
- name: Docusaurus site CSS order
|
||||
run: yarn workspace website test:css-order
|
||||
|
|
3
.gitignore
vendored
3
.gitignore
vendored
|
@ -45,3 +45,6 @@ website/i18n/**/*
|
|||
#!website/i18n/fr/**/*
|
||||
|
||||
.netlify
|
||||
|
||||
website/rspack-tracing.json
|
||||
website/bundler-cpu-profile.json
|
||||
|
|
|
@ -4,6 +4,7 @@ node_modules
|
|||
build
|
||||
coverage
|
||||
.docusaurus
|
||||
.idea
|
||||
|
||||
.svg
|
||||
*.svg
|
||||
|
|
87
CHANGELOG.md
87
CHANGELOG.md
|
@ -1,5 +1,92 @@
|
|||
# Docusaurus Changelog
|
||||
|
||||
## 3.7.0 (2025-01-03)
|
||||
|
||||
#### :rocket: New Feature
|
||||
|
||||
- `docusaurus-faster`, `docusaurus`
|
||||
- [#10800](https://github.com/facebook/docusaurus/pull/10800) feat(core): Turn Rspack incremental on by default (again) ([@slorber](https://github.com/slorber))
|
||||
- `docusaurus-plugin-content-blog`, `docusaurus-theme-classic`
|
||||
- [#10768](https://github.com/facebook/docusaurus/pull/10768) feat(blog): Add author social icons for bluesky, mastodon, threads, twitch, youtube, instagram ([@GingerGeek](https://github.com/GingerGeek))
|
||||
- `create-docusaurus`, `docusaurus-mdx-loader`, `docusaurus-module-type-aliases`, `docusaurus-plugin-client-redirects`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-content-pages`, `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-theme-classic`, `docusaurus-theme-common`, `docusaurus-theme-live-codeblock`, `docusaurus-theme-mermaid`, `docusaurus-theme-search-algolia`, `docusaurus-types`, `docusaurus`
|
||||
- [#10763](https://github.com/facebook/docusaurus/pull/10763) feat: Add React 19 support to Docusaurus v3 ([@slorber](https://github.com/slorber))
|
||||
- `docusaurus-plugin-content-blog`
|
||||
- [#10729](https://github.com/facebook/docusaurus/pull/10729) feat(blog): Add `frontMatter.sidebar_label` ([@slorber](https://github.com/slorber))
|
||||
- `docusaurus-module-type-aliases`, `docusaurus-plugin-svgr`, `docusaurus-preset-classic`, `docusaurus-types`, `docusaurus-utils`, `docusaurus`
|
||||
- [#10677](https://github.com/facebook/docusaurus/pull/10677) feat(svgr): create new Docusaurus SVGR plugin ([@slorber](https://github.com/slorber))
|
||||
|
||||
#### :bug: Bug Fix
|
||||
|
||||
- `docusaurus-remark-plugin-npm2yarn`
|
||||
- [#10803](https://github.com/facebook/docusaurus/pull/10803) fix(npm-to-yarn): add missing npm-to-yarn converter for Bun ([@Lehoczky](https://github.com/Lehoczky))
|
||||
- `docusaurus-theme-classic`, `docusaurus-theme-common`
|
||||
- [#10796](https://github.com/facebook/docusaurus/pull/10796) fix(theme): Footer Column/Link should merge provided className ([@slorber](https://github.com/slorber))
|
||||
- `docusaurus-bundler`, `docusaurus-theme-common`
|
||||
- [#10786](https://github.com/facebook/docusaurus/pull/10786) fix(core): fix React hydration errors, change html minifier settings ([@slorber](https://github.com/slorber))
|
||||
- `docusaurus-theme-common`
|
||||
- [#10782](https://github.com/facebook/docusaurus/pull/10782) fix(theme-common): code block magic comments should support SQL block comments ([@WillBlack403](https://github.com/WillBlack403))
|
||||
- `docusaurus-theme-translations`
|
||||
- [#10783](https://github.com/facebook/docusaurus/pull/10783) fix(theme-translations): Add missing Dutch (nl) theme translations ([@janaukema](https://github.com/janaukema))
|
||||
- [#10760](https://github.com/facebook/docusaurus/pull/10760) fix(theme-translation): add missing Korean (ko) theme translations ([@effozen](https://github.com/effozen))
|
||||
- `docusaurus-plugin-content-docs`
|
||||
- [#10754](https://github.com/facebook/docusaurus/pull/10754) fix(docs): fix sidebar item visibility bug for category index ([@slorber](https://github.com/slorber))
|
||||
- `docusaurus`
|
||||
- [#10727](https://github.com/facebook/docusaurus/pull/10727) fix(core): fix codegen routesChunkName possible hash collision ([@slorber](https://github.com/slorber))
|
||||
- `docusaurus-mdx-loader`
|
||||
- [#10723](https://github.com/facebook/docusaurus/pull/10723) fix(mdx-loader): fix md image paths with spaces bug related to transformImage encoding problem ([@slorber](https://github.com/slorber))
|
||||
|
||||
#### :memo: Documentation
|
||||
|
||||
- [#10740](https://github.com/facebook/docusaurus/pull/10740) docs: Link initialization docs together ([@waldyrious](https://github.com/waldyrious))
|
||||
|
||||
#### :robot: Dependencies
|
||||
|
||||
- [#10771](https://github.com/facebook/docusaurus/pull/10771) chore(deps): bump nanoid from 3.3.7 to 3.3.8 ([@dependabot[bot]](https://github.com/apps/dependabot))
|
||||
- [#10721](https://github.com/facebook/docusaurus/pull/10721) chore(deps): bump actions/dependency-review-action from 4.4.0 to 4.5.0 ([@dependabot[bot]](https://github.com/apps/dependabot))
|
||||
|
||||
#### :wrench: Maintenance
|
||||
|
||||
- Other
|
||||
- [#10770](https://github.com/facebook/docusaurus/pull/10770) chore: Devcontainer upgrade to Ubuntu Noble & Node 22 ([@GingerGeek](https://github.com/GingerGeek))
|
||||
- `docusaurus-theme-search-algolia`
|
||||
- [#10801](https://github.com/facebook/docusaurus/pull/10801) refactor(algolia): simplify SearchBar component ([@slorber](https://github.com/slorber))
|
||||
- [#10672](https://github.com/facebook/docusaurus/pull/10672) chore(algolia): upgrade algoliasearch to v5 ([@millotp](https://github.com/millotp))
|
||||
- `docusaurus`
|
||||
- [#10798](https://github.com/facebook/docusaurus/pull/10798) refactor(core): Use Intl native API to get locale direction, remove rtl-detect depend… ([@slorber](https://github.com/slorber))
|
||||
- [#10747](https://github.com/facebook/docusaurus/pull/10747) refactor(core): swizzle wrap should use ReactNode instead of JSX.Element ([@slorber](https://github.com/slorber))
|
||||
- `create-docusaurus`, `docusaurus-mdx-loader`, `docusaurus-module-type-aliases`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-content-pages`, `docusaurus-plugin-debug`, `docusaurus-plugin-ideal-image`, `docusaurus-plugin-pwa`, `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-theme-live-codeblock`, `docusaurus-theme-mermaid`, `docusaurus-theme-search-algolia`, `docusaurus-types`, `docusaurus`
|
||||
- [#10746](https://github.com/facebook/docusaurus/pull/10746) refactor: prepare types for React 19 ([@slorber](https://github.com/slorber))
|
||||
- `docusaurus-theme-common`
|
||||
- [#10728](https://github.com/facebook/docusaurus/pull/10728) refactor(theme-common): change storageUtils useSyncExternalCode getSnapshot workaround ([@slorber](https://github.com/slorber))
|
||||
|
||||
#### Committers: 14
|
||||
|
||||
- Alvin Bryan ([@alvinometric](https://github.com/alvinometric))
|
||||
- Hichem Fantar ([@hichemfantar](https://github.com/hichemfantar))
|
||||
- Ivan Cheban ([@ivancheban](https://github.com/ivancheban))
|
||||
- Jake Boone ([@jakeboone02](https://github.com/jakeboone02))
|
||||
- Jan Aukema ([@janaukema](https://github.com/janaukema))
|
||||
- Lehoczky Zoltán ([@Lehoczky](https://github.com/Lehoczky))
|
||||
- Lin Huang ([@codimiracle](https://github.com/codimiracle))
|
||||
- Pierre Millot ([@millotp](https://github.com/millotp))
|
||||
- Sébastien Lorber ([@slorber](https://github.com/slorber))
|
||||
- Taylor Reece ([@taylorreece](https://github.com/taylorreece))
|
||||
- Waldir Pimenta ([@waldyrious](https://github.com/waldyrious))
|
||||
- William Black ([@WillBlack403](https://github.com/WillBlack403))
|
||||
- Zed Spencer-Milnes ([@GingerGeek](https://github.com/GingerGeek))
|
||||
- Zen ([@effozen](https://github.com/effozen))
|
||||
|
||||
## 3.6.3 (2024-11-22)
|
||||
|
||||
#### :bug: Bug Fix
|
||||
|
||||
- `docusaurus`
|
||||
- [#10712](https://github.com/facebook/docusaurus/pull/10712) fix(core): disable Rspack incremental in dev ([@slorber](https://github.com/slorber))
|
||||
|
||||
#### Committers: 1
|
||||
|
||||
- Sébastien Lorber ([@slorber](https://github.com/slorber))
|
||||
|
||||
## 3.6.2 (2024-11-19)
|
||||
|
||||
#### :bug: Bug Fix
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "new.docusaurus.io",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"start": "npx --package netlify-cli netlify dev"
|
||||
|
|
|
@ -9,9 +9,9 @@ import fs from 'fs-extra';
|
|||
import path from 'path';
|
||||
import {fileURLToPath} from 'url';
|
||||
import {program} from 'commander';
|
||||
import logger from '@docusaurus/logger';
|
||||
import {logger} from '@docusaurus/logger';
|
||||
import sharp from 'sharp';
|
||||
import imageSize from 'image-size';
|
||||
import {imageSizeFromFile} from 'image-size/fromFile';
|
||||
|
||||
// You can use it as:
|
||||
//
|
||||
|
@ -64,7 +64,7 @@ program
|
|||
|
||||
await Promise.all(
|
||||
images.map(async (imgPath) => {
|
||||
const {width, height} = imageSize(imgPath);
|
||||
const {width, height} = await imageSizeFromFile(imgPath);
|
||||
const targetWidth =
|
||||
options.width ?? (imgPath.includes(showcasePath) ? 640 : 1000);
|
||||
const targetHeight =
|
||||
|
|
|
@ -5,7 +5,9 @@
|
|||
# This source code is licensed under the MIT license found in the
|
||||
# LICENSE file in the root directory of this source tree.
|
||||
|
||||
set -euo pipefail
|
||||
set -xeuo pipefail
|
||||
|
||||
rm -rf ../test-website
|
||||
|
||||
CUSTOM_REGISTRY_URL="http://localhost:4873"
|
||||
NEW_VERSION="$(node -p "require('./packages/docusaurus/package.json').version")-NEW"
|
||||
|
@ -52,7 +54,8 @@ git diff --name-only -- '*.json' | sed 's, ,\\&,g' | xargs git checkout --
|
|||
cd ..
|
||||
|
||||
# Build skeleton website with new version
|
||||
npm_config_registry="$CUSTOM_REGISTRY_URL" npx create-docusaurus@"$NEW_VERSION" test-website classic --javascript $EXTRA_OPTS
|
||||
npm_config_registry="$CUSTOM_REGISTRY_URL" npx --yes --loglevel silly create-docusaurus@"$NEW_VERSION" test-website classic --javascript $EXTRA_OPTS
|
||||
|
||||
|
||||
# Stop Docker container
|
||||
if [[ -z "${KEEP_CONTAINER:-true}" ]] && ( $(docker container inspect "$CONTAINER_NAME" > /dev/null 2>&1) ); then
|
||||
|
|
|
@ -12,7 +12,7 @@ import {version as ReactVersion} from 'react';
|
|||
import {version as ReactDOMVersion} from 'react-dom';
|
||||
|
||||
export function TestComponent() {
|
||||
const expectedVersion = 18;
|
||||
const expectedVersion = 19;
|
||||
if (!ReactVersion.startsWith(`${expectedVersion}`)) {
|
||||
throw new Error(
|
||||
`'test-bad-package/README.mdx' is rendered with bad React version: ${ReactVersion}`,
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "test-bad-package",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
"@mdx-js/react": "1.0.1",
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "argos",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"description": "Argos visual diff tests",
|
||||
"license": "MIT",
|
||||
"private": true,
|
||||
|
|
|
@ -55,7 +55,6 @@ function isBlacklisted(pathname: string) {
|
|||
'/tests/pages/react-18',
|
||||
// Flaky because of hydration error
|
||||
'/tests/blog/archive',
|
||||
'/tests/docs/tests/custom-props',
|
||||
'/tests/pages/code-block-tests',
|
||||
'/tests/pages/embeds',
|
||||
// Flaky because of hydration error with docusaurus serve + .html
|
||||
|
@ -131,23 +130,18 @@ function throwOnConsole(page: Page) {
|
|||
const typesToCheck = ['error', 'warning'];
|
||||
|
||||
const ignoreMessages = [
|
||||
// This mismatch warning looks like a React 18 bug to me
|
||||
'Warning: Prop `%s` did not match. Server: %s Client: %s%s className "null" ""',
|
||||
|
||||
// TODO this fetch error message is unexpected and should be fixed
|
||||
// it's already happening in main branch
|
||||
'Failed to load resource: the server responded with a status of 404 (Not Found)',
|
||||
|
||||
// TODO looks like a legit hydration bug to fix
|
||||
// on /blog/releases/2.4
|
||||
'Warning: Prop `%s` did not match. Server: %s Client: %s%s href "/docs" "/docs?docusaurus-theme=light"',
|
||||
'Warning: Prop `%s` did not match. Server: %s Client: %s%s href "/docs" "/docs?docusaurus-theme=dark"',
|
||||
// on /blog/releases/3.0
|
||||
'Warning: Prop `%s` did not match. Server: %s Client: %s%s href "/docs" "/docs?docusaurus-data-navbar=false&docusaurus-data-red-border"',
|
||||
// on /docs/styling-layout
|
||||
'Warning: Prop `%s` did not match. Server: %s Client: %s%s href "/docs" "/docs?docusaurus-data-navbar=false&docusaurus-data-red-border"',
|
||||
'Warning: Prop `%s` did not match. Server: %s Client: %s%s href "/docs/configuration" "/docs/configuration?docusaurus-theme=light"',
|
||||
'Warning: Prop `%s` did not match. Server: %s Client: %s%s href "/docs/configuration" "/docs/configuration?docusaurus-theme=dark"',
|
||||
// TODO legit hydration bugs to fix on embeds of /docs/styling-layout
|
||||
// useLocation() returns window.search/hash immediately :s
|
||||
'/docs/configuration?docusaurus-theme=light',
|
||||
'/docs/configuration?docusaurus-theme=dark',
|
||||
|
||||
// Warning because react-live not supporting React automatic JSX runtime
|
||||
// See https://github.com/FormidableLabs/react-live/issues/405
|
||||
'Your app (or one of its dependencies) is using an outdated JSX transform. Update to the modern JSX transform for faster performance',
|
||||
|
||||
// TODO weird problem related to KaTeX fonts refusing to decode?
|
||||
// on /docs/markdown-features/math-equations
|
||||
|
|
2
examples/README.md
generated
2
examples/README.md
generated
|
@ -2,7 +2,7 @@
|
|||
|
||||
These example projects are generated with the init CLI:
|
||||
|
||||
```
|
||||
```bash
|
||||
npx @docusaurus/init@latest init examples/<templateName> <templateName>`
|
||||
```
|
||||
|
||||
|
|
10
examples/classic-typescript/README.md
generated
10
examples/classic-typescript/README.md
generated
|
@ -4,13 +4,13 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
|
|||
|
||||
### Installation
|
||||
|
||||
```
|
||||
```bash
|
||||
$ yarn
|
||||
```
|
||||
|
||||
### Local Development
|
||||
|
||||
```
|
||||
```bash
|
||||
$ yarn start
|
||||
```
|
||||
|
||||
|
@ -18,7 +18,7 @@ This command starts a local development server and opens up a browser window. Mo
|
|||
|
||||
### Build
|
||||
|
||||
```
|
||||
```bash
|
||||
$ yarn build
|
||||
```
|
||||
|
||||
|
@ -28,13 +28,13 @@ This command generates static content into the `build` directory and can be serv
|
|||
|
||||
Using SSH:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ USE_SSH=true yarn deploy
|
||||
```
|
||||
|
||||
Not using SSH:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ GIT_USER=<Your GitHub username> yarn deploy
|
||||
```
|
||||
|
||||
|
|
14
examples/classic-typescript/package.json
generated
14
examples/classic-typescript/package.json
generated
|
@ -16,18 +16,18 @@
|
|||
"dev": "docusaurus start"
|
||||
},
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "3.6.0",
|
||||
"@docusaurus/preset-classic": "3.6.0",
|
||||
"@docusaurus/core": "3.7.0",
|
||||
"@docusaurus/preset-classic": "3.7.0",
|
||||
"@mdx-js/react": "^3.0.0",
|
||||
"clsx": "^2.0.0",
|
||||
"prism-react-renderer": "^2.3.0",
|
||||
"react": "^18.0.0",
|
||||
"react-dom": "^18.0.0"
|
||||
"react": "^19.0.0",
|
||||
"react-dom": "^19.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@docusaurus/module-type-aliases": "3.6.0",
|
||||
"@docusaurus/tsconfig": "3.6.0",
|
||||
"@docusaurus/types": "3.6.0",
|
||||
"@docusaurus/module-type-aliases": "3.7.0",
|
||||
"@docusaurus/tsconfig": "3.7.0",
|
||||
"@docusaurus/types": "3.7.0",
|
||||
"typescript": "~5.6.2"
|
||||
},
|
||||
"browserslist": {
|
||||
|
|
|
@ -1,3 +1,4 @@
|
|||
import type {ReactNode} from 'react';
|
||||
import clsx from 'clsx';
|
||||
import Heading from '@theme/Heading';
|
||||
import styles from './styles.module.css';
|
||||
|
@ -5,7 +6,7 @@ import styles from './styles.module.css';
|
|||
type FeatureItem = {
|
||||
title: string;
|
||||
Svg: React.ComponentType<React.ComponentProps<'svg'>>;
|
||||
description: JSX.Element;
|
||||
description: ReactNode;
|
||||
};
|
||||
|
||||
const FeatureList: FeatureItem[] = [
|
||||
|
@ -55,7 +56,7 @@ function Feature({title, Svg, description}: FeatureItem) {
|
|||
);
|
||||
}
|
||||
|
||||
export default function HomepageFeatures(): JSX.Element {
|
||||
export default function HomepageFeatures(): ReactNode {
|
||||
return (
|
||||
<section className={styles.features}>
|
||||
<div className="container">
|
||||
|
|
3
examples/classic-typescript/src/pages/index.tsx
generated
3
examples/classic-typescript/src/pages/index.tsx
generated
|
@ -1,3 +1,4 @@
|
|||
import type {ReactNode} from 'react';
|
||||
import clsx from 'clsx';
|
||||
import Link from '@docusaurus/Link';
|
||||
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
||||
|
@ -28,7 +29,7 @@ function HomepageHeader() {
|
|||
);
|
||||
}
|
||||
|
||||
export default function Home(): JSX.Element {
|
||||
export default function Home(): ReactNode {
|
||||
const {siteConfig} = useDocusaurusContext();
|
||||
return (
|
||||
<Layout
|
||||
|
|
3
examples/classic-typescript/tsconfig.json
generated
3
examples/classic-typescript/tsconfig.json
generated
|
@ -3,5 +3,6 @@
|
|||
"extends": "@docusaurus/tsconfig",
|
||||
"compilerOptions": {
|
||||
"baseUrl": "."
|
||||
}
|
||||
},
|
||||
"exclude": [".docusaurus", "build"]
|
||||
}
|
||||
|
|
2542
examples/classic-typescript/yarn.lock
generated
2542
examples/classic-typescript/yarn.lock
generated
File diff suppressed because it is too large
Load diff
10
examples/classic/README.md
generated
10
examples/classic/README.md
generated
|
@ -4,13 +4,13 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
|
|||
|
||||
### Installation
|
||||
|
||||
```
|
||||
```bash
|
||||
$ yarn
|
||||
```
|
||||
|
||||
### Local Development
|
||||
|
||||
```
|
||||
```bash
|
||||
$ yarn start
|
||||
```
|
||||
|
||||
|
@ -18,7 +18,7 @@ This command starts a local development server and opens up a browser window. Mo
|
|||
|
||||
### Build
|
||||
|
||||
```
|
||||
```bash
|
||||
$ yarn build
|
||||
```
|
||||
|
||||
|
@ -28,13 +28,13 @@ This command generates static content into the `build` directory and can be serv
|
|||
|
||||
Using SSH:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ USE_SSH=true yarn deploy
|
||||
```
|
||||
|
||||
Not using SSH:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ GIT_USER=<Your GitHub username> yarn deploy
|
||||
```
|
||||
|
||||
|
|
12
examples/classic/package.json
generated
12
examples/classic/package.json
generated
|
@ -15,17 +15,17 @@
|
|||
"dev": "docusaurus start"
|
||||
},
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "3.6.0",
|
||||
"@docusaurus/preset-classic": "3.6.0",
|
||||
"@docusaurus/core": "3.7.0",
|
||||
"@docusaurus/preset-classic": "3.7.0",
|
||||
"@mdx-js/react": "^3.0.0",
|
||||
"clsx": "^2.0.0",
|
||||
"prism-react-renderer": "^2.3.0",
|
||||
"react": "^18.0.0",
|
||||
"react-dom": "^18.0.0"
|
||||
"react": "^19.0.0",
|
||||
"react-dom": "^19.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@docusaurus/module-type-aliases": "3.6.0",
|
||||
"@docusaurus/types": "3.6.0"
|
||||
"@docusaurus/module-type-aliases": "3.7.0",
|
||||
"@docusaurus/types": "3.7.0"
|
||||
},
|
||||
"browserslist": {
|
||||
"production": [
|
||||
|
|
2534
examples/classic/yarn.lock
generated
2534
examples/classic/yarn.lock
generated
File diff suppressed because it is too large
Load diff
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"npmClient": "yarn",
|
||||
"useWorkspaces": true,
|
||||
"useNx": false,
|
||||
|
@ -13,7 +13,8 @@
|
|||
"pr: polish": ":nail_care: Polish",
|
||||
"pr: documentation": ":memo: Documentation",
|
||||
"pr: dependencies": ":robot: Dependencies",
|
||||
"pr: maintenance": ":wrench: Maintenance"
|
||||
"pr: maintenance": ":wrench: Maintenance",
|
||||
"pr: translations": ":globe_with_meridians: Translations"
|
||||
},
|
||||
"cacheDir": ".changelog"
|
||||
}
|
||||
|
|
20
package.json
20
package.json
|
@ -15,6 +15,7 @@
|
|||
"scripts": {
|
||||
"start": "yarn build:packages && yarn start:website",
|
||||
"start:website": "yarn workspace website start",
|
||||
"start:website:profile": "DOCUSAURUS_BUNDLER_CPU_PROFILE=true DOCUSAURUS_RSPACK_TRACE=true yarn workspace website start",
|
||||
"start:website:baseUrl": "yarn workspace website start:baseUrl",
|
||||
"start:website:blogOnly": "yarn workspace website start:blogOnly",
|
||||
"start:website:deployPreview": "cross-env NETLIFY=true CONTEXT='deploy-preview' yarn workspace website start",
|
||||
|
@ -22,6 +23,7 @@
|
|||
"build": "yarn build:packages && yarn build:website",
|
||||
"build:packages": "lerna run build --no-private",
|
||||
"build:website": "yarn workspace website build",
|
||||
"build:website:profile": "DOCUSAURUS_BUNDLER_CPU_PROFILE=true DOCUSAURUS_RSPACK_TRACE=true yarn workspace website build",
|
||||
"build:website:baseUrl": "yarn workspace website build:baseUrl",
|
||||
"build:website:blogOnly": "yarn workspace website build:blogOnly",
|
||||
"build:website:deployPreview:testWrap": "yarn workspace website test:swizzle:wrap:ts",
|
||||
|
@ -50,7 +52,7 @@
|
|||
"canary:bumpVersion": "yarn lerna version `yarn --silent canary:version` --exact --no-push --yes",
|
||||
"canary:publish": "yarn lerna publish from-package --dist-tag canary --yes --no-verify-access",
|
||||
"changelog": "lerna-changelog",
|
||||
"postinstall": "yarn lock:update && yarn build:packages",
|
||||
"postinstall": "patch-package && yarn lock:update && yarn build:packages",
|
||||
"prepare": "husky install",
|
||||
"format": "prettier --write .",
|
||||
"format:diff": "prettier --list-different .",
|
||||
|
@ -59,7 +61,7 @@
|
|||
"lint:js": "eslint --cache --report-unused-disable-directives \"**/*.{js,jsx,ts,tsx,mjs}\"",
|
||||
"lint:js:fix": "yarn lint:js --fix",
|
||||
"lint:spelling": "cspell \"**\" --no-progress --show-context --show-suggestions",
|
||||
"lint:spelling:fix": "yarn rimraf project-words.txt && echo \"# Project Words - DO NOT TOUCH - This is updated through CI\" >> project-words.txt && yarn -s lint:spelling --words-only --unique --no-exit-code --no-summary \"**\" | cross-env LC_ALL=en_US.UTF-8 sort --ignore-case >> project-words.txt",
|
||||
"lint:spelling:fix": "yarn rimraf project-words.txt && echo \"# Project Words - DO NOT TOUCH - This is updated through CI\" >> project-words.txt && yarn -s lint:spelling --words-only --unique --no-exit-code --no-summary \"**\" | cross-env LC_ALL=C sort --ignore-case >> project-words.txt",
|
||||
"lint:style": "stylelint \"**/*.css\"",
|
||||
"lint:style:fix": "yarn lint:style --fix",
|
||||
"lerna": "lerna",
|
||||
|
@ -83,14 +85,13 @@
|
|||
"@types/node": "^18.16.19",
|
||||
"@types/prompts": "^2.4.4",
|
||||
"@types/react": "^18.2.15",
|
||||
"@types/react-dev-utils": "^9.0.11",
|
||||
"@types/react-test-renderer": "^18.0.0",
|
||||
"@types/semver": "^7.5.0",
|
||||
"@types/shelljs": "^0.8.12",
|
||||
"@typescript-eslint/eslint-plugin": "^5.62.0",
|
||||
"@typescript-eslint/parser": "^5.62.0",
|
||||
"cross-env": "^7.0.3",
|
||||
"cspell": "^8.1.0",
|
||||
"cspell": "^8.18.1",
|
||||
"eslint": "^8.45.0",
|
||||
"eslint-config-airbnb": "^19.0.4",
|
||||
"eslint-config-prettier": "^8.8.0",
|
||||
|
@ -99,10 +100,11 @@
|
|||
"eslint-plugin-jest": "^27.2.3",
|
||||
"eslint-plugin-jsx-a11y": "^6.7.1",
|
||||
"eslint-plugin-react": "^7.32.2",
|
||||
"eslint-plugin-react-compiler": "^19.0.0-beta-40c6c23-20250301",
|
||||
"eslint-plugin-react-hooks": "^4.6.0",
|
||||
"eslint-plugin-regexp": "^1.15.0",
|
||||
"husky": "^8.0.3",
|
||||
"image-size": "^1.0.2",
|
||||
"image-size": "^2.0.2",
|
||||
"jest": "^29.7.0",
|
||||
"jest-environment-jsdom": "^29.7.0",
|
||||
"jest-serializer-ansi-escapes": "^3.0.0",
|
||||
|
@ -112,10 +114,11 @@
|
|||
"lint-staged": "~13.2.3",
|
||||
"lockfile-lint": "^4.14.0",
|
||||
"npm-run-all": "^4.1.5",
|
||||
"patch-package": "^8.0.0",
|
||||
"postinstall-postinstall": "^2.1.0",
|
||||
"prettier": "^2.8.8",
|
||||
"react": "^18.0.0",
|
||||
"react-dom": "^18.0.0",
|
||||
"react-helmet-async": "^1.3.0",
|
||||
"react-test-renderer": "^18.0.0",
|
||||
"rimraf": "^3.0.2",
|
||||
"sharp": "^0.32.3",
|
||||
|
@ -123,6 +126,7 @@
|
|||
"stylelint": "^14.16.1",
|
||||
"stylelint-config-prettier": "^9.0.5",
|
||||
"stylelint-config-standard": "^29.0.0",
|
||||
"typescript": "~5.6.2"
|
||||
}
|
||||
"typescript": "~5.8.2"
|
||||
},
|
||||
"packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
|
||||
}
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "create-docusaurus",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"description": "Create Docusaurus apps easily.",
|
||||
"type": "module",
|
||||
"repository": {
|
||||
|
@ -22,14 +22,14 @@
|
|||
},
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@docusaurus/logger": "3.6.2",
|
||||
"@docusaurus/utils": "3.6.2",
|
||||
"@docusaurus/logger": "3.7.0",
|
||||
"@docusaurus/utils": "3.7.0",
|
||||
"commander": "^5.1.0",
|
||||
"execa": "5.1.1",
|
||||
"fs-extra": "^11.1.1",
|
||||
"lodash": "^4.17.21",
|
||||
"prompts": "^2.4.2",
|
||||
"semver": "^7.5.4",
|
||||
"shelljs": "^0.8.5",
|
||||
"supports-color": "^9.4.0",
|
||||
"tslib": "^2.6.0"
|
||||
},
|
||||
|
|
|
@ -10,10 +10,13 @@ import {fileURLToPath} from 'url';
|
|||
import path from 'path';
|
||||
import _ from 'lodash';
|
||||
import {logger} from '@docusaurus/logger';
|
||||
import shell from 'shelljs';
|
||||
import execa from 'execa';
|
||||
import prompts, {type Choice} from 'prompts';
|
||||
import supportsColor from 'supports-color';
|
||||
import {escapeShellArg, askPreferredLanguage} from '@docusaurus/utils';
|
||||
|
||||
// TODO remove dependency on large @docusaurus/utils
|
||||
// would be better to have a new smaller @docusaurus/utils-cli package
|
||||
import {askPreferredLanguage} from '@docusaurus/utils';
|
||||
|
||||
type LanguagesOptions = {
|
||||
javascript?: boolean;
|
||||
|
@ -70,9 +73,9 @@ function findPackageManagerFromUserAgent(): PackageManager | undefined {
|
|||
}
|
||||
|
||||
async function askForPackageManagerChoice(): Promise<PackageManager> {
|
||||
const hasYarn = shell.exec('yarn --version', {silent: true}).code === 0;
|
||||
const hasPnpm = shell.exec('pnpm --version', {silent: true}).code === 0;
|
||||
const hasBun = shell.exec('bun --version', {silent: true}).code === 0;
|
||||
const hasYarn = (await execa.command('yarn --version')).exitCode === 0;
|
||||
const hasPnpm = (await execa.command('pnpm --version')).exitCode === 0;
|
||||
const hasBun = (await execa.command('bun --version')).exitCode === 0;
|
||||
|
||||
if (!hasYarn && !hasPnpm && !hasBun) {
|
||||
return 'npm';
|
||||
|
@ -530,10 +533,7 @@ export default async function init(
|
|||
|
||||
if (source.type === 'git') {
|
||||
const gitCommand = await getGitCommand(source.strategy);
|
||||
const gitCloneCommand = `${gitCommand} ${escapeShellArg(
|
||||
source.url,
|
||||
)} ${escapeShellArg(dest)}`;
|
||||
if (shell.exec(gitCloneCommand).code !== 0) {
|
||||
if ((await execa(gitCommand, [source.url, dest])).exitCode !== 0) {
|
||||
logger.error`Cloning Git template failed!`;
|
||||
process.exit(1);
|
||||
}
|
||||
|
@ -583,24 +583,27 @@ export default async function init(
|
|||
const cdpath = path.relative('.', dest);
|
||||
const pkgManager = await getPackageManager(dest, cliOptions);
|
||||
if (!cliOptions.skipInstall) {
|
||||
shell.cd(dest);
|
||||
process.chdir(dest);
|
||||
logger.info`Installing dependencies with name=${pkgManager}...`;
|
||||
// ...
|
||||
|
||||
if (
|
||||
shell.exec(
|
||||
pkgManager === 'yarn'
|
||||
? 'yarn'
|
||||
: pkgManager === 'bun'
|
||||
? 'bun install'
|
||||
: `${pkgManager} install --color always`,
|
||||
{
|
||||
env: {
|
||||
...process.env,
|
||||
// Force coloring the output, since the command is invoked by
|
||||
// shelljs, which is not an interactive shell
|
||||
...(supportsColor.stdout ? {FORCE_COLOR: '1'} : {}),
|
||||
(
|
||||
await execa.command(
|
||||
pkgManager === 'yarn'
|
||||
? 'yarn'
|
||||
: pkgManager === 'bun'
|
||||
? 'bun install'
|
||||
: `${pkgManager} install --color always`,
|
||||
{
|
||||
env: {
|
||||
...process.env,
|
||||
// Force coloring the output
|
||||
...(supportsColor.stdout ? {FORCE_COLOR: '1'} : {}),
|
||||
},
|
||||
},
|
||||
},
|
||||
).code !== 0
|
||||
)
|
||||
).exitCode !== 0
|
||||
) {
|
||||
logger.error('Dependency installation failed.');
|
||||
logger.info`The site directory has already been created, and you can retry by typing:
|
||||
|
|
|
@ -9,6 +9,11 @@ const config: Config = {
|
|||
tagline: 'Dinosaurs are cool',
|
||||
favicon: 'img/favicon.ico',
|
||||
|
||||
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
|
||||
future: {
|
||||
v4: true, // Improve compatibility with the upcoming Docusaurus v4
|
||||
},
|
||||
|
||||
// Set the production url of your site here
|
||||
url: 'https://your-docusaurus-site.example.com',
|
||||
// Set the /<baseUrl>/ pathname under which your site is served
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "docusaurus-2-classic-typescript-template",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"docusaurus": "docusaurus",
|
||||
|
@ -15,18 +15,18 @@
|
|||
"typecheck": "tsc"
|
||||
},
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "3.6.2",
|
||||
"@docusaurus/preset-classic": "3.6.2",
|
||||
"@docusaurus/core": "3.7.0",
|
||||
"@docusaurus/preset-classic": "3.7.0",
|
||||
"@mdx-js/react": "^3.0.0",
|
||||
"clsx": "^2.0.0",
|
||||
"prism-react-renderer": "^2.3.0",
|
||||
"react": "^18.0.0",
|
||||
"react-dom": "^18.0.0"
|
||||
"react": "^19.0.0",
|
||||
"react-dom": "^19.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@docusaurus/module-type-aliases": "3.6.2",
|
||||
"@docusaurus/tsconfig": "3.6.2",
|
||||
"@docusaurus/types": "3.6.2",
|
||||
"@docusaurus/module-type-aliases": "3.7.0",
|
||||
"@docusaurus/tsconfig": "3.7.0",
|
||||
"@docusaurus/types": "3.7.0",
|
||||
"typescript": "~5.6.2"
|
||||
},
|
||||
"browserslist": {
|
||||
|
|
|
@ -1,3 +1,4 @@
|
|||
import type {ReactNode} from 'react';
|
||||
import clsx from 'clsx';
|
||||
import Heading from '@theme/Heading';
|
||||
import styles from './styles.module.css';
|
||||
|
@ -5,7 +6,7 @@ import styles from './styles.module.css';
|
|||
type FeatureItem = {
|
||||
title: string;
|
||||
Svg: React.ComponentType<React.ComponentProps<'svg'>>;
|
||||
description: JSX.Element;
|
||||
description: ReactNode;
|
||||
};
|
||||
|
||||
const FeatureList: FeatureItem[] = [
|
||||
|
@ -55,7 +56,7 @@ function Feature({title, Svg, description}: FeatureItem) {
|
|||
);
|
||||
}
|
||||
|
||||
export default function HomepageFeatures(): JSX.Element {
|
||||
export default function HomepageFeatures(): ReactNode {
|
||||
return (
|
||||
<section className={styles.features}>
|
||||
<div className="container">
|
||||
|
|
|
@ -1,3 +1,4 @@
|
|||
import type {ReactNode} from 'react';
|
||||
import clsx from 'clsx';
|
||||
import Link from '@docusaurus/Link';
|
||||
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
||||
|
@ -28,7 +29,7 @@ function HomepageHeader() {
|
|||
);
|
||||
}
|
||||
|
||||
export default function Home(): JSX.Element {
|
||||
export default function Home(): ReactNode {
|
||||
const {siteConfig} = useDocusaurusContext();
|
||||
return (
|
||||
<Layout
|
||||
|
|
|
@ -14,6 +14,11 @@ const config = {
|
|||
tagline: 'Dinosaurs are cool',
|
||||
favicon: 'img/favicon.ico',
|
||||
|
||||
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
|
||||
future: {
|
||||
v4: true, // Improve compatibility with the upcoming Docusaurus v4
|
||||
},
|
||||
|
||||
// Set the production url of your site here
|
||||
url: 'https://your-docusaurus-site.example.com',
|
||||
// Set the /<baseUrl>/ pathname under which your site is served
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "docusaurus-2-classic-template",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"docusaurus": "docusaurus",
|
||||
|
@ -14,17 +14,17 @@
|
|||
"write-heading-ids": "docusaurus write-heading-ids"
|
||||
},
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "3.6.2",
|
||||
"@docusaurus/preset-classic": "3.6.2",
|
||||
"@docusaurus/core": "3.7.0",
|
||||
"@docusaurus/preset-classic": "3.7.0",
|
||||
"@mdx-js/react": "^3.0.0",
|
||||
"clsx": "^2.0.0",
|
||||
"prism-react-renderer": "^2.3.0",
|
||||
"react": "^18.0.0",
|
||||
"react-dom": "^18.0.0"
|
||||
"react": "^19.0.0",
|
||||
"react-dom": "^19.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@docusaurus/module-type-aliases": "3.6.2",
|
||||
"@docusaurus/types": "3.6.2"
|
||||
"@docusaurus/module-type-aliases": "3.7.0",
|
||||
"@docusaurus/types": "3.7.0"
|
||||
},
|
||||
"browserslist": {
|
||||
"production": [
|
||||
|
|
|
@ -4,13 +4,13 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
|
|||
|
||||
### Installation
|
||||
|
||||
```
|
||||
```bash
|
||||
$ yarn
|
||||
```
|
||||
|
||||
### Local Development
|
||||
|
||||
```
|
||||
```bash
|
||||
$ yarn start
|
||||
```
|
||||
|
||||
|
@ -18,7 +18,7 @@ This command starts a local development server and opens up a browser window. Mo
|
|||
|
||||
### Build
|
||||
|
||||
```
|
||||
```bash
|
||||
$ yarn build
|
||||
```
|
||||
|
||||
|
@ -28,13 +28,13 @@ This command generates static content into the `build` directory and can be serv
|
|||
|
||||
Using SSH:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ USE_SSH=true yarn deploy
|
||||
```
|
||||
|
||||
Not using SSH:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ GIT_USER=<Your GitHub username> yarn deploy
|
||||
```
|
||||
|
||||
|
|
|
@ -1,12 +1,14 @@
|
|||
yangshun:
|
||||
name: Yangshun Tay
|
||||
title: Front End Engineer @ Facebook
|
||||
url: https://github.com/yangshun
|
||||
title: Ex-Meta Staff Engineer, Co-founder GreatFrontEnd
|
||||
url: https://linkedin.com/in/yangshun
|
||||
image_url: https://github.com/yangshun.png
|
||||
page: true
|
||||
socials:
|
||||
x: yangshunz
|
||||
linkedin: yangshun
|
||||
github: yangshun
|
||||
newsletter: https://www.greatfrontend.com
|
||||
|
||||
slorber:
|
||||
name: Sébastien Lorber
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@docusaurus/babel",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"description": "Docusaurus package for Babel-related utils.",
|
||||
"main": "./lib/index.js",
|
||||
"types": "./lib/index.d.ts",
|
||||
|
@ -38,8 +38,8 @@
|
|||
"@babel/runtime": "^7.25.9",
|
||||
"@babel/runtime-corejs3": "^7.25.9",
|
||||
"@babel/traverse": "^7.25.9",
|
||||
"@docusaurus/logger": "3.6.2",
|
||||
"@docusaurus/utils": "3.6.2",
|
||||
"@docusaurus/logger": "3.7.0",
|
||||
"@docusaurus/utils": "3.7.0",
|
||||
"babel-plugin-dynamic-import-node": "^2.3.3",
|
||||
"fs-extra": "^11.1.1",
|
||||
"tslib": "^2.6.0"
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@docusaurus/bundler",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"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.6.2",
|
||||
"@docusaurus/cssnano-preset": "3.6.2",
|
||||
"@docusaurus/logger": "3.6.2",
|
||||
"@docusaurus/types": "3.6.2",
|
||||
"@docusaurus/utils": "3.6.2",
|
||||
"@docusaurus/babel": "3.7.0",
|
||||
"@docusaurus/cssnano-preset": "3.7.0",
|
||||
"@docusaurus/logger": "3.7.0",
|
||||
"@docusaurus/types": "3.7.0",
|
||||
"@docusaurus/utils": "3.7.0",
|
||||
"babel-loader": "^9.2.1",
|
||||
"clean-css": "^5.3.2",
|
||||
"copy-webpack-plugin": "^11.0.0",
|
||||
|
@ -37,7 +37,6 @@
|
|||
"postcss": "^8.4.26",
|
||||
"postcss-loader": "^7.3.3",
|
||||
"postcss-preset-env": "^10.1.0",
|
||||
"react-dev-utils": "^12.0.1",
|
||||
"terser-webpack-plugin": "^5.3.9",
|
||||
"tslib": "^2.6.0",
|
||||
"url-loader": "^4.1.1",
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
import {type Configuration} from 'webpack';
|
||||
import logger from '@docusaurus/logger';
|
||||
import formatWebpackMessages from 'react-dev-utils/formatWebpackMessages';
|
||||
import formatWebpackMessages from './legacy/formatWebpackMessages';
|
||||
import type webpack from 'webpack';
|
||||
import type {CurrentBundler} from '@docusaurus/types';
|
||||
|
||||
|
|
138
packages/docusaurus-bundler/src/legacy/formatWebpackMessages.js
Normal file
138
packages/docusaurus-bundler/src/legacy/formatWebpackMessages.js
Normal file
|
@ -0,0 +1,138 @@
|
|||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
// TODO Legacy CRA react-dev-utils package code
|
||||
// This code was in CRA/react-dev-utils (deprecated in 2025)
|
||||
// We just copied the code as-is to remove a fat/useless dependency subtree
|
||||
// See https://github.com/facebook/docusaurus/pull/10956
|
||||
// See https://github.com/facebook/create-react-app/blob/main/packages/react-dev-utils/formatWebpackMessages.js
|
||||
|
||||
/* eslint-disable */
|
||||
|
||||
const friendlySyntaxErrorLabel = 'Syntax error:';
|
||||
|
||||
function isLikelyASyntaxError(message) {
|
||||
return message.indexOf(friendlySyntaxErrorLabel) !== -1;
|
||||
}
|
||||
|
||||
// Cleans up webpack error messages.
|
||||
function formatMessage(message) {
|
||||
let lines = [];
|
||||
|
||||
if (typeof message === 'string') {
|
||||
lines = message.split('\n');
|
||||
} else if ('message' in message) {
|
||||
lines = message['message'].split('\n');
|
||||
} else if (Array.isArray(message)) {
|
||||
message.forEach((message) => {
|
||||
if ('message' in message) {
|
||||
lines = message['message'].split('\n');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// Strip webpack-added headers off errors/warnings
|
||||
// https://github.com/webpack/webpack/blob/master/lib/ModuleError.js
|
||||
lines = lines.filter((line) => !/Module [A-z ]+\(from/.test(line));
|
||||
|
||||
// Transform parsing error into syntax error
|
||||
// TODO: move this to our ESLint formatter?
|
||||
lines = lines.map((line) => {
|
||||
const parsingError = /Line (\d+):(?:(\d+):)?\s*Parsing error: (.+)$/.exec(
|
||||
line,
|
||||
);
|
||||
if (!parsingError) {
|
||||
return line;
|
||||
}
|
||||
const [, errorLine, errorColumn, errorMessage] = parsingError;
|
||||
return `${friendlySyntaxErrorLabel} ${errorMessage} (${errorLine}:${errorColumn})`;
|
||||
});
|
||||
|
||||
message = lines.join('\n');
|
||||
// Smoosh syntax errors (commonly found in CSS)
|
||||
message = message.replace(
|
||||
/SyntaxError\s+\((\d+):(\d+)\)\s*(.+?)\n/g,
|
||||
`${friendlySyntaxErrorLabel} $3 ($1:$2)\n`,
|
||||
);
|
||||
// Clean up export errors
|
||||
message = message.replace(
|
||||
/^.*export '(.+?)' was not found in '(.+?)'.*$/gm,
|
||||
`Attempted import error: '$1' is not exported from '$2'.`,
|
||||
);
|
||||
message = message.replace(
|
||||
/^.*export 'default' \(imported as '(.+?)'\) was not found in '(.+?)'.*$/gm,
|
||||
`Attempted import error: '$2' does not contain a default export (imported as '$1').`,
|
||||
);
|
||||
message = message.replace(
|
||||
/^.*export '(.+?)' \(imported as '(.+?)'\) was not found in '(.+?)'.*$/gm,
|
||||
`Attempted import error: '$1' is not exported from '$3' (imported as '$2').`,
|
||||
);
|
||||
lines = message.split('\n');
|
||||
|
||||
// Remove leading newline
|
||||
if (lines.length > 2 && lines[1].trim() === '') {
|
||||
lines.splice(1, 1);
|
||||
}
|
||||
// Clean up file name
|
||||
lines[0] = lines[0].replace(/^(.*) \d+:\d+-\d+$/, '$1');
|
||||
|
||||
// Cleans up verbose "module not found" messages for files and packages.
|
||||
if (lines[1] && lines[1].indexOf('Module not found: ') === 0) {
|
||||
lines = [
|
||||
lines[0],
|
||||
lines[1]
|
||||
.replace('Error: ', '')
|
||||
.replace('Module not found: Cannot find file:', 'Cannot find file:'),
|
||||
];
|
||||
}
|
||||
|
||||
// Add helpful message for users trying to use Sass for the first time
|
||||
if (lines[1] && lines[1].match(/Cannot find module.+sass/)) {
|
||||
lines[1] = 'To import Sass files, you first need to install sass.\n';
|
||||
lines[1] +=
|
||||
'Run `npm install sass` or `yarn add sass` inside your workspace.';
|
||||
}
|
||||
|
||||
message = lines.join('\n');
|
||||
// Internal stacks are generally useless so we strip them... with the
|
||||
// exception of stacks containing `webpack:` because they're normally
|
||||
// from user code generated by webpack. For more information see
|
||||
// https://github.com/facebook/create-react-app/pull/1050
|
||||
message = message.replace(
|
||||
/^\s*at\s((?!webpack:).)*:\d+:\d+[\s)]*(\n|$)/gm,
|
||||
'',
|
||||
); // at ... ...:x:y
|
||||
message = message.replace(/^\s*at\s<anonymous>(\n|$)/gm, ''); // at <anonymous>
|
||||
lines = message.split('\n');
|
||||
|
||||
// Remove duplicated newlines
|
||||
lines = lines.filter(
|
||||
(line, index, arr) =>
|
||||
index === 0 ||
|
||||
line.trim() !== '' ||
|
||||
line.trim() !== arr[index - 1].trim(),
|
||||
);
|
||||
|
||||
// Reassemble the message
|
||||
message = lines.join('\n');
|
||||
return message.trim();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {import("webpack").Stats.ToJsonOutput} json.
|
||||
* @returns {{ errors: string[], warnings: string[] }}
|
||||
*/
|
||||
module.exports = function formatWebpackMessages(json) {
|
||||
const formattedErrors = json.errors.map(formatMessage);
|
||||
const formattedWarnings = json.warnings.map(formatMessage);
|
||||
const result = {errors: formattedErrors, warnings: formattedWarnings};
|
||||
if (result.errors.some(isLikelyASyntaxError)) {
|
||||
// If there are any syntax errors, show just them.
|
||||
result.errors = result.errors.filter(isLikelyASyntaxError);
|
||||
}
|
||||
return result;
|
||||
};
|
|
@ -47,9 +47,13 @@ async function getTerserMinifier(): Promise<HtmlMinifier> {
|
|||
minify: async function minifyHtmlWithTerser(html) {
|
||||
try {
|
||||
const code = await terserHtmlMinifier(html, {
|
||||
// When enabled => React hydration errors
|
||||
removeComments: false,
|
||||
removeRedundantAttributes: true,
|
||||
removeEmptyAttributes: true,
|
||||
removeRedundantAttributes: false,
|
||||
removeEmptyAttributes: false,
|
||||
sortAttributes: false,
|
||||
sortClassName: false,
|
||||
|
||||
removeScriptTypeAttributes: true,
|
||||
removeStyleLinkTypeAttributes: true,
|
||||
useShortDoctype: true,
|
||||
|
@ -84,8 +88,13 @@ async function getSwcMinifier(): Promise<HtmlMinifier> {
|
|||
sortSpaceSeparatedAttributeValues: false,
|
||||
sortAttributes: false,
|
||||
|
||||
removeRedundantAttributes: 'all',
|
||||
removeEmptyAttributes: true,
|
||||
// When enabled => hydration error for className={"yt-lite "}
|
||||
normalizeAttributes: false,
|
||||
// When enabled => hydration error for className=""
|
||||
removeEmptyAttributes: false,
|
||||
// When enabled => hydration error for <a target="_self">
|
||||
removeRedundantAttributes: 'none',
|
||||
|
||||
minifyJs: true,
|
||||
minifyJson: true,
|
||||
minifyCss: true,
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@docusaurus/cssnano-preset",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"description": "Advanced cssnano preset for maximum optimization.",
|
||||
"main": "lib/index.js",
|
||||
"license": "MIT",
|
||||
|
|
|
@ -26,4 +26,5 @@ const preset: typeof advancedBasePreset = function preset(opts) {
|
|||
return advancedPreset;
|
||||
};
|
||||
|
||||
// @ts-expect-error: TODO fix later
|
||||
export = preset;
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@docusaurus/faster",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"description": "Docusaurus experimental package exposing new modern dependencies to make the build faster.",
|
||||
"main": "./lib/index.js",
|
||||
"types": "./lib/index.d.ts",
|
||||
|
@ -18,8 +18,8 @@
|
|||
},
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@docusaurus/types": "3.6.2",
|
||||
"@rspack/core": "^1.1.1",
|
||||
"@docusaurus/types": "3.7.0",
|
||||
"@rspack/core": "^1.3.3",
|
||||
"@swc/core": "^1.7.39",
|
||||
"@swc/html": "^1.7.39",
|
||||
"browserslist": "^4.24.2",
|
||||
|
|
|
@ -11,6 +11,16 @@ import browserslist from 'browserslist';
|
|||
import {minify as swcHtmlMinifier} from '@swc/html';
|
||||
import type {JsMinifyOptions, Options as SwcOptions} from '@swc/core';
|
||||
|
||||
// See https://rspack.dev/contribute/development/profiling
|
||||
// File can be opened with https://ui.perfetto.dev/
|
||||
if (process.env.DOCUSAURUS_RSPACK_TRACE) {
|
||||
Rspack.experiments.globalTrace.register(
|
||||
'trace',
|
||||
'chrome',
|
||||
'./rspack-tracing.json',
|
||||
);
|
||||
}
|
||||
|
||||
export const swcLoader = require.resolve('swc-loader');
|
||||
|
||||
export const getSwcLoaderOptions = ({
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@docusaurus/logger",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"description": "An encapsulated logger for semantically formatting console messages.",
|
||||
"main": "./lib/index.js",
|
||||
"repository": {
|
||||
|
|
|
@ -114,12 +114,24 @@ function createPerfLogger(): PerfLoggerAPI {
|
|||
},
|
||||
});
|
||||
|
||||
const end: PerfLoggerAPI['end'] = (label) => {
|
||||
const {
|
||||
duration,
|
||||
detail: {memoryUsage},
|
||||
} = performance.measure(label);
|
||||
const readMark = (label: string) => {
|
||||
const startMark = performance.getEntriesByName(
|
||||
label,
|
||||
'mark',
|
||||
)?.[0] as PerformanceMark;
|
||||
if (!startMark) {
|
||||
throw new Error(`No performance start mark for label=${label}`);
|
||||
}
|
||||
performance.clearMarks(label);
|
||||
return startMark;
|
||||
};
|
||||
|
||||
const end: PerfLoggerAPI['end'] = (label) => {
|
||||
const startMark = readMark(label);
|
||||
const duration = performance.now() - startMark.startTime;
|
||||
const {
|
||||
detail: {memoryUsage},
|
||||
} = startMark;
|
||||
printPerfLog({
|
||||
label: applyParentPrefix(label),
|
||||
duration,
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@docusaurus/mdx-loader",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"description": "Docusaurus Loader for MDX",
|
||||
"main": "lib/index.js",
|
||||
"types": "lib/index.d.ts",
|
||||
|
@ -18,16 +18,16 @@
|
|||
},
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@docusaurus/logger": "3.6.2",
|
||||
"@docusaurus/utils": "3.6.2",
|
||||
"@docusaurus/utils-validation": "3.6.2",
|
||||
"@docusaurus/logger": "3.7.0",
|
||||
"@docusaurus/utils": "3.7.0",
|
||||
"@docusaurus/utils-validation": "3.7.0",
|
||||
"@mdx-js/mdx": "^3.0.0",
|
||||
"@slorber/remark-comment": "^1.0.0",
|
||||
"escape-html": "^1.0.3",
|
||||
"estree-util-value-to-estree": "^3.0.1",
|
||||
"file-loader": "^6.2.0",
|
||||
"fs-extra": "^11.1.1",
|
||||
"image-size": "^1.0.2",
|
||||
"image-size": "^2.0.2",
|
||||
"mdast-util-mdx": "^3.0.0",
|
||||
"mdast-util-to-string": "^4.0.0",
|
||||
"rehype-raw": "^7.0.0",
|
||||
|
@ -44,7 +44,7 @@
|
|||
"webpack": "^5.88.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@docusaurus/types": "3.6.2",
|
||||
"@docusaurus/types": "3.7.0",
|
||||
"@types/escape-html": "^1.0.2",
|
||||
"@types/mdast": "^4.0.2",
|
||||
"@types/stringify-object": "^3.3.1",
|
||||
|
@ -58,8 +58,8 @@
|
|||
"unist-util-remove-position": "^5.0.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"react": "^18.0.0",
|
||||
"react-dom": "^18.0.0"
|
||||
"react": "^18.0.0 || ^19.0.0",
|
||||
"react-dom": "^18.0.0 || ^19.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=18.0"
|
||||
|
|
|
@ -5,6 +5,8 @@
|
|||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
|
||||
import type {ReactNode} from 'react';
|
||||
|
||||
import {mdxLoader} from './loader';
|
||||
|
||||
import type {TOCItem as TOCItemImported} from './remark/toc/types';
|
||||
|
@ -34,7 +36,7 @@ export type LoadedMDXContent<FrontMatter, Metadata, Assets = undefined> = {
|
|||
* in priority.
|
||||
*/
|
||||
readonly assets: Assets;
|
||||
(): JSX.Element;
|
||||
(): ReactNode;
|
||||
};
|
||||
|
||||
export type {MDXPlugin} from './loader';
|
||||
|
|
|
@ -218,6 +218,7 @@ export async function mdxLoader(
|
|||
const compilerName = getWebpackLoaderCompilerName(this);
|
||||
const callback = this.async();
|
||||
const options: Options = this.getOptions();
|
||||
options.dependencies?.forEach(this.addDependency);
|
||||
try {
|
||||
const result = await loadMDXWithCaching({
|
||||
resource: this.resource,
|
||||
|
|
|
@ -11,6 +11,8 @@ import type {ResolveMarkdownLink} from './remark/resolveMarkdownLinks';
|
|||
import type {PromiseWithResolvers} from './utils';
|
||||
|
||||
export type Options = Partial<MDXOptions> & {
|
||||
dependencies?: string[];
|
||||
|
||||
markdownConfig: MarkdownConfig;
|
||||
staticDirs: string[];
|
||||
siteDir: string;
|
||||
|
|
|
@ -22,8 +22,6 @@ import type {WebpackCompilerName} from '@docusaurus/utils';
|
|||
import type {MDXFrontMatter} from './frontMatter';
|
||||
import type {Options} from './options';
|
||||
import type {AdmonitionOptions} from './remark/admonitions';
|
||||
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {ProcessorOptions} from '@mdx-js/mdx';
|
||||
|
||||
// TODO as of April 2023, no way to import/re-export this ESM type easily :/
|
||||
|
|
|
@ -4,10 +4,7 @@
|
|||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {Transformer, Plugin} from 'unified';
|
||||
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {ContainerDirective} from 'mdast-util-directive';
|
||||
import type {Parent, Root} from 'mdast';
|
||||
|
||||
|
|
|
@ -4,11 +4,8 @@
|
|||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {Transformer, Plugin} from 'unified';
|
||||
import type {Heading, Parent, Root} from 'mdast';
|
||||
|
||||
// @ts-expect-error: ES support...
|
||||
import type {MdxJsxFlowElement} from 'mdast-util-mdx';
|
||||
|
||||
interface PluginOptions {
|
||||
|
|
|
@ -5,7 +5,6 @@
|
|||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {Transformer} from 'unified';
|
||||
|
||||
import type {Root} from 'mdast';
|
||||
|
|
|
@ -5,7 +5,6 @@
|
|||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {Transformer} from 'unified';
|
||||
|
||||
import type {Root} from 'mdast';
|
||||
|
|
|
@ -8,7 +8,6 @@
|
|||
/* Based on remark-slug (https://github.com/remarkjs/remark-slug) and gatsby-remark-autolink-headers (https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-remark-autolink-headers) */
|
||||
|
||||
import {parseMarkdownHeadingId, createSlugger} from '@docusaurus/utils';
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {Plugin, Transformer} from 'unified';
|
||||
import type {Root, Text} from 'mdast';
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@
|
|||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {Transformer, Plugin} from 'unified';
|
||||
import type {Root} from 'mdast';
|
||||
|
||||
|
@ -26,6 +25,7 @@ const plugin: Plugin<unknown[], Root> = function plugin(): Transformer<Root> {
|
|||
node.data.hProperties = node.data.hProperties || {};
|
||||
node.data.hProperties.metastring = node.meta;
|
||||
|
||||
// TODO Docusaurus v4: remove special case
|
||||
// Retrocompatible support for live codeblock metastring
|
||||
// Not really the appropriate place to handle that :s
|
||||
node.data.hProperties.live = node.meta?.split(' ').includes('live');
|
||||
|
|
|
@ -7,7 +7,6 @@
|
|||
|
||||
import {transformNode} from '../utils';
|
||||
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {Transformer} from 'unified';
|
||||
import type {Root} from 'mdast';
|
||||
|
||||
|
|
|
@ -11,7 +11,6 @@ import {
|
|||
type URLPath,
|
||||
} from '@docusaurus/utils';
|
||||
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {Plugin, Transformer} from 'unified';
|
||||
import type {Definition, Link, Root} from 'mdast';
|
||||
|
||||
|
|
|
@ -0,0 +1,126 @@
|
|||
/**
|
||||
* 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 {toHeadingHTMLValue} from '../utils';
|
||||
import type {Heading} from 'mdast';
|
||||
|
||||
describe('toHeadingHTMLValue', () => {
|
||||
async function convert(heading: Heading): Promise<string> {
|
||||
const {toString} = await import('mdast-util-to-string');
|
||||
return toHeadingHTMLValue(heading, toString);
|
||||
}
|
||||
|
||||
it('converts a simple heading', async () => {
|
||||
const heading: Heading = {
|
||||
type: 'heading',
|
||||
depth: 2,
|
||||
children: [
|
||||
{
|
||||
type: 'text',
|
||||
value: 'Some heading text',
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
await expect(convert(heading)).resolves.toMatchInlineSnapshot(
|
||||
`"Some heading text"`,
|
||||
);
|
||||
});
|
||||
|
||||
it('converts a heading with b tag', async () => {
|
||||
const heading: Heading = {
|
||||
type: 'heading',
|
||||
depth: 2,
|
||||
children: [
|
||||
{
|
||||
type: 'mdxJsxTextElement',
|
||||
name: 'b',
|
||||
attributes: [],
|
||||
children: [
|
||||
{
|
||||
type: 'text',
|
||||
value: 'Some title',
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
await expect(convert(heading)).resolves.toMatchInlineSnapshot(
|
||||
`"<b>Some title</b>"`,
|
||||
);
|
||||
});
|
||||
|
||||
it('converts a heading with span tag + className', async () => {
|
||||
const heading: Heading = {
|
||||
type: 'heading',
|
||||
depth: 2,
|
||||
children: [
|
||||
{
|
||||
type: 'mdxJsxTextElement',
|
||||
name: 'span',
|
||||
attributes: [
|
||||
{
|
||||
type: 'mdxJsxAttribute',
|
||||
name: 'className',
|
||||
value: 'my-class',
|
||||
},
|
||||
],
|
||||
children: [
|
||||
{
|
||||
type: 'text',
|
||||
value: 'Some title',
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
await expect(convert(heading)).resolves.toMatchInlineSnapshot(
|
||||
`"<span class="my-class">Some title</span>"`,
|
||||
);
|
||||
});
|
||||
|
||||
it('converts a heading - remove img tag', async () => {
|
||||
const heading: Heading = {
|
||||
type: 'heading',
|
||||
depth: 2,
|
||||
children: [
|
||||
{
|
||||
type: 'mdxJsxTextElement',
|
||||
name: 'img',
|
||||
attributes: [
|
||||
{
|
||||
type: 'mdxJsxAttribute',
|
||||
name: 'src',
|
||||
value: '/img/slash-introducing.svg',
|
||||
},
|
||||
{
|
||||
type: 'mdxJsxAttribute',
|
||||
name: 'height',
|
||||
value: '32',
|
||||
},
|
||||
{
|
||||
type: 'mdxJsxAttribute',
|
||||
name: 'alt',
|
||||
value: 'test',
|
||||
},
|
||||
],
|
||||
children: [],
|
||||
},
|
||||
{
|
||||
type: 'text',
|
||||
value: ' Some title',
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
await expect(convert(heading)).resolves.toMatchInlineSnapshot(
|
||||
`"Some title"`,
|
||||
);
|
||||
});
|
||||
});
|
|
@ -14,13 +14,8 @@ import {
|
|||
isNamedExport,
|
||||
} from './utils';
|
||||
import type {Heading, Root} from 'mdast';
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {Plugin, Transformer} from 'unified';
|
||||
import type {
|
||||
MdxjsEsm,
|
||||
MdxJsxFlowElement,
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
} from 'mdast-util-mdx';
|
||||
import type {MdxjsEsm, MdxJsxFlowElement} from 'mdast-util-mdx';
|
||||
import type {TOCItems} from './types';
|
||||
import type {ImportDeclaration} from 'estree';
|
||||
|
||||
|
|
|
@ -5,11 +5,12 @@
|
|||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
|
||||
import {toValue} from '../utils';
|
||||
import type {Node} from 'unist';
|
||||
import escapeHtml from 'escape-html';
|
||||
import type {Node, Parent} from 'unist';
|
||||
import type {
|
||||
MdxjsEsm,
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
MdxJsxAttribute,
|
||||
MdxJsxTextElement,
|
||||
} from 'mdast-util-mdx';
|
||||
import type {TOCHeading, TOCItem, TOCItems, TOCSlice} from './types';
|
||||
import type {
|
||||
|
@ -18,6 +19,7 @@ import type {
|
|||
ImportDeclaration,
|
||||
ImportSpecifier,
|
||||
} from 'estree';
|
||||
import type {Heading, PhrasingContent} from 'mdast';
|
||||
|
||||
export function getImportDeclarations(program: Program): ImportDeclaration[] {
|
||||
return program.body.filter(
|
||||
|
@ -121,7 +123,7 @@ export async function createTOCExportNodeAST({
|
|||
const {toString} = await import('mdast-util-to-string');
|
||||
const {valueToEstree} = await import('estree-util-value-to-estree');
|
||||
const value: TOCItem = {
|
||||
value: toValue(heading, toString),
|
||||
value: toHeadingHTMLValue(heading, toString),
|
||||
id: heading.data!.id!,
|
||||
level: heading.depth,
|
||||
};
|
||||
|
@ -175,3 +177,73 @@ export async function createTOCExportNodeAST({
|
|||
},
|
||||
};
|
||||
}
|
||||
|
||||
function stringifyChildren(
|
||||
node: Parent,
|
||||
toString: (param: unknown) => string, // TODO temporary, due to ESM
|
||||
): string {
|
||||
return (node.children as PhrasingContent[])
|
||||
.map((item) => toHeadingHTMLValue(item, toString))
|
||||
.join('')
|
||||
.trim();
|
||||
}
|
||||
|
||||
// TODO This is really a workaround, and not super reliable
|
||||
// For now we only support serializing tagName, className and content
|
||||
// Can we implement the TOC with real JSX nodes instead of html strings later?
|
||||
function mdxJsxTextElementToHtml(
|
||||
element: MdxJsxTextElement,
|
||||
toString: (param: unknown) => string, // TODO temporary, due to ESM
|
||||
): string {
|
||||
const tag = element.name;
|
||||
|
||||
// See https://github.com/facebook/docusaurus/issues/11003#issuecomment-2733925363
|
||||
if (tag === 'img') {
|
||||
return '';
|
||||
}
|
||||
|
||||
const attributes = element.attributes.filter(
|
||||
(child): child is MdxJsxAttribute => child.type === 'mdxJsxAttribute',
|
||||
);
|
||||
|
||||
const classAttribute =
|
||||
attributes.find((attr) => attr.name === 'className') ??
|
||||
attributes.find((attr) => attr.name === 'class');
|
||||
|
||||
const classAttributeString = classAttribute
|
||||
? `class="${escapeHtml(String(classAttribute.value))}"`
|
||||
: ``;
|
||||
|
||||
const allAttributes = classAttributeString ? ` ${classAttributeString}` : '';
|
||||
|
||||
const content = stringifyChildren(element, toString);
|
||||
|
||||
return `<${tag}${allAttributes}>${content}</${tag}>`;
|
||||
}
|
||||
|
||||
export function toHeadingHTMLValue(
|
||||
node: PhrasingContent | Heading | MdxJsxTextElement,
|
||||
toString: (param: unknown) => string, // TODO temporary, due to ESM
|
||||
): string {
|
||||
switch (node.type) {
|
||||
case 'mdxJsxTextElement': {
|
||||
return mdxJsxTextElementToHtml(node as MdxJsxTextElement, toString);
|
||||
}
|
||||
case 'text':
|
||||
return escapeHtml(node.value);
|
||||
case 'heading':
|
||||
return stringifyChildren(node, toString);
|
||||
case 'inlineCode':
|
||||
return `<code>${escapeHtml(node.value)}</code>`;
|
||||
case 'emphasis':
|
||||
return `<em>${stringifyChildren(node, toString)}</em>`;
|
||||
case 'strong':
|
||||
return `<strong>${stringifyChildren(node, toString)}</strong>`;
|
||||
case 'delete':
|
||||
return `<del>${stringifyChildren(node, toString)}</del>`;
|
||||
case 'link':
|
||||
return stringifyChildren(node, toString);
|
||||
default:
|
||||
return toString(node);
|
||||
}
|
||||
}
|
||||
|
|
|
@ -29,3 +29,13 @@ in paragraph 
|
|||
```md
|
||||

|
||||
```
|
||||
|
||||
## Images with spaces
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 5 KiB |
Binary file not shown.
After Width: | Height: | Size: 5 KiB |
|
@ -48,5 +48,15 @@ in paragraph <img alt="img" src={require("!<PROJECT_ROOT>/node_modules/url-loade
|
|||
\`\`\`md
|
||||

|
||||
\`\`\`
|
||||
|
||||
## Images with spaces
|
||||
|
||||
<img alt="img" src={require("!<PROJECT_ROOT>/node_modules/url-loader/dist/cjs.js?limit=10000&name=assets/images/[name]-[contenthash].[ext]&fallback=<PROJECT_ROOT>/node_modules/file-loader/dist/cjs.js!./static/img with spaces.png").default} width="200" height="200" />
|
||||
|
||||
<img alt="img" src={require("!<PROJECT_ROOT>/node_modules/url-loader/dist/cjs.js?limit=10000&name=assets/images/[name]-[contenthash].[ext]&fallback=<PROJECT_ROOT>/node_modules/file-loader/dist/cjs.js!./static/img with spaces.png").default} width="200" height="200" />
|
||||
|
||||
<img alt="img" src={require("!<PROJECT_ROOT>/node_modules/url-loader/dist/cjs.js?limit=10000&name=assets/images/[name]-[contenthash].[ext]&fallback=<PROJECT_ROOT>/node_modules/file-loader/dist/cjs.js!./static/img with one encoded%20space.png").default} width="200" height="200" />
|
||||
|
||||
<img alt="img" src={require("!<PROJECT_ROOT>/node_modules/url-loader/dist/cjs.js?limit=10000&name=assets/images/[name]-[contenthash].[ext]&fallback=<PROJECT_ROOT>/node_modules/file-loader/dist/cjs.js!./static/img with one encoded%20space.png").default} width="200" height="200" />
|
||||
"
|
||||
`;
|
||||
|
|
|
@ -8,7 +8,6 @@
|
|||
import path from 'path';
|
||||
import url from 'url';
|
||||
import fs from 'fs-extra';
|
||||
import {promisify} from 'util';
|
||||
import {
|
||||
toMessageRelativeFilePath,
|
||||
posixPath,
|
||||
|
@ -17,12 +16,10 @@ import {
|
|||
getFileLoaderUtils,
|
||||
} from '@docusaurus/utils';
|
||||
import escapeHtml from 'escape-html';
|
||||
import sizeOf from 'image-size';
|
||||
import {imageSizeFromFile} from 'image-size/fromFile';
|
||||
import logger from '@docusaurus/logger';
|
||||
import {assetRequireAttributeValue, transformNode} from '../utils';
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {Plugin, Transformer} from 'unified';
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {MdxJsxTextElement} from 'mdast-util-mdx';
|
||||
import type {Image, Root} from 'mdast';
|
||||
import type {Parent} from 'unist';
|
||||
|
@ -82,7 +79,7 @@ async function toImageRequireNode(
|
|||
}
|
||||
|
||||
try {
|
||||
const size = (await promisify(sizeOf)(imagePath))!;
|
||||
const size = (await imageSizeFromFile(imagePath))!;
|
||||
if (size.width) {
|
||||
attributes.push({
|
||||
type: 'mdxJsxAttribute',
|
||||
|
@ -98,6 +95,7 @@ async function toImageRequireNode(
|
|||
});
|
||||
}
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
// Workaround for https://github.com/yarnpkg/berry/pull/3889#issuecomment-1034469784
|
||||
// TODO remove this check once fixed in Yarn PnP
|
||||
if (!process.versions.pnp) {
|
||||
|
@ -152,10 +150,7 @@ async function getImageAbsolutePath(
|
|||
return imageFilePath;
|
||||
}
|
||||
// relative paths are resolved against the source file's folder
|
||||
const imageFilePath = path.join(
|
||||
path.dirname(filePath),
|
||||
decodeURIComponent(imagePath),
|
||||
);
|
||||
const imageFilePath = path.join(path.dirname(filePath), imagePath);
|
||||
await ensureImageFileExist(imageFilePath, filePath);
|
||||
return imageFilePath;
|
||||
}
|
||||
|
@ -180,9 +175,14 @@ async function processImageNode(target: Target, context: Context) {
|
|||
return;
|
||||
}
|
||||
|
||||
// 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);
|
||||
|
||||
// We try to convert image urls without protocol to images with require calls
|
||||
// going through webpack ensures that image assets exist at build time
|
||||
const imagePath = await getImageAbsolutePath(parsedUrl.pathname, context);
|
||||
const imagePath = await getImageAbsolutePath(decodedPathname, context);
|
||||
await toImageRequireNode(target, imagePath, context);
|
||||
}
|
||||
|
||||
|
|
|
@ -17,9 +17,7 @@ import {
|
|||
} from '@docusaurus/utils';
|
||||
import escapeHtml from 'escape-html';
|
||||
import {assetRequireAttributeValue, transformNode} from '../utils';
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {Plugin, Transformer} from 'unified';
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {MdxJsxTextElement} from 'mdast-util-mdx';
|
||||
import type {Parent} from 'unist';
|
||||
import type {Link, Literal, Root} from 'mdast';
|
||||
|
|
|
@ -10,14 +10,9 @@ import logger from '@docusaurus/logger';
|
|||
import {posixPath} from '@docusaurus/utils';
|
||||
import {transformNode} from '../utils';
|
||||
import type {Root} from 'mdast';
|
||||
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {Transformer, Processor, Parent, Plugin} from 'unified';
|
||||
import type {
|
||||
Directives,
|
||||
TextDirective,
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
} from 'mdast-util-directive';
|
||||
import type {Parent} from 'unist';
|
||||
import type {Transformer, Processor, Plugin} from 'unified';
|
||||
import type {Directives, TextDirective} from 'mdast-util-directive';
|
||||
|
||||
type DirectiveType = Directives['type'];
|
||||
|
||||
|
@ -133,21 +128,18 @@ const plugin: Plugin<unknown[], Root> = function plugin(
|
|||
|
||||
const unusedDirectives: Directives[] = [];
|
||||
|
||||
visit<Parent, DirectiveType[]>(
|
||||
tree,
|
||||
directiveTypes,
|
||||
(directive: Directives) => {
|
||||
// If directive data is set (hName/hProperties set by admonitions)
|
||||
// this usually means the directive has been handled by another plugin
|
||||
if (isUnusedDirective(directive)) {
|
||||
if (isSimpleTextDirective(directive)) {
|
||||
transformSimpleTextDirectiveToString(directive);
|
||||
} else {
|
||||
unusedDirectives.push(directive);
|
||||
}
|
||||
// @ts-expect-error: TODO fix type
|
||||
visit<Parent, Directives>(tree, directiveTypes, (directive: Directives) => {
|
||||
// If directive data is set (hName/hProperties set by admonitions)
|
||||
// this usually means the directive has been handled by another plugin
|
||||
if (isUnusedDirective(directive)) {
|
||||
if (isSimpleTextDirective(directive)) {
|
||||
transformSimpleTextDirectiveToString(directive);
|
||||
} else {
|
||||
unusedDirectives.push(directive);
|
||||
}
|
||||
},
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
// We only enable these warnings for the client compiler
|
||||
// This avoids emitting duplicate warnings in prod mode
|
||||
|
|
|
@ -5,15 +5,8 @@
|
|||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
|
||||
import escapeHtml from 'escape-html';
|
||||
import type {Parent, Node} from 'unist';
|
||||
import type {PhrasingContent, Heading} from 'mdast';
|
||||
import type {
|
||||
MdxJsxAttribute,
|
||||
MdxJsxAttributeValueExpression,
|
||||
MdxJsxTextElement,
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
} from 'mdast-util-mdx';
|
||||
import type {Node} from 'unist';
|
||||
import type {MdxJsxAttributeValueExpression} from 'mdast-util-mdx';
|
||||
|
||||
/**
|
||||
* Util to transform one node type to another node type
|
||||
|
@ -36,70 +29,6 @@ export function transformNode<NewNode extends Node>(
|
|||
return node as NewNode;
|
||||
}
|
||||
|
||||
export function stringifyContent(
|
||||
node: Parent,
|
||||
toString: (param: unknown) => string, // TODO weird but works
|
||||
): string {
|
||||
return (node.children as PhrasingContent[])
|
||||
.map((item) => toValue(item, toString))
|
||||
.join('');
|
||||
}
|
||||
|
||||
// TODO This is really a workaround, and not super reliable
|
||||
// For now we only support serializing tagName, className and content
|
||||
// Can we implement the TOC with real JSX nodes instead of html strings later?
|
||||
function mdxJsxTextElementToHtml(
|
||||
element: MdxJsxTextElement,
|
||||
toString: (param: unknown) => string, // TODO weird but works
|
||||
): string {
|
||||
const tag = element.name;
|
||||
|
||||
const attributes = element.attributes.filter(
|
||||
(child): child is MdxJsxAttribute => child.type === 'mdxJsxAttribute',
|
||||
);
|
||||
|
||||
const classAttribute =
|
||||
attributes.find((attr) => attr.name === 'className') ??
|
||||
attributes.find((attr) => attr.name === 'class');
|
||||
|
||||
const classAttributeString = classAttribute
|
||||
? `class="${escapeHtml(String(classAttribute.value))}"`
|
||||
: ``;
|
||||
|
||||
const allAttributes = classAttributeString ? ` ${classAttributeString}` : '';
|
||||
|
||||
const content = stringifyContent(element, toString);
|
||||
|
||||
return `<${tag}${allAttributes}>${content}</${tag}>`;
|
||||
}
|
||||
|
||||
export function toValue(
|
||||
node: PhrasingContent | Heading | MdxJsxTextElement,
|
||||
toString: (param: unknown) => string, // TODO weird but works
|
||||
): string {
|
||||
switch (node.type) {
|
||||
case 'mdxJsxTextElement': {
|
||||
return mdxJsxTextElementToHtml(node as MdxJsxTextElement, toString);
|
||||
}
|
||||
case 'text':
|
||||
return escapeHtml(node.value);
|
||||
case 'heading':
|
||||
return stringifyContent(node, toString);
|
||||
case 'inlineCode':
|
||||
return `<code>${escapeHtml(node.value)}</code>`;
|
||||
case 'emphasis':
|
||||
return `<em>${stringifyContent(node, toString)}</em>`;
|
||||
case 'strong':
|
||||
return `<strong>${stringifyContent(node, toString)}</strong>`;
|
||||
case 'delete':
|
||||
return `<del>${stringifyContent(node, toString)}</del>`;
|
||||
case 'link':
|
||||
return stringifyContent(node, toString);
|
||||
default:
|
||||
return toString(node);
|
||||
}
|
||||
}
|
||||
|
||||
export function assetRequireAttributeValue(
|
||||
requireString: string,
|
||||
hash: string,
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@docusaurus/module-type-aliases",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"description": "Docusaurus module type aliases.",
|
||||
"types": "./src/index.d.ts",
|
||||
"publishConfig": {
|
||||
|
@ -12,12 +12,12 @@
|
|||
"directory": "packages/docusaurus-module-type-aliases"
|
||||
},
|
||||
"dependencies": {
|
||||
"@docusaurus/types": "3.6.2",
|
||||
"@docusaurus/types": "3.7.0",
|
||||
"@types/history": "^4.7.11",
|
||||
"@types/react": "*",
|
||||
"@types/react-router-config": "*",
|
||||
"@types/react-router-dom": "*",
|
||||
"react-helmet-async": "*",
|
||||
"react-helmet-async": "npm:@slorber/react-helmet-async@1.3.0",
|
||||
"react-loadable": "npm:@docusaurus/react-loadable@6.0.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
|
|
|
@ -84,10 +84,11 @@ declare module '@theme-original/*';
|
|||
declare module '@theme-init/*';
|
||||
|
||||
declare module '@theme/Error' {
|
||||
import type {ReactNode} from 'react';
|
||||
import type {FallbackParams} from '@docusaurus/ErrorBoundary';
|
||||
|
||||
export interface Props extends FallbackParams {}
|
||||
export default function Error(props: Props): JSX.Element;
|
||||
export default function Error(props: Props): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/Layout' {
|
||||
|
@ -96,17 +97,20 @@ declare module '@theme/Layout' {
|
|||
export interface Props {
|
||||
readonly children?: ReactNode;
|
||||
}
|
||||
export default function Layout(props: Props): JSX.Element;
|
||||
export default function Layout(props: Props): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/Loading' {
|
||||
import type {ReactNode} from 'react';
|
||||
import type {LoadingComponentProps} from 'react-loadable';
|
||||
|
||||
export default function Loading(props: LoadingComponentProps): JSX.Element;
|
||||
export default function Loading(props: LoadingComponentProps): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/NotFound' {
|
||||
export default function NotFound(): JSX.Element;
|
||||
import type {ReactNode} from 'react';
|
||||
|
||||
export default function NotFound(): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/Root' {
|
||||
|
@ -115,11 +119,22 @@ declare module '@theme/Root' {
|
|||
export interface Props {
|
||||
readonly children: ReactNode;
|
||||
}
|
||||
export default function Root({children}: Props): JSX.Element;
|
||||
export default function Root({children}: Props): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/ThemeProvider' {
|
||||
import type {ReactNode} from 'react';
|
||||
|
||||
export interface Props {
|
||||
readonly children: ReactNode;
|
||||
}
|
||||
export default function ThemeProvider({children}: Props): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/SiteMetadata' {
|
||||
export default function SiteMetadata(): JSX.Element;
|
||||
import type {ReactNode} from 'react';
|
||||
|
||||
export default function SiteMetadata(): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@docusaurus/constants' {
|
||||
|
@ -134,13 +149,13 @@ declare module '@docusaurus/ErrorBoundary' {
|
|||
readonly tryAgain: () => void;
|
||||
};
|
||||
|
||||
export type FallbackFunction = (params: FallbackParams) => JSX.Element;
|
||||
export type FallbackFunction = (params: FallbackParams) => ReactNode;
|
||||
|
||||
export interface Props {
|
||||
readonly fallback?: FallbackFunction;
|
||||
readonly children: ReactNode;
|
||||
}
|
||||
export default function ErrorBoundary(props: Props): JSX.Element;
|
||||
export default function ErrorBoundary(props: Props): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@docusaurus/Head' {
|
||||
|
@ -149,11 +164,11 @@ declare module '@docusaurus/Head' {
|
|||
|
||||
export type Props = HelmetProps & {children: ReactNode};
|
||||
|
||||
export default function Head(props: Props): JSX.Element;
|
||||
export default function Head(props: Props): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@docusaurus/Link' {
|
||||
import type {CSSProperties, ComponentProps} from 'react';
|
||||
import type {CSSProperties, ComponentProps, ReactNode} from 'react';
|
||||
import type {NavLinkProps as RRNavLinkProps} from 'react-router-dom';
|
||||
|
||||
type NavLinkProps = Partial<RRNavLinkProps>;
|
||||
|
@ -169,7 +184,7 @@ declare module '@docusaurus/Link' {
|
|||
/** Escape hatch in case broken links check doesn't make sense. */
|
||||
readonly 'data-noBrokenLinkCheck'?: boolean;
|
||||
};
|
||||
export default function Link(props: Props): JSX.Element;
|
||||
export default function Link(props: Props): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@docusaurus/Interpolate' {
|
||||
|
@ -203,7 +218,7 @@ declare module '@docusaurus/Interpolate' {
|
|||
|
||||
export default function Interpolate<Str extends string>(
|
||||
props: InterpolateProps<Str>,
|
||||
): JSX.Element;
|
||||
): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@docusaurus/Translate' {
|
||||
|
@ -241,7 +256,7 @@ declare module '@docusaurus/Translate' {
|
|||
|
||||
export default function Translate<Str extends string>(
|
||||
props: TranslateProps<Str>,
|
||||
): JSX.Element;
|
||||
): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@docusaurus/router' {
|
||||
|
@ -318,11 +333,13 @@ declare module '@docusaurus/ComponentCreator' {
|
|||
}
|
||||
|
||||
declare module '@docusaurus/BrowserOnly' {
|
||||
import type {ReactNode} from 'react';
|
||||
|
||||
export interface Props {
|
||||
readonly children?: () => JSX.Element;
|
||||
readonly fallback?: JSX.Element;
|
||||
readonly children?: () => ReactNode;
|
||||
readonly fallback?: ReactNode;
|
||||
}
|
||||
export default function BrowserOnly(props: Props): JSX.Element | null;
|
||||
export default function BrowserOnly(props: Props): ReactNode | null;
|
||||
}
|
||||
|
||||
declare module '@docusaurus/isInternalUrl' {
|
||||
|
@ -369,6 +386,9 @@ declare module '@docusaurus/useGlobalData' {
|
|||
export default function useGlobalData(): GlobalData;
|
||||
}
|
||||
|
||||
// TODO find a way to move this ambient type to the SVGR plugin?
|
||||
// unfortunately looks complicated in practice
|
||||
// see https://x.com/sebastienlorber/status/1859543512661832053
|
||||
declare module '*.svg' {
|
||||
import type {ComponentType, SVGProps} from 'react';
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@docusaurus/plugin-client-redirects",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"description": "Client redirects plugin for Docusaurus.",
|
||||
"main": "lib/index.js",
|
||||
"types": "lib/index.d.ts",
|
||||
|
@ -18,22 +18,22 @@
|
|||
},
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "3.6.2",
|
||||
"@docusaurus/logger": "3.6.2",
|
||||
"@docusaurus/utils": "3.6.2",
|
||||
"@docusaurus/utils-common": "3.6.2",
|
||||
"@docusaurus/utils-validation": "3.6.2",
|
||||
"@docusaurus/core": "3.7.0",
|
||||
"@docusaurus/logger": "3.7.0",
|
||||
"@docusaurus/utils": "3.7.0",
|
||||
"@docusaurus/utils-common": "3.7.0",
|
||||
"@docusaurus/utils-validation": "3.7.0",
|
||||
"eta": "^2.2.0",
|
||||
"fs-extra": "^11.1.1",
|
||||
"lodash": "^4.17.21",
|
||||
"tslib": "^2.6.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@docusaurus/types": "3.6.2"
|
||||
"@docusaurus/types": "3.7.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"react": "^18.0.0",
|
||||
"react-dom": "^18.0.0"
|
||||
"react": "^18.0.0 || ^19.0.0",
|
||||
"react-dom": "^18.0.0 || ^19.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=18.0"
|
||||
|
|
|
@ -71,7 +71,7 @@
|
|||
<div class="blog-posts">
|
||||
<xsl:for-each select="atom:feed/atom:entry">
|
||||
<div class="blog-post">
|
||||
<h3><a href="{atom:link[@rel='alternate']/@href}"><xsl:value-of
|
||||
<h3><a href="{atom:link/@href}"><xsl:value-of
|
||||
select="atom:title"
|
||||
/></a></h3>
|
||||
<div class="blog-post-date">
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@docusaurus/plugin-content-blog",
|
||||
"version": "3.6.2",
|
||||
"version": "3.7.0",
|
||||
"description": "Blog plugin for Docusaurus.",
|
||||
"main": "lib/index.js",
|
||||
"types": "src/plugin-content-blog.d.ts",
|
||||
|
@ -31,19 +31,20 @@
|
|||
},
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "3.6.2",
|
||||
"@docusaurus/logger": "3.6.2",
|
||||
"@docusaurus/mdx-loader": "3.6.2",
|
||||
"@docusaurus/theme-common": "3.6.2",
|
||||
"@docusaurus/types": "3.6.2",
|
||||
"@docusaurus/utils": "3.6.2",
|
||||
"@docusaurus/utils-common": "3.6.2",
|
||||
"@docusaurus/utils-validation": "3.6.2",
|
||||
"@docusaurus/core": "3.7.0",
|
||||
"@docusaurus/logger": "3.7.0",
|
||||
"@docusaurus/mdx-loader": "3.7.0",
|
||||
"@docusaurus/theme-common": "3.7.0",
|
||||
"@docusaurus/types": "3.7.0",
|
||||
"@docusaurus/utils": "3.7.0",
|
||||
"@docusaurus/utils-common": "3.7.0",
|
||||
"@docusaurus/utils-validation": "3.7.0",
|
||||
"cheerio": "1.0.0-rc.12",
|
||||
"feed": "^4.2.2",
|
||||
"fs-extra": "^11.1.1",
|
||||
"lodash": "^4.17.21",
|
||||
"reading-time": "^1.5.0",
|
||||
"schema-dts": "^1.1.2",
|
||||
"srcset": "^4.0.0",
|
||||
"tslib": "^2.6.0",
|
||||
"unist-util-visit": "^5.0.0",
|
||||
|
@ -52,8 +53,8 @@
|
|||
},
|
||||
"peerDependencies": {
|
||||
"@docusaurus/plugin-content-docs": "*",
|
||||
"react": "^18.0.0",
|
||||
"react-dom": "^18.0.0"
|
||||
"react": "^18.0.0 || ^19.0.0",
|
||||
"react-dom": "^18.0.0 || ^19.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=18.0"
|
||||
|
|
|
@ -71,7 +71,7 @@
|
|||
<div class="blog-posts">
|
||||
<xsl:for-each select="atom:feed/atom:entry">
|
||||
<div class="blog-post">
|
||||
<h3><a href="{atom:link[@rel='alternate']/@href}"><xsl:value-of
|
||||
<h3><a href="{atom:link/@href}"><xsl:value-of
|
||||
select="atom:title"
|
||||
/></a></h3>
|
||||
<div class="blog-post-date">
|
||||
|
|
|
@ -15,14 +15,26 @@ describe('normalizeSocials', () => {
|
|||
linkedin: 'ozakione',
|
||||
github: 'ozakione',
|
||||
stackoverflow: 'ozakione',
|
||||
threads: 'gingergeekuk',
|
||||
bluesky: 'gingergeek.co.uk',
|
||||
instagram: 'thisweekinreact',
|
||||
twitch: 'gingergeek',
|
||||
youtube: 'gingergeekuk',
|
||||
mastodon: 'Mastodon',
|
||||
};
|
||||
|
||||
expect(normalizeSocials(socials)).toMatchInlineSnapshot(`
|
||||
{
|
||||
"bluesky": "https://bsky.app/profile/gingergeek.co.uk",
|
||||
"github": "https://github.com/ozakione",
|
||||
"instagram": "https://www.instagram.com/thisweekinreact",
|
||||
"linkedin": "https://www.linkedin.com/in/ozakione/",
|
||||
"mastodon": "https://mastodon.social/@Mastodon",
|
||||
"stackoverflow": "https://stackoverflow.com/users/ozakione",
|
||||
"threads": "https://www.threads.net/@gingergeekuk",
|
||||
"twitch": "https://twitch.tv/gingergeek",
|
||||
"twitter": "https://twitter.com/ozakione",
|
||||
"youtube": "https://youtube.com/@gingergeekuk",
|
||||
}
|
||||
`);
|
||||
});
|
||||
|
@ -33,13 +45,19 @@ describe('normalizeSocials', () => {
|
|||
linkedIn: 'ozakione',
|
||||
gitHub: 'ozakione',
|
||||
STACKoverflow: 'ozakione',
|
||||
instaGRam: 'thisweekinreact',
|
||||
BLUESKY: 'gingergeek.co.uk',
|
||||
tHrEaDs: 'gingergeekuk',
|
||||
};
|
||||
|
||||
expect(normalizeSocials(socials)).toMatchInlineSnapshot(`
|
||||
{
|
||||
"bluesky": "https://bsky.app/profile/gingergeek.co.uk",
|
||||
"github": "https://github.com/ozakione",
|
||||
"instagram": "https://www.instagram.com/thisweekinreact",
|
||||
"linkedin": "https://www.linkedin.com/in/ozakione/",
|
||||
"stackoverflow": "https://stackoverflow.com/users/ozakione",
|
||||
"threads": "https://www.threads.net/@gingergeekuk",
|
||||
"twitter": "https://twitter.com/ozakione",
|
||||
}
|
||||
`);
|
||||
|
@ -62,12 +80,14 @@ describe('normalizeSocials', () => {
|
|||
linkedin: 'ozakione',
|
||||
github: 'https://github.com/ozakione',
|
||||
stackoverflow: 'https://stackoverflow.com/ozakione',
|
||||
mastodon: 'https://hachyderm.io/@hachyderm',
|
||||
};
|
||||
|
||||
expect(normalizeSocials(socials)).toMatchInlineSnapshot(`
|
||||
{
|
||||
"github": "https://github.com/ozakione",
|
||||
"linkedin": "https://www.linkedin.com/in/ozakione/",
|
||||
"mastodon": "https://hachyderm.io/@hachyderm",
|
||||
"stackoverflow": "https://stackoverflow.com/ozakione",
|
||||
"twitter": "https://twitter.com/ozakione",
|
||||
}
|
||||
|
|
|
@ -79,6 +79,7 @@ describe('validateBlogPostFrontMatter description', () => {
|
|||
prefix: 'description',
|
||||
validFrontMatters: [
|
||||
// See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
|
||||
{description: undefined},
|
||||
{description: ''},
|
||||
{description: 'description'},
|
||||
],
|
||||
|
@ -90,6 +91,7 @@ describe('validateBlogPostFrontMatter title', () => {
|
|||
prefix: 'title',
|
||||
validFrontMatters: [
|
||||
// See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
|
||||
{title: undefined},
|
||||
{title: ''},
|
||||
{title: 'title'},
|
||||
],
|
||||
|
@ -103,7 +105,11 @@ describe('validateBlogPostFrontMatter title', () => {
|
|||
describe('validateBlogPostFrontMatter title_meta', () => {
|
||||
testField({
|
||||
prefix: 'title_meta',
|
||||
validFrontMatters: [{title: ''}, {title_meta: 'title'}],
|
||||
validFrontMatters: [
|
||||
{title_meta: undefined},
|
||||
{title_meta: ''},
|
||||
{title_meta: 'title'},
|
||||
],
|
||||
invalidFrontMatters: [
|
||||
[{title_meta: null}, 'must be a string'],
|
||||
[{title_meta: false}, 'must be a string'],
|
||||
|
@ -111,6 +117,21 @@ describe('validateBlogPostFrontMatter title_meta', () => {
|
|||
});
|
||||
});
|
||||
|
||||
describe('validateBlogPostFrontMatter sidebar_label', () => {
|
||||
testField({
|
||||
prefix: 'title_meta',
|
||||
validFrontMatters: [
|
||||
{sidebar_label: undefined},
|
||||
{sidebar_label: ''},
|
||||
{sidebar_label: 'title'},
|
||||
],
|
||||
invalidFrontMatters: [
|
||||
[{sidebar_label: null}, 'must be a string'],
|
||||
[{sidebar_label: false}, 'must be a string'],
|
||||
],
|
||||
});
|
||||
});
|
||||
|
||||
describe('validateBlogPostFrontMatter id', () => {
|
||||
testField({
|
||||
prefix: 'id',
|
||||
|
|
|
@ -94,7 +94,7 @@ describe('toBlogSidebarProp', () => {
|
|||
permalink: '/blog/blog-2',
|
||||
unlisted: true,
|
||||
date: '2024-01-01',
|
||||
frontMatter: {hello: 'world'},
|
||||
frontMatter: {hello: 'world', sidebar_label: 'title 2 (custom)'},
|
||||
tags: [{label: 'tag1', permalink: '/tag1', inline: false}],
|
||||
},
|
||||
}),
|
||||
|
@ -117,7 +117,7 @@ describe('toBlogSidebarProp', () => {
|
|||
{
|
||||
"date": "2024-01-01",
|
||||
"permalink": "/blog/blog-2",
|
||||
"title": "title 2",
|
||||
"title": "title 2 (custom)",
|
||||
"unlisted": true,
|
||||
},
|
||||
],
|
||||
|
|
|
@ -21,6 +21,12 @@ export const AuthorSocialsSchema = Joi.object<AuthorSocials>({
|
|||
.try(Joi.number(), Joi.string())
|
||||
.custom((val) => String(val)),
|
||||
x: Joi.string(),
|
||||
bluesky: Joi.string(),
|
||||
instagram: Joi.string(),
|
||||
threads: Joi.string(),
|
||||
mastodon: Joi.string(),
|
||||
twitch: Joi.string(),
|
||||
youtube: Joi.string(),
|
||||
}).unknown();
|
||||
|
||||
type PredefinedPlatformNormalizer = (value: string) => string;
|
||||
|
@ -35,6 +41,12 @@ const PredefinedPlatformNormalizers: Record<
|
|||
linkedin: (handle: string) => `https://www.linkedin.com/in/${handle}/`,
|
||||
stackoverflow: (userId: string) =>
|
||||
`https://stackoverflow.com/users/${userId}`,
|
||||
bluesky: (handle: string) => `https://bsky.app/profile/${handle}`,
|
||||
instagram: (handle: string) => `https://www.instagram.com/${handle}`,
|
||||
threads: (handle: string) => `https://www.threads.net/@${handle}`,
|
||||
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
|
||||
};
|
||||
|
||||
type SocialEntry = [string, string];
|
||||
|
|
|
@ -74,7 +74,7 @@ export function BlogPostProvider({
|
|||
children: ReactNode;
|
||||
content: PropBlogPostContent;
|
||||
isBlogPostPage?: boolean;
|
||||
}): JSX.Element {
|
||||
}): ReactNode {
|
||||
const contextValue = useContextValue({content, isBlogPostPage});
|
||||
return <Context.Provider value={contextValue}>{children}</Context.Provider>;
|
||||
}
|
||||
|
|
|
@ -33,7 +33,8 @@ const FrontMatterAuthorErrorMessage =
|
|||
const BlogFrontMatterSchema = Joi.object<BlogPostFrontMatter>({
|
||||
id: Joi.string(),
|
||||
title: Joi.string().allow(''),
|
||||
title_meta: Joi.string(),
|
||||
title_meta: Joi.string().allow(''),
|
||||
sidebar_label: Joi.string().allow(''),
|
||||
description: Joi.string().allow(''),
|
||||
tags: FrontMatterTagsSchema,
|
||||
date: Joi.date().raw(),
|
||||
|
|
|
@ -16,7 +16,12 @@ declare module '@docusaurus/plugin-content-blog' {
|
|||
FrontMatterLastUpdate,
|
||||
TagsPluginOptions,
|
||||
} from '@docusaurus/utils';
|
||||
import type {DocusaurusConfig, Plugin, LoadContext} from '@docusaurus/types';
|
||||
import type {
|
||||
DocusaurusConfig,
|
||||
Plugin,
|
||||
LoadContext,
|
||||
OptionValidationContext,
|
||||
} from '@docusaurus/types';
|
||||
import type {Item as FeedItem} from 'feed';
|
||||
import type {Overwrite} from 'utility-types';
|
||||
|
||||
|
@ -46,7 +51,13 @@ declare module '@docusaurus/plugin-content-blog' {
|
|||
| 'github'
|
||||
| 'linkedin'
|
||||
| 'stackoverflow'
|
||||
| 'x';
|
||||
| 'x'
|
||||
| 'bluesky'
|
||||
| 'instagram'
|
||||
| 'threads'
|
||||
| 'mastodon'
|
||||
| 'youtube'
|
||||
| 'twitch';
|
||||
|
||||
/**
|
||||
* Social platforms of the author.
|
||||
|
@ -145,7 +156,6 @@ declare module '@docusaurus/plugin-content-blog' {
|
|||
title?: string;
|
||||
/**
|
||||
* Will be used for SEO page metadata and override BlogPostMetadata.title.
|
||||
* @see {@link BlogPostMetadata.title_meta}
|
||||
*/
|
||||
title_meta?: string;
|
||||
/**
|
||||
|
@ -153,6 +163,10 @@ declare module '@docusaurus/plugin-content-blog' {
|
|||
* @see {@link BlogPostMetadata.description}
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Will override the default excerpt.
|
||||
*/
|
||||
sidebar_label?: string;
|
||||
/**
|
||||
* Front matter tags, unnormalized.
|
||||
* @see {@link BlogPostMetadata.tags}
|
||||
|
@ -657,9 +671,14 @@ declare module '@docusaurus/plugin-content-blog' {
|
|||
context: LoadContext,
|
||||
options: PluginOptions,
|
||||
): Promise<Plugin<BlogContent>>;
|
||||
|
||||
export function validateOptions(
|
||||
args: OptionValidationContext<Options | undefined, PluginOptions>,
|
||||
): PluginOptions;
|
||||
}
|
||||
|
||||
declare module '@theme/BlogPostPage' {
|
||||
import type {ReactNode} from 'react';
|
||||
import type {
|
||||
BlogPostFrontMatter,
|
||||
BlogSidebar,
|
||||
|
@ -680,18 +699,23 @@ declare module '@theme/BlogPostPage' {
|
|||
readonly blogMetadata: BlogMetadata;
|
||||
}
|
||||
|
||||
export default function BlogPostPage(props: Props): JSX.Element;
|
||||
export default function BlogPostPage(props: Props): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/BlogPostPage/Metadata' {
|
||||
export default function BlogPostPageMetadata(): JSX.Element;
|
||||
import type {ReactNode} from 'react';
|
||||
|
||||
export default function BlogPostPageMetadata(): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/BlogPostPage/StructuredData' {
|
||||
export default function BlogPostStructuredData(): JSX.Element;
|
||||
import type {ReactNode} from 'react';
|
||||
|
||||
export default function BlogPostStructuredData(): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/BlogListPage' {
|
||||
import type {ReactNode} from 'react';
|
||||
import type {Content} from '@theme/BlogPostPage';
|
||||
import type {
|
||||
BlogSidebar,
|
||||
|
@ -710,10 +734,11 @@ declare module '@theme/BlogListPage' {
|
|||
readonly items: readonly {readonly content: Content}[];
|
||||
}
|
||||
|
||||
export default function BlogListPage(props: Props): JSX.Element;
|
||||
export default function BlogListPage(props: Props): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/BlogListPage/StructuredData' {
|
||||
import type {ReactNode} from 'react';
|
||||
import type {Content} from '@theme/BlogPostPage';
|
||||
import type {
|
||||
BlogSidebar,
|
||||
|
@ -732,10 +757,11 @@ declare module '@theme/BlogListPage/StructuredData' {
|
|||
readonly items: readonly {readonly content: Content}[];
|
||||
}
|
||||
|
||||
export default function BlogListPageStructuredData(props: Props): JSX.Element;
|
||||
export default function BlogListPageStructuredData(props: Props): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/BlogTagsListPage' {
|
||||
import type {ReactNode} from 'react';
|
||||
import type {BlogSidebar} from '@docusaurus/plugin-content-blog';
|
||||
import type {TagsListItem} from '@docusaurus/utils';
|
||||
|
||||
|
@ -746,10 +772,11 @@ declare module '@theme/BlogTagsListPage' {
|
|||
readonly tags: TagsListItem[];
|
||||
}
|
||||
|
||||
export default function BlogTagsListPage(props: Props): JSX.Element;
|
||||
export default function BlogTagsListPage(props: Props): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/Blog/Pages/BlogAuthorsListPage' {
|
||||
import type {ReactNode} from 'react';
|
||||
import type {
|
||||
AuthorItemProp,
|
||||
BlogSidebar,
|
||||
|
@ -762,10 +789,11 @@ declare module '@theme/Blog/Pages/BlogAuthorsListPage' {
|
|||
readonly authors: AuthorItemProp[];
|
||||
}
|
||||
|
||||
export default function BlogAuthorsListPage(props: Props): JSX.Element;
|
||||
export default function BlogAuthorsListPage(props: Props): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/Blog/Pages/BlogAuthorsPostsPage' {
|
||||
import type {ReactNode} from 'react';
|
||||
import type {Content} from '@theme/BlogPostPage';
|
||||
import type {
|
||||
AuthorItemProp,
|
||||
|
@ -787,10 +815,11 @@ declare module '@theme/Blog/Pages/BlogAuthorsPostsPage' {
|
|||
readonly items: readonly {readonly content: Content}[];
|
||||
}
|
||||
|
||||
export default function BlogAuthorsPostsPage(props: Props): JSX.Element;
|
||||
export default function BlogAuthorsPostsPage(props: Props): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/BlogTagsPostsPage' {
|
||||
import type {ReactNode} from 'react';
|
||||
import type {Content} from '@theme/BlogPostPage';
|
||||
import type {
|
||||
BlogSidebar,
|
||||
|
@ -812,10 +841,11 @@ declare module '@theme/BlogTagsPostsPage' {
|
|||
readonly items: readonly {readonly content: Content}[];
|
||||
}
|
||||
|
||||
export default function BlogTagsPostsPage(props: Props): JSX.Element;
|
||||
export default function BlogTagsPostsPage(props: Props): ReactNode;
|
||||
}
|
||||
|
||||
declare module '@theme/BlogArchivePage' {
|
||||
import type {ReactNode} from 'react';
|
||||
import type {Content} from '@theme/BlogPostPage';
|
||||
|
||||
/** We may add extra metadata or prune some metadata from here */
|
||||
|
@ -829,5 +859,5 @@ declare module '@theme/BlogArchivePage' {
|
|||
};
|
||||
}
|
||||
|
||||
export default function BlogArchivePage(props: Props): JSX.Element;
|
||||
export default function BlogArchivePage(props: Props): ReactNode;
|
||||
}
|
||||
|
|
|
@ -65,7 +65,8 @@ export function toBlogSidebarProp({
|
|||
return {
|
||||
title: blogSidebarTitle,
|
||||
items: blogPosts.map((blogPost) => ({
|
||||
title: blogPost.metadata.title,
|
||||
title:
|
||||
blogPost.metadata.frontMatter.sidebar_label ?? blogPost.metadata.title,
|
||||
permalink: blogPost.metadata.permalink,
|
||||
unlisted: blogPost.metadata.unlisted,
|
||||
date: blogPost.metadata.date,
|
||||
|
|
|
@ -6,7 +6,6 @@
|
|||
*/
|
||||
|
||||
import {simpleHash} from '@docusaurus/utils';
|
||||
// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
|
||||
import type {Transformer} from 'unified';
|
||||
import type {FootnoteReference, FootnoteDefinition} from 'mdast';
|
||||
|
||||
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue