canine-docs/docusaurus.config.js

131 lines
3.6 KiB
JavaScript
Raw Normal View History

2022-07-09 15:52:30 +00:00
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
/** @type {import('@docusaurus/types').Config} */
const config = {
2022-09-02 15:26:48 +00:00
title: 'Jackal Chain Docs',
2022-07-09 17:17:54 +00:00
tagline: 'The who, what, where, why, when, and how to get started with Jackal\'s blockchain!',
2023-04-27 15:14:11 +00:00
url: 'https://docs.jackalprotocol.com',
2022-07-09 15:52:30 +00:00
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
2022-07-09 17:17:54 +00:00
organizationName: 'jackallabs', // Usually your GitHub org/user name.
projectName: 'canine-docs', // Usually your repo name.
2022-09-14 21:31:29 +00:00
trailingSlash: false,
2022-07-09 15:52:30 +00:00
// Even if you don't use internalization, 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',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
2022-09-02 15:26:48 +00:00
'https://github.com/JackalLabs/canine-docs/blob/master/',
2022-07-09 15:52:30 +00:00
},
blog: {
showReadingTime: 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/',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
}),
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
navbar: {
2022-07-09 17:17:54 +00:00
title: 'Jackal Docs',
2022-07-09 15:52:30 +00:00
logo: {
2022-07-09 17:17:54 +00:00
alt: 'Jackal Logo',
2022-09-02 15:26:48 +00:00
src: 'img/jklimage.png',
2022-07-09 15:52:30 +00:00
},
items: [
{
2022-07-09 17:17:54 +00:00
href: 'https://github.com/jackallabs/canine-chain',
2022-07-09 15:52:30 +00:00
label: 'GitHub',
position: 'right',
},
],
},
footer: {
2022-09-02 15:26:48 +00:00
style: 'light',
2022-07-09 15:52:30 +00:00
links: [
{
2022-09-02 15:26:48 +00:00
title: 'Jackal',
2022-07-09 15:52:30 +00:00
items: [
{
2022-09-02 15:26:48 +00:00
label: 'Website',
2023-04-27 15:14:11 +00:00
href: 'https://jackalprotocol.com',
2022-07-09 15:52:30 +00:00
},
],
},
{
2022-07-09 17:17:54 +00:00
title: 'Connect With Us',
2022-07-09 15:52:30 +00:00
items: [
{
label: 'Discord',
2022-07-09 17:17:54 +00:00
href: 'https://discord.com/invite/5GKym3p6rj',
2022-07-09 15:52:30 +00:00
},
{
label: 'Twitter',
2022-09-02 17:21:53 +00:00
href: 'https://twitter.com/Jackal_Protocol',
2022-07-09 15:52:30 +00:00
},
],
},
{
2022-09-02 15:26:48 +00:00
title: 'Developers',
2022-07-09 15:52:30 +00:00
items: [
{
2022-09-02 15:26:48 +00:00
label: 'Documentation',
2023-04-27 15:14:11 +00:00
to: 'https://docs.jackalprotocol.com',
2022-07-09 15:52:30 +00:00
},
{
2022-07-09 17:17:54 +00:00
label: 'Contribute to Docs',
href: 'https://github.com/jackallabs/canine-docs',
2022-07-09 15:52:30 +00:00
},
],
},
],
2022-09-02 15:26:48 +00:00
copyright: `Copyright © ${new Date().getFullYear()} Jackal Labs`,
2022-07-09 15:52:30 +00:00
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),
2022-09-02 15:26:48 +00:00
stylesheets: [
{
href: 'https://fonts.googleapis.com/css2?family=Poppins:wght@700&display=swap',
},
{
2022-09-02 15:28:46 +00:00
href: 'https://fonts.cdnfonts.com/css/segoe-ui-4'
2022-09-02 15:26:48 +00:00
},
]
2022-07-09 15:52:30 +00:00
};
module.exports = config;