diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 6f7038b..261e06f 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -5,6 +5,27 @@ // See: https://docusaurus.io/docs/api/docusaurus-config import { themes as prismThemes } from 'prism-react-renderer'; +import { execSync } from 'node:child_process'; + +// Run git to get versions, and commit date when buildingg. +// Fall-back to defaulst for non-git clones/tarballs/plain dir upload +function vcs_info() { + const run = (cmd) => execSync(cmd, { encoding: 'utf8' }).trim(); + try { + return { + version: run('git describe --always --tags --dirty'), + commit_date: run('git log -1 --format=%cI'), + // also strip trailing slash + repo_url: run('git config --get remote.origin.url').replace(/\/$/, ''), + }; + } catch { + return { + version: 'unknown', + commit_date: '', + repo_url: 'https://github.com/aboutcode-org/www.aboutcode.org', + }; + } +} // Deployment target: local | gh | dreamhost /** @type {'local' | 'gh' | 'dreamhost'} */ @@ -35,6 +56,11 @@ const siteConfig = { // Define const for the footer icon paths. const currentBaseUrl = siteConfig[deployTarget].baseUrl +const vcs = vcs_info(); +const buildLine = vcs.version === 'unknown' + ? '' + : `
Built with Docusaurus from ${vcs.repo_url} @ ${vcs.version} on ${vcs.commit_date}
`; + /** @type {import('@docusaurus/types').Config} */ const config = { title: 'AboutCode.org', @@ -42,6 +68,7 @@ const config = { favicon: 'img/favicon.ico', + markdown: { format: 'detect', // Auto-detects: .md = plain Markdown (CommonMark), .mdx = MDX hooks: { @@ -133,6 +160,10 @@ const config = { label: 'Projects', position: 'left' }, + { to: '/environments', + label: 'Environments', + position: 'left' + }, { type: 'dropdown', label: 'About', @@ -196,7 +227,7 @@ const config = { { label: 'Terms of Use', to: '/terms' }, { label: 'Credits', to: '/docs/about/credits' }, ], - copyright: `Copyright AboutCode Europe ASBL.   Content licensed under CC-BY-SA-4.0.   Built with Docusaurus.`, + copyright: `Copyright (c) AboutCode Europe ASBL.   Content licensed under CC-BY-SA-4.0.${buildLine}`, }, prism: { theme: prismThemes.github, diff --git a/website/src/components/EcosystemGrid/index.js b/website/src/components/EcosystemGrid/index.js index 64d4f81..d7e1828 100644 --- a/website/src/components/EcosystemGrid/index.js +++ b/website/src/components/EcosystemGrid/index.js @@ -229,8 +229,17 @@ function GridItem({ item }) { ); } -function GridSection({ id, title, items, header_link, intro }) { + +// Grid section comes either as a summary with see all link, or no link for +// the full envt. page +function GridSection({ id, title, items, header_link, intro, see_all }) { const headerLinkHref = useBaseUrl(header_link?.url || '/'); + const seeAllHref = useBaseUrl(see_all?.url || '/'); + + const introWithSeeAll = intro && see_all + ? React.cloneElement(intro, {}, ...React.Children.toArray(intro.props.children), ' ', + {see_all.label}.) + : intro; return (

@@ -239,7 +248,7 @@ function GridSection({ id, title, items, header_link, intro }) { <>{' - '}{header_link.label}... )}

- {intro &&
{intro}
} + {introWithSeeAll &&
{introWithSeeAll}
}
{items.map((item) => ( @@ -249,7 +258,56 @@ function GridSection({ id, title, items, header_link, intro }) { ); } -export default function EcosystemGrid() { +// Feature only the most common on home, with links to see all. + +const featured_licenses = [ + 'MIT', 'Apache-2.0', 'GPL-2.0', 'GPL-3.0', 'BSD-2-Clause', + 'BSD-3-Clause', 'LGPL-2.0', 'LGPL-2.1', 'LGPL-3.0', +].map((label) => licenses.find((v) => v.label === label)); + +const featured_vulnerability_sources = [ + 'NVD', 'CVE', 'GitHub Advisories', 'GitLab Advisories', 'OSV.dev', + 'npm Advisories', 'PyPA', 'Ruby Advisory DB', 'Rust Advisory DB', +].map((label) => vulnerability_sources.find((v) => v.label === label)); + +const featured_package_ecosystems = [ + 'npm', 'PyPI', 'Maven', 'NuGet', 'RubyGems', + 'Cargo', 'Composer', 'Conda', 'Docker', +].map((label) => package_ecosystems.find((v) => v.label === label)); + + +export default function EcosystemGrid({ featured = false }) { + if (featured) { + return ( +
+ AboutCode tracks over 2,500+ curated licenses across 12 categories. Browse all 2,500+ licenses in the LicenseDB. Industry-leading license detection is backed by over 35,000 license notices used as detection rules.

} + see_all={{ label: 'See more supported licenses', url: '/environments/#licensing' }} + /> + AboutCode collects, correlates, and improves vulnerabilities from multiple advisory data sources, privileging upstream data.

} + see_all={{ label: 'See more tracked vulnerability sources', url: '/environments/#vuln-sources' }} + /> + The AboutCode package database and scanners track millions of packages from most package ecosystems.

} + see_all={{ label: 'See more supported package ecosystems', url: '/environments/#pkg-ecosystems' }} + /> +
+ ); + } + return (
AboutCode tracks over 2,500+ curated licenses across 12 categories. Browse all 2,500+ licenses in the LicenseDB. Industry-leading license detection is backed by over 35,000 license notices used as detection rules.

} /> + The AboutCode package database and scanners track millions of packages from most package ecosystems.

} + /> AboutCode collects, correlates, and improves vulnerabilities from multiple advisory data sources, privileging upstream data.

} /> The AboutCode package database and scanners track millions of packages from most package ecosystems.

} - /> + id="vuln-reference-data" + title="Vulnerability severity and other reference data" + items={vulnerability_reference_data} + header_link={{ label: 'Get started with software security', url: '/docs/getting_started/software-security/' }} + intro={

AboutCode imports vulnerability reference data in key industry formats, mapping these to PURL.

} + /> AboutCode supports extraction of most archive, compressed, package, and disk image file formats.

} /> - AboutCode imports vulnerability reference data in key industry formats, mapping these to PURL.

} - />
); } diff --git a/website/src/components/EcosystemGrid/styles.module.css b/website/src/components/EcosystemGrid/styles.module.css index 727c8fa..a66df42 100644 --- a/website/src/components/EcosystemGrid/styles.module.css +++ b/website/src/components/EcosystemGrid/styles.module.css @@ -138,3 +138,33 @@ [data-theme='dark'] .cellLabel { color: #c8d0e0; } + +.moreList { + margin: 0.25rem 0 0 0; + padding-left: 1.25rem; + font-size: 0.9rem; + line-height: 1.6; +} + +.moreList a { + color: #2a6bc7; + text-decoration: none; + font-weight: 500; +} + +.moreList a:hover { + text-decoration: underline; +} + +.moreCount { + color: #6b7a99; + font-size: 0.8rem; +} + +.moreSummary { + color: #2b3a5e; +} + +[data-theme='dark'] .moreSummary { + color: #c8d0e0; +} diff --git a/website/src/components/HomepageContent/index.js b/website/src/components/HomepageContent/index.js index 8d7e6ae..1470b9d 100644 --- a/website/src/components/HomepageContent/index.js +++ b/website/src/components/HomepageContent/index.js @@ -68,18 +68,6 @@ export default function HomepageContent() { -
-
-

Supporters

-
-
- -
-
-
-

Supported ecosystems, languages, licenses, and data sources

+

Supported ecosystems, languages, licenses, and data sources - See all environments

AboutCode tools support a large number of licenses, package ecosystems, programming languages, and vulnerability data sources, all identified using{' '} - Package-URL (PURL) or SPDX license expressions.

+ Package-URL (PURL) or SPDX license expressions. + See a few highlights below; the full set of supported Environments + also includes operating systems, programming languages, binary and archive formats, and more data sources.

+
+ +
+ +
+
+

Supporters

+
+
+ +

+ Join the conversation,{' '} + or contribute to{' '} + AboutCode projects to help make the software + supply chains healthier and safer! +

-
diff --git a/website/src/css/custom.css b/website/src/css/custom.css index a41d92e..ba2847a 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -89,3 +89,15 @@ .footer { background-color: #2b3a5e; } + +.footer__build { + margin-top: 0.5rem; + font-size: 0.75rem; + opacity: 0.55; +} + +.footer__build a { + color: inherit; + border-bottom: 1px dotted currentColor; + text-decoration: none; +} diff --git a/website/src/pages/environments.js b/website/src/pages/environments.js new file mode 100644 index 0000000..6d7caa5 --- /dev/null +++ b/website/src/pages/environments.js @@ -0,0 +1,34 @@ +import React from 'react'; +import Layout from '@theme/Layout'; +import EcosystemGrid from '@site/src/components/EcosystemGrid'; +import styles from '@site/src/components/HomepageContent/styles.module.css'; + +export default function Environments() { + return ( + +
+
+
+

Environments

+
+
+

AboutCode tools support a large number of licenses, + package ecosystems, programming languages, operating + systems, binary and archive formats, and vulnerability + data sources, all identified using{' '} + Package-URL (PURL) or + SPDX license expressions.

+
+ +
+
+
+ + ); +}