Skip to content
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

Add getting started guide for Web/React UI and migrate React UI examples #17

Merged
merged 4 commits into from
Mar 19, 2024
Merged
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
4 changes: 2 additions & 2 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ const config: Config = {
v4: {
label: fs.readFileSync(path.join(__dirname, 'theoplayer_versioned_docs/version-v4/version.txt'), 'utf8').trim(),
banner: 'unmaintained',
noIndex: true
noIndex: true,
},
},
} satisfies DocsPlugin.Options,
Expand Down Expand Up @@ -299,7 +299,7 @@ const config: Config = {
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
additionalLanguages: ['java', 'groovy', 'objectivec', 'brightscript'],
additionalLanguages: ['java', 'groovy', 'objectivec', 'brightscript', 'bash'],
},
} satisfies Preset.ThemeConfig,
};
Expand Down
2 changes: 2 additions & 0 deletions open-video-ui/android/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
description: Start building your UI in just a few minutes!
sidebar_position: 1
sidebar_custom_props: { 'icon': '🚀' }
---

# Getting started
Expand Down
2 changes: 1 addition & 1 deletion open-video-ui/external/web-ui
9 changes: 0 additions & 9 deletions open-video-ui/react/getting-started.mdx

This file was deleted.

9 changes: 0 additions & 9 deletions open-video-ui/web/getting-started.mdx

This file was deleted.

42 changes: 40 additions & 2 deletions sidebarsOpenVideoUI.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,35 @@ const sidebars: SidebarsConfig = {
title: 'Open Video UI for Web',
},
items: [
{ type: 'doc', id: 'web/getting-started' },
{ type: 'doc', id: 'external/web-ui/docs/getting-started' },
{
type: 'category',
label: 'How-to guides',
description: 'Learn how to integrate our rich set of features into your own UI.',
customProps: {
icon: '📖',
},
link: { type: 'generated-index', slug: 'web/guides' },
items: [{ type: 'autogenerated', dirName: 'external/web-ui/docs/guides' }],
},
{
type: 'category',
label: 'Examples',
description: 'Find inspiration for your UI from our live demos!',
customProps: {
icon: '🛝',
},
link: { type: 'generated-index', slug: 'web/examples' },
items: [{ type: 'autogenerated', dirName: 'external/web-ui/docs/examples' }],
},
{ type: 'doc', id: 'external/web-ui/CHANGELOG' },
{
type: 'link',
label: 'API reference',
description: 'Discover all components provided by Open Video UI for Web.',
customProps: {
icon: '*️⃣',
},
href: 'https://theoplayer.github.io/web-ui/api/',
},
],
Expand All @@ -60,19 +72,37 @@ const sidebars: SidebarsConfig = {
title: 'Open Video UI for React',
},
items: [
{ type: 'doc', id: 'react/getting-started' },
{ type: 'doc', id: 'external/web-ui/docs/react/getting-started' },
{
type: 'category',
label: 'How-to guides',
description: 'Learn how to integrate our rich set of features into your own UI.',
customProps: {
icon: '📖',
},
link: { type: 'generated-index', slug: 'react/guides' },
items: [
// { type: 'autogenerated', dirName: 'external/web-ui/docs/guides' }
],
},
{
type: 'category',
label: 'Examples',
description: 'Find inspiration for your UI from our live demos!',
customProps: {
icon: '🛝',
},
link: { type: 'generated-index', slug: 'react/examples' },
items: [{ type: 'autogenerated', dirName: 'external/web-ui/docs/react/examples' }],
},
{ type: 'doc', id: 'external/web-ui/react/CHANGELOG' },
{
type: 'link',
label: 'API reference',
description: 'Discover all components and hooks provided by Open Video UI for React.',
customProps: {
icon: '*️⃣',
},
href: 'https://theoplayer.github.io/web-ui/react-api/',
},
],
Expand All @@ -94,13 +124,21 @@ const sidebars: SidebarsConfig = {
{
type: 'category',
label: 'How-to guides',
description: 'Learn how to integrate our rich set of features into your own UI.',
customProps: {
icon: '📖',
},
link: { type: 'generated-index', slug: 'android/guides' },
items: [{ type: 'autogenerated', dirName: 'external/android-ui/docs/guides' }],
},
{ type: 'doc', id: 'external/android-ui/CHANGELOG' },
{
type: 'link',
label: 'API reference',
description: 'Discover all components provided by Open Video UI for Android.',
customProps: {
icon: '*️⃣',
},
href: 'https://theoplayer.github.io/android-ui/api/',
},
],
Expand Down