linux-101/docusaurus.config.ts at main · krishnatejavedula/linux-101 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/**
 * Docusaurus Configuration File
 * Author: Krishna Teja Vedula
 * Description: Configuration for the Linux-101 Docusaurus website.
 *              Includes presets, theme customization, i18n, navbar, footer,
 *              syntax highlighting, and color modes.
 */

import { themes as prismThemes } from "prism-react-renderer";
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";

/* ================================================================
   1. SITE METADATA
   Basic information about the site (title, tagline, URLs, etc.)
   ================================================================ */
const config: Config = {
  title: "Linux-101",
  tagline: "A step-by-step guide for beginners to learn Linux.",
  favicon: "img/favicon.ico",

  url: "https://github.com",
  baseUrl: "/linux-101/",

  organizationName: "krishnatejavedula",
  projectName: "linux-101",

  future: {
    v4: true, // Enable compatibility with upcoming Docusaurus v4
  },

  /* ================================================================
     2. ERROR HANDLING
     How to handle broken links and markdown references
     ================================================================ */
  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",

  /* ================================================================
     3. INTERNATIONALIZATION (i18n)
     Default language and supported locales
     ================================================================ */
  i18n: {
    defaultLocale: "en",
    locales: ["en"],
  },

  /* ================================================================
     4. PRESETS
     Classic preset with docs, blog, and theme options
     ================================================================ */
  presets: [
    [
      "classic",
      {
        docs: {
          sidebarPath: "./sidebars.ts",
          sidebarCollapsible: true, // Allow categories to collapse
          sidebarCollapsed: true,   // Start categories collapsed
        },
        blog: {
          showReadingTime: true,
          feedOptions: {
            type: ["rss", "atom"],
            xslt: true,
          },
          onInlineTags: "warn",
          onInlineAuthors: "warn",
          onUntruncatedBlogPosts: "warn",
        },
        theme: {
          customCss: "./src/css/custom.css",
        },
      } satisfies Preset.Options,
    ],
  ],

  /* ================================================================
     5. THEME CONFIGURATION
     Navbar, footer, Prism syntax highlighting, and color modes
     ================================================================ */
  themeConfig: {
    image: "img/docusaurus-social-card.jpg",

    /* -------------------------------
       Navbar configuration
       ------------------------------- */
    navbar: {
      title: "Linux-101",
      logo: {
        alt: "Linux-101 Logo",
        src: "img/undraw_space-exploration.svg",
      },
      items: [
        {
          type: "docSidebar",
          sidebarId: "tutorialSidebar",
          position: "left",
          label: "Tutorials",
        },
        { to: "/blog", label: "Blog", position: "left" },
        {
          href: "https://github.com/krishnatejavedula/linux-101",
          label: "GitHub",
          position: "right",
        },
        {
          label: "Women in Physics",
          href: "https://www.involvement.mtu.edu/organization/wip",
          position: "left",
        },
      ],
    },

    /* -------------------------------
       Footer configuration
       ------------------------------- */
    footer: {
      style: "dark",
      copyright: `© ${new Date().getFullYear()} Linux-101. Made with Docusaurus`,
    },

    /* -------------------------------
       Prism syntax highlighting
       ------------------------------- */
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
    },

    /* -------------------------------
       Color mode settings
       ------------------------------- */
    colorMode: {
      defaultMode: "light",
      disableSwitch: false,
      respectPrefersColorScheme: true,
    },
  } satisfies Preset.ThemeConfig,
};

export default config;