diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 08ba07b..9bd2ba8 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -4,167 +4,179 @@ // There are various equivalent ways to declare your Docusaurus config. // See: https://docusaurus.io/docs/api/docusaurus-config -import { themes as prismThemes } from 'prism-react-renderer'; +import { themes as prismThemes } from "prism-react-renderer"; // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) /** @type {import('@docusaurus/types').Config} */ const config = { - title: 'AboutCode.org', - tagline: '[Tagline . . . ?]', - favicon: 'img/nexB_icon.png', - - markdown: { - format: 'detect', // Auto-detects: .md = plain Markdown (CommonMark), .mdx = MDX - }, - - // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future - future: { - v4: true, // Improve compatibility with the upcoming Docusaurus v4 - }, - - // // Set the production url of your site here - // url: 'https://your-docusaurus-site.example.com', - // // Set the // pathname under which your site is served - // // For GitHub pages deployment, it is often '//' - // baseUrl: '/', - - // // GitHub pages deployment config. - // // If you aren't using GitHub pages, you don't need these. - // organizationName: 'facebook', // Usually your GitHub org/user name. - // projectName: 'docusaurus', // Usually your repo name. - - url: 'https://aboutcode-org.github.io', - baseUrl: '/www.aboutcode.org/', - trailingSlash: false, - - // For GitHub pages deployment: - organizationName: 'aboutcode-org', - projectName: 'www.aboutcode.org', - - 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', - /** @type {import('@docusaurus/preset-classic').Options} */ - ({ - docs: { - sidebarPath: './sidebars.js', - // 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/', - editUrl: ({ docPath }) => { - // TODO We can include a map here as in packageurl.org. - // Otherwise, provide a default (so “Edit this page” still works) - return `https://github.com/aboutcode-org/www.aboutcode.org/blob/main/website/docs/${docPath}`; - // fork: - // return `https://github.com/johnmhoran/www.aboutcode.org/blob/main/website/docs/${docPath}`; - }, - }, - blog: { - showReadingTime: true, - blogSidebarTitle: 'All posts', - blogSidebarCount: 'ALL', - blogTitle: 'AboutCode blog!', - }, - - theme: { - customCss: './src/css/custom.css', - }, - }), - ], + title: "AboutCode.org", + tagline: "[Tagline . . . ?]", + favicon: "img/nexB_icon.png", + + markdown: { + format: "detect", // Auto-detects: .md = plain Markdown (CommonMark), .mdx = MDX + }, + + // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future + future: { + v4: true, // Improve compatibility with the upcoming Docusaurus v4 + }, + + // // Set the production url of your site here + // url: 'https://your-docusaurus-site.example.com', + // // Set the // pathname under which your site is served + // // For GitHub pages deployment, it is often '//' + // baseUrl: '/', + + // // GitHub pages deployment config. + // // If you aren't using GitHub pages, you don't need these. + // organizationName: 'facebook', // Usually your GitHub org/user name. + // projectName: 'docusaurus', // Usually your repo name. + + url: "https://aboutcode-org.github.io", + baseUrl: "/www.aboutcode.org/", + trailingSlash: false, + + // For GitHub pages deployment: + organizationName: "aboutcode-org", + projectName: "www.aboutcode.org", + + 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", + /** @type {import('@docusaurus/preset-classic').Options} */ + ({ + docs: { + sidebarPath: "./sidebars.js", + // 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/', + editUrl: ({ docPath }) => { + // TODO We can include a map here as in packageurl.org. + // Otherwise, provide a default (so “Edit this page” still works) + return `https://github.com/aboutcode-org/www.aboutcode.org/blob/main/website/docs/${docPath}`; + // fork: + // return `https://github.com/johnmhoran/www.aboutcode.org/blob/main/website/docs/${docPath}`; + }, + }, + blog: { + showReadingTime: true, + blogSidebarTitle: "All posts", + blogSidebarCount: "ALL", + blogTitle: "AboutCode blog!", + }, + + theme: { + customCss: "./src/css/custom.css", + }, + }), ], - - themeConfig: - /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ - ({ - // Replace with your project's social card - // image: 'img/docusaurus-social-card.jpg', - // colorMode: { - // respectPrefersColorScheme: true, - // }, - navbar: { - logo: { - alt: 'www.aboutcode.org Logo', - src: 'img/AboutCode-logo-stackedv3.png', - }, - style: 'dark', - items: [ - { to: '/', label: 'Home', position: 'left', exact: true }, - { - type: 'docSidebar', - sidebarId: 'getting_started', - position: 'left', - label: 'Getting Started', - }, - { - type: 'docSidebar', - sidebarId: 'about', - position: 'left', - label: 'About', - }, - { to: '/blog', label: 'Blog', position: 'left' }, - { - href: 'https://github.com/aboutcode-org', - label: 'GitHub', - position: 'right', - }, - { - href: 'https://join.slack.com/t/aboutcode-org/shared_invite/zt-1paqwxccw-IuafuiAvYJFkTqGaZsC1og', - label: 'Slack', - position: 'right', - }, - ], - }, - footer: { - style: 'dark', - links: [ - { - html: `My Company`, - }, - - { - html: ``, - }, - - { - html: ``, - }, - - { - html: ``, - }, - - { - html: ``, - }, - - { - html: ``, - }, - - { label: 'Privacy Policy', to: '/privacy' }, - { label: 'Terms of Use', to: '/terms' }, - { label: 'Credits', to: '/credits' }, - ], - copyright: `Copyright AboutCode Europe ASBL.   Content licensed under CC-BY-SA-4.0.   Built with Docusaurus.`, - }, - prism: { - theme: prismThemes.github, - darkTheme: prismThemes.dracula, - }, - }), + ], + + themeConfig: + /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ + ({ + // Replace with your project's social card + // image: 'img/docusaurus-social-card.jpg', + // colorMode: { + // respectPrefersColorScheme: true, + // }, + navbar: { + logo: { + alt: "www.aboutcode.org Logo", + src: "img/AboutCode-logo-stackedv3.png", + }, + style: "dark", + items: [ + { + type: "dropdown", + label: "Projects", + position: "left", + items: [ + { label: "ScanCode", to: "/scancode" }, + { label: "VulnerableCode", to: "/vulnerablecode" }, + { label: "DejaCode", to: "/dejacode" }, + { label: "AboutCode Stack", to: "/projects" }, + ], + }, + { to: "/", label: "Home", position: "left", exact: true }, + { + type: "docSidebar", + sidebarId: "getting_started", + position: "left", + label: "Getting Started", + }, + { + type: "docSidebar", + sidebarId: "about", + position: "left", + label: "About", + }, + { to: "/blog", label: "Blog", position: "left" }, + { to: "/contact", label: "Contact", position: "left" }, + { + href: "https://github.com/aboutcode-org", + label: "GitHub", + position: "right", + }, + { + href: "https://join.slack.com/t/aboutcode-org/shared_invite/zt-1paqwxccw-IuafuiAvYJFkTqGaZsC1og", + label: "Slack", + position: "right", + }, + ], + }, + footer: { + style: "dark", + links: [ + { + html: `My Company`, + }, + + { + html: ``, + }, + + { + html: ``, + }, + + { + html: ``, + }, + + { + html: ``, + }, + + { + html: ``, + }, + + { label: "Privacy Policy", to: "/privacy" }, + { label: "Terms of Use", to: "/terms" }, + { label: "Credits", to: "/credits" }, + ], + copyright: `Copyright AboutCode Europe ASBL.   Content licensed under CC-BY-SA-4.0.   Built with Docusaurus.`, + }, + prism: { + theme: prismThemes.github, + darkTheme: prismThemes.dracula, + }, + }), }; export default config; diff --git a/website/package-lock.json b/website/package-lock.json index e9f3bc4..053bb12 100644 --- a/website/package-lock.json +++ b/website/package-lock.json @@ -230,6 +230,7 @@ "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.46.0.tgz", "integrity": "sha512-22SHEEVNjZfFWkFks3P6HilkR3rS7a6GjnCIqR22Zz4HNxdfT0FG+RE7efTcFVfLUkTTMQQybvaUcwMrHXYa7Q==", "license": "MIT", + "peer": true, "dependencies": { "@algolia/client-common": "5.46.0", "@algolia/requester-browser-xhr": "5.46.0", @@ -355,6 +356,7 @@ "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.28.5.tgz", "integrity": "sha512-e7jT4DxYvIDLk1ZHmU/m/mB19rex9sv0c2ftBtjSBv+kVM/902eh0fINUzD7UwLLNR+jU585GxUJ8/EBfAM5fw==", "license": "MIT", + "peer": true, "dependencies": { "@babel/code-frame": "^7.27.1", "@babel/generator": "^7.28.5", @@ -2144,6 +2146,7 @@ } ], "license": "MIT", + "peer": true, "engines": { "node": ">=18" }, @@ -2166,6 +2169,7 @@ } ], "license": "MIT", + "peer": true, "engines": { "node": ">=18" } @@ -2275,6 +2279,7 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", "license": "MIT", + "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -2696,6 +2701,7 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", "license": "MIT", + "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -3630,6 +3636,7 @@ "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.9.2.tgz", "integrity": "sha512-C5wZsGuKTY8jEYsqdxhhFOe1ZDjH0uIYJ9T/jebHwkyxqnr4wW0jTkB72OMqNjsoQRcb0JN3PcSeTwFlVgzCZg==", "license": "MIT", + "peer": true, "dependencies": { "@docusaurus/core": "3.9.2", "@docusaurus/logger": "3.9.2", @@ -4326,6 +4333,7 @@ "resolved": "https://registry.npmjs.org/@mdx-js/react/-/react-3.1.1.tgz", "integrity": "sha512-f++rKLQgUVYDAtECQ6fn/is15GkEH9+nZPM3MS0RcxVqoTfawHvDlSCH7JbMhAM6uJ32v3eXLvLmLvjGu7PTQw==", "license": "MIT", + "peer": true, "dependencies": { "@types/mdx": "^2.0.0" }, @@ -4644,6 +4652,7 @@ "resolved": "https://registry.npmjs.org/@svgr/core/-/core-8.1.0.tgz", "integrity": "sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA==", "license": "MIT", + "peer": true, "dependencies": { "@babel/core": "^7.21.3", "@svgr/babel-preset": "8.1.0", @@ -5015,6 +5024,7 @@ "resolved": "https://registry.npmjs.org/@types/react/-/react-19.2.7.tgz", "integrity": "sha512-MWtvHrGZLFttgeEj28VXHxpmwYbor/ATPYbBfSFZEIRK0ecCFLl2Qo55z52Hss+UV9CRN7trSeq1zbgx7YDWWg==", "license": "MIT", + "peer": true, "dependencies": { "csstype": "^3.2.2" } @@ -5365,6 +5375,7 @@ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", "license": "MIT", + "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -5450,6 +5461,7 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", @@ -5495,6 +5507,7 @@ "resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-5.46.0.tgz", "integrity": "sha512-7ML6fa2K93FIfifG3GMWhDEwT5qQzPTmoHKCTvhzGEwdbQ4n0yYUWZlLYT75WllTGJCJtNUI0C1ybN4BCegqvg==", "license": "MIT", + "peer": true, "dependencies": { "@algolia/abtesting": "1.12.0", "@algolia/client-abtesting": "5.46.0", @@ -5958,6 +5971,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "baseline-browser-mapping": "^2.9.0", "caniuse-lite": "^1.0.30001759", @@ -6914,6 +6928,7 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", "license": "MIT", + "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -8287,6 +8302,7 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -12742,6 +12758,7 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -13257,6 +13274,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", @@ -14160,6 +14178,7 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", "license": "MIT", + "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -14956,6 +14975,7 @@ "resolved": "https://registry.npmjs.org/react/-/react-19.2.1.tgz", "integrity": "sha512-DGrYcCWK7tvYMnWh79yrPHt+vdx9tY+1gPZa7nJQtO/p8bLTDaHp4dzwEhQB7pZ4Xe3ok4XKuEPrVuc+wlpkmw==", "license": "MIT", + "peer": true, "engines": { "node": ">=0.10.0" } @@ -14965,6 +14985,7 @@ "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.2.1.tgz", "integrity": "sha512-ibrK8llX2a4eOskq1mXKu/TGZj9qzomO+sNfO98M6d9zIPOEhlBkMkBUBLd1vgS0gQsLDBzA+8jJBVXDnfHmJg==", "license": "MIT", + "peer": true, "dependencies": { "scheduler": "^0.27.0" }, @@ -15020,6 +15041,7 @@ "resolved": "https://registry.npmjs.org/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz", "integrity": "sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ==", "license": "MIT", + "peer": true, "dependencies": { "@types/react": "*" }, @@ -15048,6 +15070,7 @@ "resolved": "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz", "integrity": "sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==", "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.12.13", "history": "^4.9.0", @@ -16918,7 +16941,8 @@ "version": "2.8.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", - "license": "0BSD" + "license": "0BSD", + "peer": true }, "node_modules/type-fest": { "version": "2.19.0", @@ -17308,6 +17332,7 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -17515,6 +17540,7 @@ "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.103.0.tgz", "integrity": "sha512-HU1JOuV1OavsZ+mfigY0j8d1TgQgbZ6M+J75zDkpEAwYeXjWSqrGJtgnPblJjd/mAyTNQ7ygw0MiKOn6etz8yw==", "license": "MIT", + "peer": true, "dependencies": { "@types/eslint-scope": "^3.7.7", "@types/estree": "^1.0.8", @@ -18105,6 +18131,7 @@ "resolved": "https://registry.npmjs.org/zod/-/zod-4.1.13.tgz", "integrity": "sha512-AvvthqfqrAhNH9dnfmrfKzX5upOdjUVJYFqNSlkmGf64gRaTzlPwz99IHYnVs28qYAybvAlBV+H7pn0saFY4Ig==", "license": "MIT", + "peer": true, "funding": { "url": "https://github.com/sponsors/colinhacks" }