feat: upgrade to docusaurus 3

Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>

Author: sagikazarmark

.github/workflows/ci.yaml

@@ -3,7 +3,6 @@ name: CI
 on:
   pull_request:
 
-
 permissions:
   contents: read
 
@@ -29,7 +28,7 @@ jobs:
         run: nix develop --impure .#ci
 
       - name: Download dependencies
-        run: nix develop --impure .#ci -c yarn install --frozen-lockfile
+        run: nix develop --impure .#ci -c npm install
 
       - name: Build
-        run: nix develop --impure .#ci -c yarn build
+        run: nix develop --impure .#ci -c npm run build

.github/workflows/publish.yaml

@@ -34,10 +34,10 @@ jobs:
         uses: actions/configure-pages@f156874f8191504dae5b037505266ed5dda6c382 # v3.0.6
 
       - name: Download dependencies
-        run: nix develop --impure .#ci -c yarn install --frozen-lockfile
+        run: nix develop --impure .#ci -c npm install
 
       - name: Build
-        run: nix develop --impure .#ci -c yarn build
+        run: nix develop --impure .#ci -c npm run build
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@a753861a5debcf57bf8b404356158c8e1e33150c # v2.0.0

README.md

@@ -1,33 +1,25 @@
 # TwirPHP website
 
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
 
-### Installation
+## Installation
 
-```
-$ yarn
+```shell
+yarn
 ```
 
-### Local Development
+## Local Development
 
-```
-$ yarn start
+```shell
+npm run start
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
-### Build
+## Build
 
-```
-$ yarn build
+```shell
+npm run build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
-
-### Deployment
-
-```
-$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

babel.config.js

@@ -0,0 +1,127 @@
+import {themes as prismThemes} from 'prism-react-renderer';
+import type {Config} from '@docusaurus/types';
+import type * as Preset from '@docusaurus/preset-classic';
+
+// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
+
+const config: Config = {
+  title: 'TwirPHP',
+  tagline: 'Twitch\'s simple RPC framework powered by protobuf, ported to PHP',
+  // favicon: 'img/favicon.ico',
+
+  url: 'https://twirphp.github.io',
+  baseUrl: '/',
+  trailingSlash: false,
+
+  organizationName: 'twirphp',
+  projectName: 'twirphp.github.io',
+
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  presets: [
+    [
+      'classic',
+      {
+        docs: {
+          sidebarPath: './sidebars.ts',
+          editUrl: 'https://github.com/twirphp/twirphp.github.io/edit/main/',
+        },
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+      } satisfies Preset.Options,
+    ],
+  ],
+
+  themeConfig: {
+    // Replace with your project's social card
+    // image: 'img/docusaurus-social-card.jpg',
+    navbar: {
+      // title: 'TwirPHP',
+      logo: {
+          alt: 'TwirPHP',
+          src: 'img/logo.svg',
+          srcDark: 'img/logo-dark.svg',
+      },
+      items: [
+        {
+          type: 'docSidebar',
+          sidebarId: 'docs',
+          position: 'left',
+          label: 'Docs',
+        },
+        {
+          href: 'https://twitchtv.github.io/twirp/',
+          label: 'Twirp website',
+        },
+        {
+          to: 'community',
+          label: 'Community',
+          position: 'right'
+        },
+        {
+          href: 'https://github.com/twirphp/twirp/releases/latest',
+          position: 'right',
+          className: 'header-download-link header-icon-link',
+          'aria-label': 'Download',
+        },
+        {
+          href: 'https://github.com/twirphp/twirp',
+          // label: 'GitHub',
+          position: 'right',
+          className: 'header-github-link header-icon-link',
+          'aria-label': 'GitHub repository',
+        },
+      ],
+    },
+    footer: {
+      style: 'dark',
+      links: [
+        {
+          title: 'Docs',
+          items: [
+            {
+              label: 'About',
+              to: '/docs/about',
+            },
+            {
+              label: 'Quickstart',
+              to: '/docs/quickstart',
+            },
+            {
+              label: 'Overview',
+              to: '/docs/overview',
+            },
+          ],
+        },
+        {
+          title: 'Community',
+          items: [
+            {
+              label: 'Get in touch',
+              href: '/community',
+            },
+            {
+              label: 'GitHub',
+              href: 'https://github.com/twirphp/twirp',
+            },
+          ],
+        },
+      ],
+      copyright: `Copyright © ${new Date().getFullYear()} <a href="https://sagikazarmark.hu">Márk Sági-Kazár</a>.`,
+    },
+    prism: {
+      theme: prismThemes.github,
+      darkTheme: prismThemes.dracula,
+      additionalLanguages: ['protobuf', 'php'],
+    },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;

docusaurus.config.js

@@ -21,7 +21,6 @@
 
             pre-commit.hooks = {
               nixpkgs-fmt.enable = true;
-              yamllint.enable = true;
             };
 
             packages = with pkgs; [