add docs 结构

This commit is contained in:
xie7654
2025-07-05 23:18:24 +08:00
parent 2de86a86a6
commit 6a43b29c1f
26 changed files with 146 additions and 595 deletions

View File

@@ -5,8 +5,8 @@ import type * as Preset from '@docusaurus/preset-classic';
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
const config: Config = {
title: 'My Site',
tagline: 'Dinosaurs are cool',
title: 'django-vue3-admin',
tagline: 'Django5 + Vue3 企业级中后台管理系统支持多端多角色权限、自动化代码生成、Docker一键部署',
favicon: 'img/favicon.ico',
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
@@ -15,15 +15,15 @@ const config: Config = {
},
// Set the production url of your site here
url: 'https://your-docusaurus-site.example.com',
url: 'https://xie7654.github.io',
// 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: 'facebook', // Usually your GitHub org/user name.
projectName: 'docusaurus', // Usually your repo name.
organizationName: 'XIE7654', // GitHub 用户名
projectName: 'django-vue3-admin', // 仓库名
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
@@ -42,10 +42,8 @@ const config: Config = {
{
docs: {
sidebarPath: './sidebars.ts',
// 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/',
routeBasePath: '/',
editUrl: 'https://github.com/XIE7654/django-vue3-admin.git',
},
blog: {
showReadingTime: true,
@@ -53,11 +51,7 @@ const config: Config = {
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
editUrl: 'https://github.com/XIE7654/django-vue3-admin.git',
onInlineTags: 'warn',
onInlineAuthors: 'warn',
onUntruncatedBlogPosts: 'warn',
@@ -70,12 +64,11 @@ const config: Config = {
],
themeConfig: {
// Replace with your project's social card
image: 'img/docusaurus-social-card.jpg',
navbar: {
title: 'My Site',
title: 'django-vue3-admin',
logo: {
alt: 'My Site Logo',
alt: 'django-vue3-admin Logo',
src: 'img/logo.svg',
},
items: [
@@ -87,7 +80,7 @@ const config: Config = {
},
{to: '/blog', label: 'Blog', position: 'left'},
{
href: 'https://github.com/facebook/docusaurus',
href: 'https://github.com/XIE7654/django-vue3-admin.git',
label: 'GitHub',
position: 'right',
},
@@ -101,24 +94,7 @@ const config: Config = {
items: [
{
label: 'Tutorial',
to: '/docs/intro',
},
],
},
{
title: 'Community',
items: [
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
},
{
label: 'Discord',
href: 'https://discordapp.com/invite/docusaurus',
},
{
label: 'X',
href: 'https://x.com/docusaurus',
to: '/introduction',
},
],
},
@@ -131,12 +107,12 @@ const config: Config = {
},
{
label: 'GitHub',
href: 'https://github.com/facebook/docusaurus',
href: 'https://github.com/XIE7654/django-vue3-admin.git',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
copyright: `Copyright © ${new Date().getFullYear()} django-vue3-admin. Built with Docusaurus.`,
},
prism: {
theme: prismThemes.github,