diff --git a/.vitepress/config.mts b/.vitepress/config.mts index b246eaa9a3..a44222764d 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -1,132 +1,135 @@ -import { defineConfig } from 'vitepress'; +import { defineConfig } from "vitepress"; export default defineConfig({ - srcDir: 'docs', + srcDir: "docs", srcExclude: [], - outDir: 'build', - base: '/', - title: 'The JavaScript Oxidation Compiler', - titleTemplate: ':title | The JavaScript Oxidation Compiler', + outDir: "build", + base: "/", + title: "The JavaScript Oxidation Compiler", + titleTemplate: ":title | The JavaScript Oxidation Compiler", description: - 'A collection of high-performance JavaScript tools written in Rust', + "A collection of high-performance JavaScript tools written in Rust", head: [ [ - 'link', + "link", { - rel: 'icon', - href: 'https://raw.githubusercontent.com/oxc-project/oxc-assets/main/logo-round.png', + rel: "icon", + href: "https://raw.githubusercontent.com/oxc-project/oxc-assets/main/logo-round.png", }, ], ], lastUpdated: true, themeConfig: { - siteTitle: 'Oxc', - logo: 'https://raw.githubusercontent.com/oxc-project/oxc-assets/main/logo-round.png', - logoLink: '/', + siteTitle: "OXC", + logo: "https://raw.githubusercontent.com/oxc-project/oxc-assets/main/logo-round.png", + logoLink: "/", search: { - provider: 'local', + provider: "local", }, nav: [ - { text: 'Home', link: '/' }, - { text: 'Getting Started', link: '/docs/usage/linter' }, - { text: 'Contribute', link: '/docs/contribute/intro' }, - { text: 'Learn', link: '/docs/learn/ecosystem' }, - { text: 'Blog', link: '/blog/2022-02-10-js-tooling-research' }, + { text: "Home", link: "/" }, + { text: "Getting Started", link: "/docs/usage/linter" }, + { text: "Contribute", link: "/docs/contribute/intro" }, + { text: "Learn", link: "/docs/learn/ecosystem" }, + { text: "Blog", link: "/blog/2022-02-10-js-tooling-research" }, { - text: 'Playground', - target: '_blank', - link: 'https://oxc-project.github.io/oxc/playground/', + text: "Playground", + target: "_blank", + link: "https://oxc-project.github.io/oxc/playground/", }, ], socialLinks: [ - { icon: 'twitter', link: 'https://x.com/boshen_c' }, - { icon: 'discord', link: 'https://discord.gg/9uXCAwqQZW' }, - { icon: 'github', link: 'https://github.com/oxc-project' }, + { icon: "twitter", link: "https://x.com/boshen_c" }, + { icon: "discord", link: "https://discord.gg/9uXCAwqQZW" }, + { icon: "github", link: "https://github.com/oxc-project" }, ], editLink: { - pattern: 'https://github.com/oxc-project/oxc/edit/main/src/:path', + pattern: "https://github.com/oxc-project/oxc/edit/main/src/:path", }, lastUpdated: { formatOptions: { - dateStyle: 'full', + dateStyle: "full", }, }, + footer: { + copyright: "© 2023 OXC Project", + }, sidebar: { - '/docs/usage/': [ + "/docs/usage/": [ { - text: 'Usage', + text: "Usage", items: [ - { text: 'Linter', link: '/docs/usage/linter' }, - { text: 'Parser', link: '/docs/usage/parser' }, - { text: 'Resolver', link: '/docs/usage/resolver' }, + { text: "Linter", link: "/docs/usage/linter" }, + { text: "Parser", link: "/docs/usage/parser" }, + { text: "Resolver", link: "/docs/usage/resolver" }, ], }, { items: [ - { text: 'Philosophy', link: '/docs/usage/philosophy' }, - { text: 'Benchmarks', link: '/docs/usage/benchmarks' }, + { text: "Philosophy", link: "/docs/usage/philosophy" }, + { text: "Benchmarks", link: "/docs/usage/benchmarks" }, ], }, ], - '/docs/contribute/': [ - { text: 'Intro', link: '/docs/contribute/intro' }, - { text: 'Rules', link: '/docs/contribute/rules' }, + "/docs/contribute/": [ + { text: "Intro", link: "/docs/contribute/intro" }, + { text: "Rules", link: "/docs/contribute/rules" }, { items: [ - { text: 'Parser', link: '/docs/contribute/parser' }, - { text: 'Linter', link: '/docs/contribute/linter' }, - { text: 'Prettier', link: '/docs/contribute/prettier' }, - { text: 'Resolver', link: '/docs/contribute/resolver' }, - { text: 'Transformer', link: '/docs/contribute/transformer' }, - { text: 'Formatter', link: '/docs/contribute/formatter' }, - { text: 'Codegen', link: '/docs/contribute/codegen' }, - { text: 'Minifier', link: '/docs/contribute/minifier' }, - { text: 'VSCode', link: '/docs/contribute/vscode' }, + { text: "Parser", link: "/docs/contribute/parser" }, + { text: "Linter", link: "/docs/contribute/linter" }, + { text: "Prettier", link: "/docs/contribute/prettier" }, + { text: "Resolver", link: "/docs/contribute/resolver" }, + { text: "Transformer", link: "/docs/contribute/transformer" }, + { text: "Formatter", link: "/docs/contribute/formatter" }, + { text: "Codegen", link: "/docs/contribute/codegen" }, + { text: "Minifier", link: "/docs/contribute/minifier" }, + { text: "VSCode", link: "/docs/contribute/vscode" }, ], }, - { text: 'Performance', link: '/docs/contribute/performance' }, - { text: 'Showcase', link: '/docs/contribute/showcase' }, + { text: "Performance", link: "/docs/contribute/performance" }, + { text: "Showcase", link: "/docs/contribute/showcase" }, ], - '/docs/learn/': [ + "/docs/learn/": [ { - text: 'Architecture', + text: "Architecture", items: [ - { text: 'Intro', link: '/docs/learn/architecture/intro' }, - { text: 'Parser', link: '/docs/learn/architecture/parser' }, - { text: 'Linter', link: '/docs/learn/architecture/linter' }, - { text: 'Resolver', link: '/docs/learn/architecture/resolver' }, + { text: "Intro", link: "/docs/learn/architecture/intro" }, + { text: "Parser", link: "/docs/learn/architecture/parser" }, + { text: "Linter", link: "/docs/learn/architecture/linter" }, + { text: "Resolver", link: "/docs/learn/architecture/resolver" }, { - text: 'Transformer', - link: '/docs/learn/architecture/transformer', + text: "Transformer", + link: "/docs/learn/architecture/transformer", }, - { text: 'Formatter', link: '/docs/learn/architecture/formatter' }, - { text: 'Minifier', link: '/docs/learn/architecture/minifier' }, + { text: "Formatter", link: "/docs/learn/architecture/formatter" }, + { text: "Minifier", link: "/docs/learn/architecture/minifier" }, ], }, { - text: 'ECMAScript', + text: "ECMAScript", items: [ - { text: 'Spec', link: '/docs/learn/ecmascript/spec' }, - { text: 'Grammar', link: '/docs/learn/ecmascript/grammar' }, + { text: "Spec", link: "/docs/learn/ecmascript/spec" }, + { text: "Grammar", link: "/docs/learn/ecmascript/grammar" }, ], }, - { text: 'Performance', link: '/docs/learn/performance' }, - { text: 'Ecosystem', link: '/docs/learn/ecosystem' }, - { text: 'References', link: '/docs/learn/references' }, + { text: "Performance", link: "/docs/learn/performance" }, + { text: "Ecosystem", link: "/docs/learn/ecosystem" }, + { text: "References", link: "/docs/learn/references" }, ], - '/blog/': [ + "/blog/": [ { - text: 'Oxlint General Availability', - link: '/blog/2023-11-08-announcing-oxlint', + text: "Oxlint General Availability", + link: "/blog/2023-11-08-announcing-oxlint", }, - { text: 'Announcing Oxc', link: '/blog/2023-11-07-announcing-oxc' }, + { text: "Announcing Oxc", link: "/blog/2023-11-07-announcing-oxc" }, { - text: 'A research on JavaScript linters', - link: '/blog/2022-08-08-linter-research', + text: "A research on JavaScript linters", + link: "/blog/2022-08-08-linter-research", }, { - text: 'High Performance JavaScript Toolchain', - link: '/blog/2022-02-10-js-tooling-research', + text: "High Performance JavaScript Toolchain", + link: "/blog/2022-02-10-js-tooling-research", }, ], }, diff --git a/docs/index.md b/docs/index.md index 237496b56a..b865e8e709 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,9 +1,7 @@ --- -# https://vitepress.dev/reference/default-theme-home-page layout: home hero: name: "The JavaScript Oxidation Compiler" - text: "" tagline: A collection of JavaScript tools written in Rust image: src: https://raw.githubusercontent.com/oxc-project/oxc-assets/main/logo-round.png @@ -16,22 +14,32 @@ hero: text: View on GitHub link: https://github.com/oxc-project/oxc features: - - title: Parser ✅ + - title: Parser ✅ details: 2x faster than swc
Passes 99% of Test262 - - title: Linter ✅ + link: /docs/usage/parser + linkText: Learn more + - title: Linter ✅ details: 50 - 100x faster than ESLint
Zero config - - title: Resolver ✅ + link: /docs/usage/linter + linkText: Learn more + - title: Resolver ✅ details: 28x faster than enhanced-resolve
Feature complete + link: /docs/usage/resolver + linkText: Learn more - title: Formatter 🚧 details: Prettier compatible
Work in progress - title: Transformer details: Babel compatible
Prototype - title: Minifier details: Optimization of Google Closure Compiler
Prototype - - title: Ezno Type Checker + - title: Ezno Type Checker details: A novel TypeScript type checker - - title: Rspack Bundler ✅ + link: https://github.com/kaleidawave/ezno + external: true + - title: Rspack Bundler ✅ details: Rust port of Webpack
Partnership + link: https://rspack.dev + external: true - title: Rolldown Bundler details: Rust port of Rollup
Partnership ---