Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork9.6k
feat: add support for browser-based theme config file (docusaurus.theme.js)#9619
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Draft
OzakIOne wants to merge13 commits intofacebook:mainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+610 −443
Draft
Changes from1 commit
Commits
Show all changes
13 commits Select commitHold shift + click to select a range
1659b95 create branch
OzakIOne4f70bf3 add themeConfig.tsx test file
slorber9bc8675 POC of browser themeConfig file
slorbere241354 retrocompatible read of conventional theme config
slorber4924cd7 lint
slorber60a04cf typo
slorber7ee136c warn when no theme config found
slorberebcec4b spell typo
slorber38737e2 wip: theme config
OzakIOnefe7916b wip: navbar
OzakIOne9e8768c wip: satisfies as causes build error
OzakIOne67056e9 wip: move old theme config to new
OzakIOne161c727 wip: update examples with theme config
OzakIOneFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
wip: navbar
- Loading branch information
Uh oh!
There was an error while loading.Please reload this page.
commitfe7916bce33fba6e9cc4c1a9df2b9646d400e79b
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -8,14 +8,24 @@ import type {ReactNode} from 'react'; | ||
| import React from 'react'; | ||
| import Link from '@docusaurus/Link'; | ||
| import Translate from '@docusaurus/Translate'; | ||
| import VersionsArchived from './versionsArchived.json'; | ||
| import PrismLight from './src/utils/prismLight'; | ||
| import PrismDark from './src/utils/prismDark'; | ||
| import type * as Preset from '@docusaurus/preset-classic'; | ||
| // TODO remove this eslint ruse | ||
| // TODO PrismDark and PrismLight types | ||
| // TODO `satisfies Preset.ThemeConfig` `satisfies Config` | ||
| // results Expected ';', got 'satisfies' | ||
| /* eslint-disable @docusaurus/no-untranslated-text */ | ||
| const ArchivedVersionsDropdownItems = Object.entries(VersionsArchived).splice( | ||
| 0, | ||
| 5, | ||
| ); | ||
| const isDev = process.env.NODE_ENV === 'development'; | ||
| export default { | ||
| announcementBar: { | ||
ContributorAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. process is not defined for agolia however no error reported for navbar Debug label with isDev | ||
| id: 'announcementBar-3', // Increment on change | ||
| content: function AnnouncementBarContent(): ReactNode { | ||
| return ( | ||
| <b> | ||
| @@ -190,6 +200,110 @@ export default { | ||
| src: '/img/meta_opensource_logo_negative.svg', | ||
| href: 'https://opensource.fb.com', | ||
| }, | ||
| copyright: `Copyright © ${new Date().getFullYear()} Meta Platforms, Inc. Built with Docusaurus.`, | ||
| }, | ||
| navbar: { | ||
| hideOnScroll: true, | ||
| title: 'Docusaurus', | ||
| logo: { | ||
| alt: '', | ||
| src: 'img/docusaurus.svg', | ||
| srcDark: 'img/docusaurus_keytar.svg', | ||
| width: 32, | ||
| height: 32, | ||
| }, | ||
| items: [ | ||
| { | ||
| type: 'doc', | ||
| position: 'left', | ||
| docId: 'introduction', | ||
| label: 'Docs', | ||
| }, | ||
| { | ||
| type: 'docSidebar', | ||
| position: 'left', | ||
| sidebarId: 'api', | ||
| label: 'API', | ||
| }, | ||
| {to: 'blog', label: 'Blog', position: 'left'}, | ||
| {to: 'showcase', label: 'Showcase', position: 'left'}, | ||
| { | ||
| to: '/community/support', | ||
| label: 'Community', | ||
| position: 'left', | ||
| activeBaseRegex: `/community/`, | ||
| }, | ||
| // This item links to a draft doc: only displayed in dev | ||
| { | ||
| type: 'doc', | ||
| docId: 'index', | ||
| label: 'Tests', | ||
| docsPluginId: 'docs-tests', | ||
| }, | ||
| isDev && {to: '/__docusaurus/debug', label: 'Debug'}, | ||
| // Custom item for dogfooding: only displayed in /tests/ routes | ||
| { | ||
| type: 'custom-dogfood-navbar-item', | ||
| content: '😉', | ||
| }, | ||
| // Right | ||
| { | ||
| type: 'docsVersionDropdown', | ||
| position: 'right', | ||
| dropdownActiveClassDisabled: true, | ||
| dropdownItemsAfter: [ | ||
| { | ||
| type: 'html', | ||
| value: '<hr class="dropdown-separator">', | ||
| }, | ||
| { | ||
| type: 'html', | ||
| className: 'dropdown-archived-versions', | ||
| value: '<b>Archived versions</b>', | ||
| }, | ||
| ...ArchivedVersionsDropdownItems.map(([versionName, versionUrl]) => ({ | ||
| label: versionName, | ||
| href: versionUrl, | ||
| })), | ||
| { | ||
| href: 'https://v1.docusaurus.io', | ||
| label: '1.x.x', | ||
| }, | ||
| { | ||
| type: 'html', | ||
| value: '<hr class="dropdown-separator">', | ||
| }, | ||
| { | ||
| to: '/versions', | ||
| label: 'All versions', | ||
| }, | ||
| ], | ||
| dropdownItemsBefore: [], | ||
| }, | ||
| { | ||
| type: 'localeDropdown', | ||
| position: 'right', | ||
| dropdownItemsAfter: [ | ||
| { | ||
| type: 'html', | ||
| value: '<hr style="margin: 0.3rem 0;">', | ||
| }, | ||
| { | ||
| href: 'https://github.com/facebook/docusaurus/issues/3526', | ||
| label: 'Help Us Translate', | ||
| }, | ||
| ], | ||
| dropdownItemsBefore: [], | ||
| }, | ||
| { | ||
| href: 'https://github.com/facebook/docusaurus', | ||
| position: 'right', | ||
| className: 'header-github-link', | ||
| 'aria-label': 'GitHub repository', | ||
| }, | ||
| ] | ||
| // TODO fix type | ||
| .filter(Boolean) as NonNullable<Preset.ThemeConfig['navbar']>['items'], | ||
| }, | ||
| }; | ||
| // satisfies Preset.ThemeConfig; | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.