mirror of
https://github.com/remnawave/panel.git
synced 2026-04-27 02:06:26 +00:00
Update documentation with detailed project overview and component descriptions
This commit is contained in:
@@ -7,24 +7,12 @@ const config: Config = {
|
||||
title: 'Remnawave Documentation',
|
||||
tagline: 'Remnawave Documentation',
|
||||
favicon: 'img/favicon.ico',
|
||||
|
||||
// Set the production url of your site here
|
||||
url: 'https://remna.st',
|
||||
// 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: 'remnawave', // Usually your GitHub org/user name.
|
||||
projectName: 'panel', // Usually your repo name.
|
||||
|
||||
organizationName: 'remnawave',
|
||||
projectName: 'panel',
|
||||
onBrokenLinks: 'throw',
|
||||
onBrokenMarkdownLinks: 'warn',
|
||||
|
||||
// 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']
|
||||
@@ -36,8 +24,6 @@ const config: Config = {
|
||||
{
|
||||
docs: {
|
||||
sidebarPath: './sidebars.ts',
|
||||
// Please change this to your repo.
|
||||
// Remove this to remove the "edit this page" links.
|
||||
routeBasePath: '/',
|
||||
editUrl: 'https://github.com/remnawave/panel/tree/main'
|
||||
},
|
||||
@@ -50,11 +36,13 @@ const config: Config = {
|
||||
],
|
||||
|
||||
themeConfig: {
|
||||
// Replace with your project's social card
|
||||
image: 'img/docusaurus-social-card.jpg',
|
||||
sidebar: {
|
||||
hideable: true,
|
||||
autoCollapseCategories: false
|
||||
// image: 'img/docusaurus-social-card.jpg',
|
||||
|
||||
docs: {
|
||||
sidebar: {
|
||||
hideable: true,
|
||||
autoCollapseCategories: false
|
||||
}
|
||||
},
|
||||
navbar: {
|
||||
title: 'Remnawave',
|
||||
@@ -95,6 +83,10 @@ const config: Config = {
|
||||
{
|
||||
label: 'Telegram',
|
||||
href: 'https://t.me/remnawave'
|
||||
},
|
||||
{
|
||||
label: 'Telegram Group',
|
||||
href: 'https://t.me/+cAFRGkqSWJcxNjE6'
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -117,7 +109,8 @@ const config: Config = {
|
||||
},
|
||||
|
||||
prism: {
|
||||
darkTheme: prismThemes.oneDark
|
||||
darkTheme: prismThemes.oneDark,
|
||||
additionalLanguages: ['bash']
|
||||
}
|
||||
} satisfies Preset.ThemeConfig
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user