mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-01 19:27:48 +02:00
09550b0535
* fix: makes types DocusaurusConfig optional to match docs * add UserDocusaurusConfig with required keys for user config * convert UserDocusaurusConfig to use util type * Docusaurus website config should be type-checked by CI + fix all existing issues * add doc for config typechecking * Update template configs for TS autocompletion * fix last config typechecking bugs * reapply prettier * reapply prettier-docs * Fix TS doc: add missing () * fix some docu plugin types * add "const config" for simpler jsdoc annotation Co-authored-by: slorber <lorber.sebastien@gmail.com>
93 lines
2.3 KiB
JavaScript
93 lines
2.3 KiB
JavaScript
// @ts-check
|
|
// Note: type annotations allow type checking and IDEs autocompletion
|
|
|
|
/** @type {import('@docusaurus/types').Config} */
|
|
const config = {
|
|
title: 'My Site',
|
|
tagline: 'The tagline of my site',
|
|
url: 'https://your-docusaurus-test-site.com',
|
|
baseUrl: '/',
|
|
onBrokenLinks: 'throw',
|
|
onBrokenMarkdownLinks: 'warn',
|
|
favicon: 'img/favicon.ico',
|
|
organizationName: 'facebook', // Usually your GitHub org/user name.
|
|
projectName: 'docusaurus', // Usually your repo name.
|
|
themeConfig: {
|
|
navbar: {
|
|
title: 'My Site',
|
|
logo: {
|
|
alt: 'My Site Logo',
|
|
src: 'img/logo.svg',
|
|
},
|
|
items: [
|
|
{
|
|
to: 'docs/intro',
|
|
activeBasePath: 'docs',
|
|
label: 'Docs',
|
|
position: 'left',
|
|
},
|
|
{to: 'blog', label: 'Blog', position: 'left'},
|
|
{
|
|
href: 'https://github.com/facebook/docusaurus',
|
|
label: 'GitHub',
|
|
position: 'right',
|
|
},
|
|
],
|
|
},
|
|
footer: {
|
|
style: 'dark',
|
|
links: [
|
|
{
|
|
title: 'Community',
|
|
items: [
|
|
{
|
|
label: 'Stack Overflow',
|
|
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
|
|
},
|
|
{
|
|
label: 'Discord',
|
|
href: 'https://discordapp.com/invite/docusaurus',
|
|
},
|
|
{
|
|
label: 'Twitter',
|
|
href: 'https://twitter.com/docusaurus',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'More',
|
|
items: [
|
|
{
|
|
label: 'Blog',
|
|
to: 'blog/',
|
|
},
|
|
{
|
|
label: 'GitHub',
|
|
href: 'https://github.com/facebook/docusaurus',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
|
|
},
|
|
},
|
|
presets: [
|
|
[
|
|
'@docusaurus/preset-bootstrap',
|
|
{
|
|
docs: {
|
|
sidebarPath: require.resolve('./sidebars.js'),
|
|
editUrl: 'https://github.com/facebook/docusaurus/edit/main/website/',
|
|
},
|
|
blog: {
|
|
showReadingTime: true,
|
|
// Please change this to your repo.
|
|
editUrl:
|
|
'https://github.com/facebook/docusaurus/edit/main/website/blog/',
|
|
},
|
|
},
|
|
],
|
|
],
|
|
};
|
|
|
|
module.exports = config;
|