docusaurus.config.js

// @ts-check
// `@type` JSDoc annotations allow editor autocompletion and type checking
// (when paired with `@ts-check`).
// 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"

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "Lucky - Web framework for Crystal",
  tagline: "Build lightning fast web apps with fewer bugs",
  favicon: "img/favicon.ico",

  // Set the production url of your site here
  url: "https://www.luckyframework.org",
  // Set the /<baseUrl>/ pathname under which your site is served
  baseUrl: "/",

  customFields: {
    minCrystalVersion: process.env.MIN_CRYSTAL_VERSION || "1.6.0",
    maxCrystalVersion: process.env.MAX_CRYSTAL_VERSION || "1.11.2",
    luckyCliVersion: process.env.LUCKY_CLI_VERSION || "1.1.1",
    luckyCliTag: process.env.LUCKY_CLI_TAG || "v1.1.1",
  },

  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/",
        },
        blog: {
          showReadingTime: true,
          // 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/",
        },
        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: {
        defaultMode: "dark",
        disableSwitch: false,
        respectPrefersColorScheme: true,
      },
      navbar: {
        title: "Lucky",
        logo: {
          alt: "Lucky Logo",
          src: "img/logo.svg",
        },
        items: [
          {
            type: "doc",
            docId: "getting-started/installing",
            position: "left",
            label: "Guides",
          },
          { to: "/blog", label: "Blog", position: "left" },
          {
            href: "https://github.com/luckyframework/lucky",
            label: "GitHub",
            position: "right",
          },
        ],
      },
      footer: {
        style: "dark",
        links: [
          {
            label: "Code of Conduct",
            href: "https://github.com/luckyframework/lucky/blob/main/CODE_OF_CONDUCT.md",
          },
          {
            label: "Contributors",
            href: "https://github.com/luckyframework/lucky/graphs/contributors",
          },
          {
            label: "Twitter",
            href: "https://twitter.com/luckyframework",
          },
          {
            label: "Discord",
            href: "https://discord.com/invite/HeqJUcb",
          },
        ],
      },
      prism: {
        theme: prismThemes.github,
        darkTheme: prismThemes.dracula,
        additionalLanguages: ["powershell", "ruby", "crystal"],
      },
    }),

  plugins: [
    function tailwindPlugin(context, options) {
      return {
        name: "docusaurus-tailwindcss",
        configurePostCss(postCssOptions) {
          postCssOptions.plugins.push(require("tailwindcss"))
          postCssOptions.plugins.push(require("autoprefixer"))
          return postCssOptions
        },
      }
    },
  ],
}

export default config