bigbluebutton-Github/docs/docusaurus.config.js

188 lines
7.1 KiB
JavaScript
Raw Normal View History

// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
2023-12-07 03:24:19 +08:00
const lightCodeTheme = require('prism-react-renderer').themes.github;
const darkCodeTheme = require('prism-react-renderer').themes.dracula;
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'BigBlueButton',
tagline: 'Official Documentation',
2023-03-22 22:39:40 +08:00
url: 'https://docs.bigbluebutton.org/',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'bigbluebutton', // Usually your GitHub org/user name.
projectName: 'bigbluebutton', // Usually your repo name.
// Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans".
i18n: {
defaultLocale: 'en',
locales: ['en'],
},
presets: [
[
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
routeBasePath: "/",
sidebarPath: require.resolve('./sidebars.js'),
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
}),
],
],
themeConfig:
2023-01-13 04:46:18 +08:00
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
2023-01-13 04:46:18 +08:00
tableOfContents: {
minHeadingLevel: 2,
maxHeadingLevel: 4,
},
navbar: {
title: 'BigBlueButton',
logo: {
alt: 'BigBlueButton Logo',
src: 'img/logo.svg',
},
items: [
{to: 'https://bigbluebutton.org/teachers/tutorials/', label: 'Teaching', position: 'left'},
{to: '/development/guide', label: 'Development', position: 'left'},
{to: '/administration/install', label: 'Administration', position: 'left'},
{to: '/greenlight/v3/install', label: 'Greenlight', position: 'left'},
{to: '/new-features', label: 'New Features', position: 'left'},
2024-06-25 00:56:08 +08:00
// {to: '/plugins', label: 'Plugins', position: 'left'},
{to: '/support/getting-help', label: 'Support', position: 'left'},
{
type: 'docsVersionDropdown',
position: 'right',
dropdownActiveClassDisabled: true,
},
{
2024-05-11 04:04:26 +08:00
href: 'https://github.com/bigbluebutton/bigbluebutton/tree/v3.0.x-release/docs',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'BigBlueButton',
items: [
{
label: 'Github',
href: 'https://github.com/bigbluebutton',
},
],
},
{
title: 'Community',
items: [
{
label: 'Setup Forums',
href: 'https://groups.google.com/forum/#!forum/bigbluebutton-setup',
},
{
label: 'Users Forums',
href: 'https://groups.google.com/forum/#!forum/bigbluebutton-users',
},
{
label: 'Developers Forums',
href: 'https://groups.google.com/forum/#!forum/bigbluebutton-dev',
},
],
},
{
title: 'Support',
2023-01-13 04:46:18 +08:00
items: [
{
label: 'Road Map',
to: '/support/road-map',
},
{
label: 'FAQ',
to: '/support/faq',
},
{
label: 'Getting help',
to: '/support/getting-help',
},
{
label: 'Troubleshooting',
to: '/support/troubleshooting',
},
],
},
{
title: 'Resources',
items: [
{
label: 'Knowledge Base',
2023-01-13 04:46:18 +08:00
href: 'https://support.bigbluebutton.org/',
},
{
label: 'Tutorial Videos',
2023-01-13 04:46:18 +08:00
href: 'https://bigbluebutton.org/teachers/tutorials/',
},
],
},
{
title: 'Social',
items: [
{
label: 'Facebook',
href: 'https://www.facebook.com/bigbluebutton',
},
{
label: 'Twitter',
href: 'https://twitter.com/bigbluebutton',
},
{
label: 'Youtube',
href: 'https://www.youtube.com/channel/UCYj1_2Q3HTWCAImvI6eZ0SA',
},
],
},
],
2023-03-17 03:18:27 +08:00
copyright: `Copyright © ${new Date().getFullYear()} BigBlueButton Inc., Built with Docusaurus.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),
2024-05-09 22:57:35 +08:00
themes: [
// ... Your other themes.
[
require.resolve("@easyops-cn/docusaurus-search-local"),
/** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
({
// ... Your options.
// `hashed` is recommended as long-term-cache of index file is possible.
hashed: true,
docsRouteBasePath: "/",
// For Docs using Chinese, The `language` is recommended to set to:
// ```
// language: ["en", "zh"],
// ```
}),
],
],
};
module.exports = config;