Skip to content

Commit 50591e0

Browse files
committed
chore(docs): tidy Docusaurus config
1 parent 9273512 commit 50591e0

1 file changed

Lines changed: 5 additions & 20 deletions

File tree

packages/docs/docusaurus.config.js

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,24 @@
11
// @ts-check
22
// `@type` JSDoc annotations allow editor autocompletion and type checking
33
// (when paired with `@ts-check`).
4-
// There are various equivalent ways to declare your Docusaurus config.
5-
// See: https://docusaurus.io/docs/api/docusaurus-config
64

75
import { themes as prismThemes } from 'prism-react-renderer';
86

9-
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
10-
117
/** @type {import('@docusaurus/types').Config} */
128
const config = {
139
title: 'Blockly Docs',
1410
favicon: 'img/logo.svg',
1511

16-
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
1712
future: {
18-
v4: true, // Improve compatibility with the upcoming Docusaurus v4
13+
v4: true,
1914
},
2015

21-
// Set the production url of your site here
2216
url: 'https://raspberrypifoundation.github.io',
23-
// Set the /<baseUrl>/ pathname under which your site is served
24-
// For GitHub pages deployment, it is often '/<projectName>/'
2517
baseUrl: '/docs/',
2618

27-
// GitHub pages deployment config.
28-
// If you aren't using GitHub pages, you don't need these.
29-
organizationName: 'RaspberryPiFoundation', // Usually your GitHub org/user name.
30-
projectName: 'blockly', // Usually your repo name.
19+
// GitHub pages deployment config
20+
organizationName: 'RaspberryPiFoundation',
21+
projectName: 'blockly',
3122

3223
onBrokenLinks: 'warn',
3324
//onBrokenMarkdownLinks: 'warn',
@@ -39,9 +30,6 @@ const config = {
3930
},
4031
},
4132

42-
// Even if you don't use internationalization, you can use this field to set
43-
// useful metadata like html lang. For example, if your site is Chinese, you
44-
// may want to replace "en" with "zh-Hans".
4533
i18n: {
4634
defaultLocale: 'en',
4735
locales: ['en'],
@@ -65,16 +53,14 @@ const config = {
6553
routeBasePath: '/',
6654
sidebarPath: './sidebars.js',
6755
showLastUpdateTime: true,
68-
// Please change this to your repo.
69-
// Remove this to remove the "edit this page" links.
7056
editUrl:
7157
'https://github.com/RaspberryPiFoundation/blockly/tree/main/packages/docs',
7258
},
7359
blog: false,
7460
theme: {
7561
customCss: './src/css/custom.css',
7662
},
77-
// Will be passed to @docusaurus/plugin-google-tag-manager (only enabled when explicitly specified)
63+
// Passed to @docusaurus/plugin-google-tag-manager
7864
googleTagManager: {
7965
containerId: 'GTM-NSSCB6XT',
8066
},
@@ -85,7 +71,6 @@ const config = {
8571
themeConfig:
8672
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
8773
({
88-
// Replace with your project's social card
8974
image: 'images/blockly_banner.png',
9075
navbar: {
9176
title: 'Blockly',

0 commit comments

Comments
 (0)