Le Hoang Nam
7dc995dcd9
- Created a new Docusaurus project for documentation. - Added configuration file `docusaurus.config.ts` for site settings and theme. - Established initial documentation structure with overview and GitFlow sections. - Included a `.gitignore` file to exclude unnecessary files and directories. - Added essential files such as `package.json`, `package-lock.json`, and initial CSS styles. - Removed outdated guides related to Gitea and Jenkins management.
95 lines
2.4 KiB
TypeScript
95 lines
2.4 KiB
TypeScript
import type * as Preset from '@docusaurus/preset-classic';
|
|
import type { Config } from '@docusaurus/types';
|
|
import { themes as prismThemes } from 'prism-react-renderer';
|
|
|
|
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
|
|
|
|
const config: Config = {
|
|
title: 'Development Workflow',
|
|
tagline: 'Documentation for Development Workflow',
|
|
favicon: 'img/favicon.ico',
|
|
|
|
// Set the production url of your site here
|
|
url: 'https://gitea.plp19.com/',
|
|
// Set the /<baseUrl>/ pathname under which your site is served
|
|
// For GitHub pages deployment, it is often '/<projectName>/'
|
|
baseUrl: '/doc-development-workflow/',
|
|
|
|
// GitHub pages deployment config.
|
|
// If you aren't using GitHub pages, you don't need these.
|
|
organizationName: 'dev-public',
|
|
projectName: 'doc-development-workflow',
|
|
|
|
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'],
|
|
},
|
|
|
|
presets: [
|
|
[
|
|
'classic',
|
|
{
|
|
docs: {
|
|
sidebarPath: './sidebars.ts',
|
|
routeBasePath: '/',
|
|
},
|
|
theme: {
|
|
customCss: './src/css/custom.css',
|
|
},
|
|
} satisfies Preset.Options,
|
|
],
|
|
],
|
|
|
|
markdown: {
|
|
mermaid: true,
|
|
},
|
|
|
|
themes: ['@docusaurus/theme-mermaid'],
|
|
|
|
themeConfig: {
|
|
// Replace with your project's social card
|
|
image: 'img/document-logo.png',
|
|
navbar: {
|
|
title: 'Home',
|
|
logo: {
|
|
alt: '',
|
|
src: 'img/document-logo.png',
|
|
},
|
|
items: [
|
|
{
|
|
type: 'doc',
|
|
position: 'left',
|
|
docId: '01-overview',
|
|
label: 'Docs',
|
|
},
|
|
{
|
|
type: 'html',
|
|
position: 'right',
|
|
value: `
|
|
<a href="https://gitea.plp19.com/dev-public/doc-development-workflow" target="_blank" rel="noopener" style="display: flex; align-items: center; gap: 4px;">
|
|
<img src="img/gitea-logo.svg" alt="Gitea" style="height: 35px; margin-right: 4px;" />
|
|
</a>
|
|
`,
|
|
},
|
|
],
|
|
},
|
|
footer: {
|
|
style: 'dark',
|
|
links: [],
|
|
copyright: `Copyright © ${new Date().getFullYear()} Game Department, Mercury Studio. Built with Docusaurus.`,
|
|
},
|
|
prism: {
|
|
theme: prismThemes.github,
|
|
darkTheme: prismThemes.dracula,
|
|
},
|
|
} satisfies Preset.ThemeConfig,
|
|
};
|
|
|
|
export default config;
|