docs: add social card and logo and update config

This commit is contained in:
moonrailgun 2023-11-04 16:58:44 +08:00
parent 517268e652
commit 107d8c5e81
4 changed files with 56 additions and 48 deletions

View File

@ -6,20 +6,20 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
/** @type {import('@docusaurus/types').Config} */ /** @type {import('@docusaurus/types').Config} */
const config = { const config = {
title: 'My Site', title: 'Tianji',
tagline: 'Dinosaurs are cool', tagline: 'Insight into everything',
favicon: 'img/favicon.ico', favicon: 'img/favicon.ico',
// Set the production url of your site here // Set the production url of your site here
url: 'https://your-docusaurus-test-site.com', url: 'https://tianji.msgbyte.com',
// Set the /<baseUrl>/ pathname under which your site is served // Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/' // For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/', baseUrl: '/',
// GitHub pages deployment config. // GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these. // If you aren't using GitHub pages, you don't need these.
organizationName: 'facebook', // Usually your GitHub org/user name. organizationName: 'msgbyte', // Usually your GitHub org/user name.
projectName: 'docusaurus', // Usually your repo name. projectName: 'tianji', // Usually your repo name.
onBrokenLinks: 'throw', onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn', onBrokenMarkdownLinks: 'warn',
@ -45,7 +45,7 @@ const config = {
sidebarPath: require.resolve("./sidebars.js"), sidebarPath: require.resolve("./sidebars.js"),
routeBasePath: "/", routeBasePath: "/",
editUrl: editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', 'https://github.com/msgbyte/tianji/tree/main/website/',
}, },
theme: { theme: {
customCss: require.resolve("./src/css/custom.css"), customCss: require.resolve("./src/css/custom.css"),
@ -58,23 +58,23 @@ const config = {
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */ /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({ ({
// Replace with your project's social card // Replace with your project's social card
image: 'img/docusaurus-social-card.jpg', image: 'img/social-card.jpg',
navbar: { navbar: {
title: 'My Site', title: 'Tianji',
logo: { logo: {
alt: 'My Site Logo', alt: 'Tianji Logo',
src: 'img/logo.svg', src: 'img/logo.svg',
}, },
items: [ items: [
{ // {
type: 'docSidebar', // type: 'docSidebar',
sidebarId: 'tutorialSidebar', // sidebarId: 'tutorialSidebar',
position: 'left', // position: 'left',
label: 'Tutorial', // label: 'Tutorial',
}, // },
{ to: '/api', label: 'API', position: 'left' }, { to: '/api', label: 'API', position: 'left' },
{ {
href: 'https://github.com/facebook/docusaurus', href: 'https://github.com/msgbyte/tianji',
label: 'GitHub', label: 'GitHub',
position: 'right', position: 'right',
}, },
@ -83,47 +83,47 @@ const config = {
footer: { footer: {
style: 'dark', style: 'dark',
links: [ links: [
{ // {
title: 'Docs', // title: 'Docs',
items: [ // items: [
{ // {
label: 'Tutorial', // label: 'Tutorial',
to: '/docs/intro', // to: '/docs/intro',
}, // },
], // ],
}, // },
{ // {
title: 'Community', // title: 'Community',
items: [ // items: [
{ // {
label: 'Stack Overflow', // label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/docusaurus', // href: 'https://stackoverflow.com/questions/tagged/docusaurus',
}, // },
{ // {
label: 'Discord', // label: 'Discord',
href: 'https://discordapp.com/invite/docusaurus', // href: 'https://discordapp.com/invite/docusaurus',
}, // },
{ // {
label: 'Twitter', // label: 'Twitter',
href: 'https://twitter.com/docusaurus', // href: 'https://twitter.com/docusaurus',
}, // },
], // ],
}, // },
{ {
title: 'More', title: 'More',
items: [ items: [
{ {
label: 'Blog', label: 'API',
to: '/blog', to: '/api',
}, },
{ {
label: 'GitHub', label: 'GitHub',
href: 'https://github.com/facebook/docusaurus', href: 'https://github.com/msgbyte/tianji',
}, },
], ],
}, },
], ],
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`, copyright: `Copyright © ${new Date().getFullYear()} Tianji, Inc. Built with Msgbyte.`,
}, },
prism: { prism: {
theme: lightCodeTheme, theme: lightCodeTheme,

View File

@ -4,7 +4,7 @@
"private": true, "private": true,
"scripts": { "scripts": {
"docusaurus": "docusaurus", "docusaurus": "docusaurus",
"start": "docusaurus start", "dev": "docusaurus start",
"build": "docusaurus build", "build": "docusaurus build",
"swizzle": "docusaurus swizzle", "swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy", "deploy": "docusaurus deploy",

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 6.3 KiB

After

Width:  |  Height:  |  Size: 2.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 379 KiB