138 lines
3.8 KiB
TypeScript
138 lines
3.8 KiB
TypeScript
import {themes as prismThemes} from 'prism-react-renderer';
|
|
import type {Config} from '@docusaurus/types';
|
|
import type * as Preset from '@docusaurus/preset-classic';
|
|
|
|
const config: Config = {
|
|
title: 'Oreon Docs',
|
|
tagline: 'The official documentation for Oreon',
|
|
favicon: 'img/favicon.ico',
|
|
|
|
// Set the production url of your site here
|
|
url: 'https://docs.oreonproject.com',
|
|
// Set the /<baseUrl>/ pathname under which your site is served
|
|
// For GitHub pages deployment, it is often '/<projectName>/'
|
|
baseUrl: '/',
|
|
|
|
// GitHub pages deployment config.
|
|
// If you aren't using GitHub pages, you don't need these.
|
|
organizationName: 'oreonproject', // Usually your GitHub org/user name.
|
|
projectName: 'docs', // Usually your repo name.
|
|
|
|
onBrokenLinks: 'throw',
|
|
onBrokenMarkdownLinks: 'throw',
|
|
|
|
// Even if you don't use internationalization, 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',
|
|
{
|
|
docs: {
|
|
sidebarPath: './sidebars.ts',
|
|
// Please change this to your repo.
|
|
// Remove this to remove the "edit this page" links.
|
|
},
|
|
// blog: {
|
|
// showReadingTime: true,
|
|
// feedOptions: {
|
|
// type: ['rss', 'atom'],
|
|
// xslt: true,
|
|
// },
|
|
// // Please change this to your repo.
|
|
// // Remove this to remove the "edit this page" links.
|
|
// editUrl:
|
|
// 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
|
|
// // Useful options to enforce blogging best practices
|
|
// onInlineTags: 'warn',
|
|
// onInlineAuthors: 'warn',
|
|
// onUntruncatedBlogPosts: 'warn',
|
|
// },
|
|
theme: {
|
|
customCss: './src/css/custom.css',
|
|
},
|
|
} satisfies Preset.Options,
|
|
],
|
|
],
|
|
|
|
themeConfig: {
|
|
// Replace with your project's social card
|
|
image: 'img/oreon-banner.png',
|
|
navbar: {
|
|
title: 'Oreon Docs',
|
|
logo: {
|
|
alt: 'Oreon Logo',
|
|
src: 'img/oreonlogo.png',
|
|
},
|
|
items: [
|
|
{
|
|
type: 'docSidebar',
|
|
sidebarId: 'tutorialSidebar',
|
|
position: 'left',
|
|
label: 'Docs',
|
|
},
|
|
{
|
|
href: 'https://git.oreonproject.org/oreonproject/docs',
|
|
label: 'Git Repository',
|
|
position: 'right',
|
|
},
|
|
],
|
|
},
|
|
footer: {
|
|
style: 'dark',
|
|
links: [
|
|
{
|
|
title: 'Docs',
|
|
items: [
|
|
{
|
|
label: 'Main Docs',
|
|
to: '/docs/intro',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'Community',
|
|
items: [
|
|
{
|
|
label: 'Discord',
|
|
href: 'https://discordapp.com/invite/docusaurus',
|
|
},
|
|
{
|
|
label: 'Website',
|
|
href: 'https://oreonproject.org/',
|
|
},
|
|
{
|
|
label: 'Forums',
|
|
href: 'https://forums.oreonproject.org/',
|
|
},
|
|
{
|
|
label: 'Project repositories',
|
|
href: 'https://git.oreonproject.org/',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'More',
|
|
items: [
|
|
{
|
|
label: 'Git repository',
|
|
href: 'https://git.oreonproject.org/oreonproject/docs',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
copyright: `Copyright © ${new Date().getFullYear()} The Oreon Foundation. Built with Docusaurus.`,
|
|
},
|
|
prism: {
|
|
theme: prismThemes.github,
|
|
darkTheme: prismThemes.dracula,
|
|
},
|
|
} satisfies Preset.ThemeConfig,
|
|
};
|
|
|
|
export default config;
|