Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .agents/skills/code-style/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ async function main() {

```ts
// The toggle event also fires when React syncs the open attribute
// See https://github.com/facebook/docusaurus/pull/12277
// See https://github.com/meta/docusaurus/pull/12277
```

## Readability over micro-optimizations
Expand Down
2 changes: 1 addition & 1 deletion .agents/skills/pull-requests/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: pull-requests
description: Create, update, check the CI of, or merge a facebook/docusaurus pull request. Use before running `gh pr create`, pushing commits to an existing PR, reading its CI checks or bot comments, or merging it. Docusaurus maintainers only.
description: Create, update, check the CI of, or merge a meta/docusaurus pull request. Use before running `gh pr create`, pushing commits to an existing PR, reading its CI checks or bot comments, or merging it. Docusaurus maintainers only.
---

# Pull requests
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ body:
- Do I have basic ideas about where it goes wrong? (For example, if there are stack traces, are they pointing to one file?)
- Could it be because of my own mistakes?

**The GitHub issue tracker is not a support forum**. If you are not sure whether it could be your mistakes, ask in the [Discord server](https://discord.gg/docusaurus) or [GitHub discussions](https://github.com/facebook/docusaurus/discussions) first. The quickest way to verify whether it's a Docusaurus defect is through a **reproduction**, starting with a fresh installation and making changes until the bug is reproduced.
**The GitHub issue tracker is not a support forum**. If you are not sure whether it could be your mistakes, ask in the [Discord server](https://discord.gg/docusaurus) or [GitHub discussions](https://github.com/meta/docusaurus/discussions) first. The quickest way to verify whether it's a Docusaurus defect is through a **reproduction**, starting with a fresh installation and making changes until the bug is reproduced.

Make the bug obvious. Ideally, we should be able to understand it without running any code.

Expand All @@ -26,7 +26,7 @@ body:
attributes:
label: Have you read the Contributing Guidelines on issues?
options:
- label: I have read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#issues).
- label: I have read the [Contributing Guidelines on issues](https://github.com/meta/docusaurus/blob/main/CONTRIBUTING.md#issues).
required: true

- type: checkboxes
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ contact_links:
url: https://stackoverflow.com/questions/tagged/docusaurus
about: This issue tracker is not for technical support. Please use Stack Overflow, and ask the community for help.
- name: ❓ Advanced question - GitHub Discussions
url: https://github.com/facebook/docusaurus/discussions
url: https://github.com/meta/docusaurus/discussions
about: Use GitHub Discussions for advanced and unanswered questions only, requiring a maintainer's answer. Make sure the question wasn't already asked.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ body:
attributes:
label: Have you read the Contributing Guidelines on issues?
options:
- label: I have read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#issues).
- label: I have read the [Contributing Guidelines on issues](https://github.com/meta/docusaurus/blob/main/CONTRIBUTING.md#issues).
required: true

- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ body:
attributes:
label: Have you read the Contributing Guidelines on issues?
options:
- label: I have read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#issues).
- label: I have read the [Contributing Guidelines on issues](https://github.com/meta/docusaurus/blob/main/CONTRIBUTING.md#issues).
required: true

- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/proposal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ body:
attributes:
label: Have you read the Contributing Guidelines on issues?
options:
- label: I have read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#issues).
- label: I have read the [Contributing Guidelines on issues](https://github.com/meta/docusaurus/blob/main/CONTRIBUTING.md#issues).
required: true

- type: textarea
Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!--
Thank you for sending the PR! We appreciate you spending the time to work on these changes.
You can learn more about contributing to Docusaurus here: https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md
You can learn more about contributing to Docusaurus here: https://github.com/meta/docusaurus/blob/main/CONTRIBUTING.md
Happy contributing!
-->

## Pre-flight checklist

- [ ] I have read the [Contributing Guidelines on pull requests](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#pull-requests).
- [ ] I have read the [Contributing Guidelines on pull requests](https://github.com/meta/docusaurus/blob/main/CONTRIBUTING.md#pull-requests).
- [ ] **If this is a code change**: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
- [ ] **If this is a new API or substantial change**: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Expand Down
4 changes: 2 additions & 2 deletions .github/codeql/codeql-config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ paths-ignore:
# The inputs (files, CLI args) are usually controlled locally
query-filters:
# Many false positives
# Example: https://github.com/facebook/docusaurus/security/code-scanning/168
# Example: https://github.com/meta/docusaurus/security/code-scanning/168
- exclude:
id: js/path-injection
# Many false positives
# Example: https://github.com/facebook/docusaurus/security/code-scanning/150
# Example: https://github.com/meta/docusaurus/security/code-scanning/150
- exclude:
id: js/polynomial-redos
# - exclude:
Expand Down
6 changes: 3 additions & 3 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ updates:
default-days: 5
semver-major-days: 30
# +1d compared to pnpm cutoff, otherwise Dependabot opens PRs too early
# See https://github.com/facebook/docusaurus/pull/12241
# See https://github.com/meta/docusaurus/pull/12241
semver-minor-days: 8
semver-patch-days: 8
# Packages that must be upgraded atomically in a single PR
# pnpm lint:catalogs checks that the catalog versions of each group match
groups:
# Released in lockstep, mixing versions breaks typechecking
# See https://github.com/facebook/docusaurus/pull/12634
# See https://github.com/meta/docusaurus/pull/12634
typescript-eslint:
patterns:
- 'typescript-eslint'
Expand Down Expand Up @@ -70,7 +70,7 @@ updates:
- '@svgr/*'
# Babel packages depend on each other
# Upgrading them independently duplicates Babel packages in the lockfile
# See https://github.com/facebook/docusaurus/pull/12704
# See https://github.com/meta/docusaurus/pull/12704
babel:
patterns:
- '@babel/*'
6 changes: 3 additions & 3 deletions .github/workflows/build-hash-router.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ jobs:
DOCUSAURUS_PERF_LOGGER: 'true'
DOCUSAURUS_ROUTER: 'hash'
# Note: hash router + baseUrl do not play well together
# This would host at https://facebook.github.io/docusaurus/#/docusaurus/
# This would host at https://meta.github.io/docusaurus/#/docusaurus/
# BASE_URL: '/docusaurus/' # hash router +

- name: Upload Website artifact
Expand All @@ -65,7 +65,7 @@ jobs:
# with:
# path: website/build

# Deploy to https://facebook.github.io/docusaurus/
# Deploy to https://meta.github.io/docusaurus/
- name: Deploy to GitHub Pages
if: ${{ github.event_name != 'pull_request' && github.ref_name == 'main' }}
uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0
Expand All @@ -75,7 +75,7 @@ jobs:

## TODO we should be able to use this new deploy-pages action
## However this requires a Meta admin to configure it here
## https://github.com/facebook/docusaurus/settings/pages
## https://github.com/meta/docusaurus/settings/pages
## So for now we keep using the former method
## See https://docusaurus.io/docs/deployment#triggering-deployment-with-github-actions
#deploy:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-perf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ jobs:
# Always rebuild packages, including for the base branch
install-script: bash -c "pnpm install --frozen-lockfile --ignore-scripts && pnpm build:packages"
build-script: build:website:fast
clean-script: clear:website # see https://github.com/facebook/docusaurus/pull/6838
clean-script: clear:website # see https://github.com/meta/docusaurus/pull/6838
pattern: '{website/build/assets/js/main*js,website/build/assets/js/runtime~main*js,website/build/assets/css/styles*css,website/.docusaurus/globalData.json,website/.docusaurus/registry.js,website/.docusaurus/routes.js,website/.docusaurus/routesChunkNames.json,website/.docusaurus/site-metadata.json,website/.docusaurus/codeTranslations.json,website/.docusaurus/i18n.json,website/.docusaurus/docusaurus.config.mjs,website/build/index.html,website/build/docs.html,website/build/docs/**/*.html,website/build/blog.html,website/build/blog/**/*.html}'
# HTML files: exclude versioned docs pages, tags pages, html redirect files
exclude: '{website/build/docs/?.?.?/**/*.html,website/build/docs/next/**/*.html,website/build/blog/tags/**/*.html,**/*.html.html}'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/security-supply-chain.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ jobs:

# Check our init template deps for new supply chain compromissions
# This workflow is not ideal but good enough for now
# See why https://github.com/facebook/docusaurus/pull/12448
# See why https://github.com/meta/docusaurus/pull/12448
supply-chain-site-template:
name: Supply Chain - Site Template @${{ matrix.npm_dist_tag }}
timeout-minutes: 30
Expand Down
20 changes: 10 additions & 10 deletions .github/workflows/tests-e2e.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,11 @@ jobs:
E2E_TEST: true
- name: Build test-website-in-workspace project
# We build 2 locales to ensure a localized site doesn't leak memory
# See https://github.com/facebook/docusaurus/issues/10944
# See https://github.com/meta/docusaurus/issues/10944
run: pnpm build --locale en --locale fr
env:
# Our website should build even with limited memory
# See https://github.com/facebook/docusaurus/pull/10590
# See https://github.com/meta/docusaurus/pull/10590
NODE_OPTIONS: '--max-old-space-size=200'
DOCUSAURUS_PERF_LOGGER: 'true'
working-directory: test-website-in-workspace
Expand Down Expand Up @@ -130,11 +130,11 @@ jobs:
E2E_TEST: true
- name: Build test-website project
# We build 2 locales to ensure a localized site doesn't leak memory
# See https://github.com/facebook/docusaurus/issues/10944
# See https://github.com/meta/docusaurus/issues/10944
run: yarn build --locale en --locale fr
env:
# Our website should build even with limited memory
# See https://github.com/facebook/docusaurus/pull/10590
# See https://github.com/meta/docusaurus/pull/10590
NODE_OPTIONS: '--max-old-space-size=200'
DOCUSAURUS_PERF_LOGGER: 'true'
working-directory: ../test-website
Expand Down Expand Up @@ -220,11 +220,11 @@ jobs:

- name: Build test-website project
# We build 2 locales to ensure a localized site doesn't leak memory
# See https://github.com/facebook/docusaurus/issues/10944
# See https://github.com/meta/docusaurus/issues/10944
run: yarn build --locale en --locale fr
env:
# Our website should build even with limited memory
# See https://github.com/facebook/docusaurus/pull/10590
# See https://github.com/meta/docusaurus/pull/10590
NODE_OPTIONS: '--max-old-space-size=200'
DOCUSAURUS_PERF_LOGGER: 'true'
working-directory: ../test-website
Expand Down Expand Up @@ -267,11 +267,11 @@ jobs:
E2E_TEST: true
- name: Build test-website project
# We build 2 locales to ensure a localized site doesn't leak memory
# See https://github.com/facebook/docusaurus/issues/10944
# See https://github.com/meta/docusaurus/issues/10944
run: npm run build -- --locale en --locale fr
env:
# Our website should build even with limited memory
# See https://github.com/facebook/docusaurus/pull/10590
# See https://github.com/meta/docusaurus/pull/10590
NODE_OPTIONS: '--max-old-space-size=200'
DOCUSAURUS_PERF_LOGGER: 'true'
working-directory: ../test-website
Expand Down Expand Up @@ -314,11 +314,11 @@ jobs:
E2E_TEST: true
- name: Build test-website project
# We build 2 locales to ensure a localized site doesn't leak memory
# See https://github.com/facebook/docusaurus/issues/10944
# See https://github.com/meta/docusaurus/issues/10944
run: pnpm run build --locale en --locale fr
env:
# Our website should build even with limited memory
# See https://github.com/facebook/docusaurus/pull/10590
# See https://github.com/meta/docusaurus/pull/10590
NODE_OPTIONS: '--max-old-space-size=200'
DOCUSAURUS_PERF_LOGGER: 'true'
working-directory: ../test-website
8 changes: 4 additions & 4 deletions .github/workflows/tests-windows.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ jobs:
- name: Docusaurus Tests
run: pnpm test
- name: Create a deep path
# https://github.com/facebook/docusaurus/pull/4899
# https://github.com/facebook/docusaurus/issues/5793
# https://github.com/meta/docusaurus/pull/4899
# https://github.com/meta/docusaurus/issues/5793
run: |
mkdir -p "website/_dogfooding/_pages tests/deep-file-path-test/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar/foo/bar"
cd "$_"
Expand All @@ -67,7 +67,7 @@ jobs:
DOCUSAURUS_PERF_LOGGER: 'true'

- name: TypeCheck website
# see https://github.com/facebook/docusaurus/pull/10486
# see https://github.com/meta/docusaurus/pull/10486
run: pnpm --filter website typecheck

# The TypeScript compiler of the tested version runs with pnpm dlx,
Expand All @@ -79,7 +79,7 @@ jobs:

- name: TypeCheck website - max version - Latest
# For latest TS there are often lib check errors, so we disable it
# Details: https://github.com/facebook/docusaurus/pull/10486
# Details: https://github.com/meta/docusaurus/pull/10486
run: |
pnpm dlx --package=typescript@latest tsc --version
pnpm dlx --package=typescript@latest tsc --project website/tsconfig.skipLibCheck.json
8 changes: 4 additions & 4 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,18 +53,18 @@ jobs:
run: pnpm --filter @docusaurus/theme-common removeThemeInternalReexport
- name: Docusaurus Build
# We build 2 locales to ensure a localized site doesn't leak memory
# See https://github.com/facebook/docusaurus/issues/10944
# See https://github.com/meta/docusaurus/issues/10944
run: pnpm build:website:fast --locale en --locale fr
env:
# Our website should build even with limited memory
# See https://github.com/facebook/docusaurus/pull/10590
# See https://github.com/meta/docusaurus/pull/10590
NODE_OPTIONS: "--max-old-space-size=${{ matrix.node == '24.21' && 350 || 300 }}"
DOCUSAURUS_PERF_LOGGER: 'true'
- name: Docusaurus site CSS order
run: pnpm --filter website test:css-order

- name: TypeCheck website
# see https://github.com/facebook/docusaurus/pull/10486
# see https://github.com/meta/docusaurus/pull/10486
run: pnpm --filter website typecheck

# The TypeScript compiler of the tested version runs with pnpm dlx,
Expand All @@ -76,7 +76,7 @@ jobs:

- name: TypeCheck website - max version - Latest
# For latest TS there are often lib check errors, so we disable it
# Details: https://github.com/facebook/docusaurus/pull/10486
# Details: https://github.com/meta/docusaurus/pull/10486
run: |
pnpm dlx --package=typescript@latest tsc --version
pnpm dlx --package=typescript@latest tsc --project website/tsconfig.skipLibCheck.json
Loading
Loading