Skip to content

[Docs] [POC] Experiment with trying to set up a combined Redux docs site #4792

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "website/react-redux"]
path = website/react-redux
url = https://github.com/reduxjs/react-redux.git
17 changes: 16 additions & 1 deletion website/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ const config: Config = {
src: 'img/redux.svg'
},
items: [
{
label: 'React Redux',
to: '/react-redux/introduction/getting-started',
position: 'left'
},
{
label: 'Getting Started',
to: 'introduction/getting-started',
Expand Down Expand Up @@ -159,7 +164,7 @@ const config: Config = {
href: 'https://redux.js.org/'
},
copyright: `Copyright © 2015–${new Date().getFullYear()} Dan Abramov and the Redux documentation authors.`
},
}
// algolia: {
// appId: 'YUQHC5OCW0',
// apiKey: 'ef8f3e604a1e7ed3afa4dbaeeecfa5f2',
Expand Down Expand Up @@ -221,6 +226,16 @@ const config: Config = {
dataDoNotTrack: true,
dataCache: true
} satisfies UmamiOptions
],
[
'@docusaurus/plugin-content-docs',
{
id: 'react-redux',
path: 'react-redux/docs',
routeBasePath: 'react-redux',
sidebarPath: './react-redux.sidebars.ts',
include: ['{api,introduction,using-react-redux,tutorials}/*.{md,mdx}']
}
]
]
}
Expand Down
1 change: 1 addition & 0 deletions website/react-redux
Submodule react-redux added at a8d654
17 changes: 17 additions & 0 deletions website/react-redux.sidebars.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'

const sidebars: SidebarsConfig = {
docs: [
{
type: 'category',
label: 'Introduction',
collapsed: false,
items: [
'introduction/getting-started',
'introduction/why-use-react-redux'
]
}
]
}

export default sidebars