nixos-and-flakes-book/docs/.vitepress/config.ts

import { defineConfig } from 'vitepress'

// https://vitepress.dev/reference/site-config
export default defineConfig({
  markdown: {
    theme: "material-theme-palenight",
    lineNumbers: true,

    // adjust how header anchors are generated,
    // useful for integrating with tools that use different conventions
    anchor: {
      slugify(str) {
        return encodeURIComponent(str);
      },
    },
  },

  locales: {
    root: {
      label: "English",
      lang: "en",
      link: "/",
      title: "NixOS & Flakes Book",
      description: "An unofficial book for beginners",

      themeConfig: {
        // https://vitepress.dev/reference/default-theme-config
        nav: [
          { text: "Home", link: "/" },
          { text: "Get Started", link: "/introduction/index.md" },
          { text: "Best Pracetice", link: "/best-practices/index.md" },
        ],

        sidebar: [
          {
            text: "Get Started",
            items: [
              { text: "Introduction", link: "/introduction/index.md" },
              {
                text: "Advantages and Disadvantages",
                link: "/introduction/advantages-and-disadvantages.md",
              },
              {
                text: "Installation",
                link: "/introduction/installation.md",
              },
            ],
          },
          {
            text: "The Nix Language",
            items: [{ text: "Basics", link: "/the-nix-language/index.md" }],
          },
          {
            text: "NixOS with Flakes",
            items: [
              {
                text: "Get Started with NixOS",
                link: "/nixos-with-flakes/get-started-with-nixos.md",
              },
              {
                text: "Introduction to Flakes",
                link: "/nixos-with-flakes/introduction-to-flakes.md",
              },
              {
                text: "NixOS with Flakes Enabled",
                link: "/nixos-with-flakes/nixos-with-flakes-enabled.md",
              },
              {
                text: "Started using Home Manager",
                link: "/nixos-with-flakes/start-using-home-manager.md",
              },
              {
                text: "Modularize the Configuration",
                link: "/nixos-with-flakes/modularize-the-configuration.md",
              },
              {
                text: "Update the System",
                link: "/nixos-with-flakes/update-the-system.md",
              },
              {
                text: "Upgrade or Downgrade Packages",
                link: "/nixos-with-flakes/downgrade-or-upgrade-packages.md",
              },
              {
                text: "Other useful Tips",
                link: "/nixos-with-flakes/other-useful-tips.md",
              },
            ],
          },
          {
            text: "Nixpkgs's Advanced Usage",
            items: [
              { text: "Introduction", link: "/nixpkgs/intro.md" },
              { text: "callPackage", link: "/nixpkgs/callpackage.md" },
              { text: "Overridding", link: "/nixpkgs/overriding.md" },
              { text: "Overlays", link: "/nixpkgs/overlays.md" },
            ],
          },
          {
            text: "Best Practices",
            items: [
              { text: "Introduction", link: "/best-practices/intro.md" },
              {
                text: "Run downloaded binaries on NixOS",
                link: "/best-practices/run-downloaded-binaries-on-nixos.md",
              },
              {
                text: "Simplify NixOS-related Commands",
                link: "/best-practices/simplify-nixos-related-commands.md",
              },
              {
                text: "Debug with nix repl",
                link: "/best-practices/debug-with-nix-repl.md",
              },
            ],
          },

          {
            text: "Other Usage of Flakes",
            items: [
              { text: "Introduction", link: "/other-usage-of-flakes/intro.md" },
              {
                text: "Flake Inputs",
                link: "/other-usage-of-flakes/inputs.md",
              },
              {
                text: "Flake Outputs",
                link: "/other-usage-of-flakes/outputs.md",
              },
              {
                text: "The New CLI",
                link: "/other-usage-of-flakes/the-new-cli.md",
              },
            ],
          },
          {
            text: "Advanced Topics",
            items: [
              { text: "Introduction", link: "/advanced-topics/index.md" },
            ],
          },
        ],

        socialLinks: [
          {
            icon: "github",
            link: "https://github.com/ryan4yin/nixos-and-flakes-book",
          },
        ],
      },
    },
    zh: {
      label: "简体中文",
      lang: "zh-CN",
      link: "/zh/",
      title: "NixOS 与 Flakes",
      description: "一份非官方的新手指南",

      themeConfig: {
        // https://vitepress.dev/reference/default-theme-config
        nav: [
          { text: "Home", link: "/zh/" },
          { text: "Get Started", link: "/zh/introduction/index.md" },
          { text: "Best Pracetice", link: "/zh/best-practices/index.md" },
        ],

        sidebar: [
          {
            text: "开始使用",
            items: [
              { text: "简介", link: "/zh/introduction/index.md" },
              {
                text: "优缺点",
                link: "/zh/introduction/advantages-and-disadvantages.md",
              },
              {
                text: "安装",
                link: "/zh/introduction/installation.md",
              },
            ],
          },
          {
            text: "Nix 语言",
            items: [
              { text: "快速入门", link: "/zh/the-nix-language/index.md" },
            ],
          },

          {
            text: "NixOS 与 Flakes",
            items: [
              {
                text: "开始使用 NixOS",
                link: "/zh/nixos-with-flakes/get-started-with-nixos.md",
              },
              {
                text: "Flakes 简介",
                link: "/zh/nixos-with-flakes/introduction-to-flakes.md",
              },
              {
                text: "使用 Flakes 管理 NixOS",
                link: "/zh/nixos-with-flakes/nixos-with-flakes-enabled.md",
              },
              {
                text: "安装使用 Home Manager",
                link: "/zh/nixos-with-flakes/start-using-home-manager.md",
              },
              {
                text: "模块化系统配置",
                link: "/zh/nixos-with-flakes/modularize-the-configuration.md",
              },
              {
                text: "更新系统",
                link: "/zh/nixos-with-flakes/update-the-system.md",
              },
              {
                text: "升级或降级软件包",
                link: "/zh/nixos-with-flakes/downgrade-or-upgrade-packages.md",
              },
              {
                text: "其他杂七杂八的内容",
                link: "/zh/nixos-with-flakes/other-useful-tips.md",
              },
            ],
          },
          {
            text: "Nixpkgs 高级用法",
            items: [
              { text: "介绍", link: "/zh/nixpkgs/intro.md" },
              { text: "callPackage", link: "/zh/nixpkgs/callpackage.md" },
              { text: "Overridding", link: "/zh/nixpkgs/overriding.md" },
              { text: "Overlays", link: "/zh/nixpkgs/overlays.md" },
            ],
          },
          {
            text: "NixOS 最佳实践",
            items: [
              { text: "简介", link: "/zh/best-practices/intro.md" },
              {
                text: "运行非 NixOS 的二进制文件",
                link: "/zh/best-practices/run-downloaded-binaries-on-nixos.md",
              },
              {
                text: "使用 Makefile 简化常用命令",
                link: "/zh/best-practices/simplify-nixos-related-commands.md",
              },
              {
                text: "使用 nix repl 查看源码、调试配置",
                link: "/zh/best-practices/debug-with-nix-repl.md",
              },
            ],
          },
          {
            text: "Flakes 的其他玩法",
            items: [
              { text: "介绍", link: "/zh/other-usage-of-flakes/intro.md" },
              {
                text: "Flake Inputs",
                link: "/zh/other-usage-of-flakes/inputs.md",
              },
              {
                text: "Flake Outputs",
                link: "/zh/other-usage-of-flakes/outputs.md",
              },
              {
                text: "The New CLI",
                link: "/zh/other-usage-of-flakes/the-new-cli.md",
              },
            ],
          },
          {
            text: "其他进阶话题",
            items: [{ text: "介绍", link: "/zh/advanced-topics/index.md" }],
          },
        ],

        socialLinks: [
          {
            icon: "github",
            link: "https://github.com/ryan4yin/nixos-and-flakes-book",
          },
        ],
      },
    },
  },
});