|
1 |
| -import {themes as prismThemes} from 'prism-react-renderer'; |
2 |
| -import type {Config} from '@docusaurus/types'; |
3 |
| -import type * as Preset from '@docusaurus/preset-classic'; |
| 1 | +import { themes as prismThemes } from "prism-react-renderer"; |
| 2 | +import type { Config } from "@docusaurus/types"; |
| 3 | +import type * as Preset from "@docusaurus/preset-classic"; |
4 | 4 |
|
5 | 5 | const config: Config = {
|
6 |
| - title: 'SFU OS Dev club Docs', |
7 |
| - tagline: 'Friendly documentation tool for OS Dev club', |
8 |
| - favicon: 'img/favicon.ico', |
| 6 | + title: "SFU OS Dev club Docs", |
| 7 | + tagline: "Friendly documentation tool for OS Dev club", |
| 8 | + favicon: "img/favicon.ico", |
9 | 9 |
|
10 | 10 | // Set the production url of your site here
|
11 |
| - url: 'https://sfuosdev.github.io', |
| 11 | + url: "https://sfuosdev.github.io", |
12 | 12 | // Set the /<baseUrl>/ pathname under which your site is served
|
13 | 13 | // For GitHub pages deployment, it is often '/<projectName>/'
|
14 |
| - baseUrl: '/Docs', |
| 14 | + baseUrl: "/Docs", |
15 | 15 |
|
16 | 16 | // GitHub pages deployment config.
|
17 | 17 | // If you aren't using GitHub pages, you don't need these.
|
18 |
| - organizationName: 'sfuosdev', // Usually your GitHub org/user name. |
19 |
| - projectName: 'Docs', // Usually your repo name. |
20 |
| - deploymentBranch: 'gh-pages', |
| 18 | + organizationName: "sfuosdev", // Usually your GitHub org/user name. |
| 19 | + projectName: "Docs", // Usually your repo name. |
| 20 | + deploymentBranch: "gh-pages", |
21 | 21 |
|
22 |
| - onBrokenLinks: 'throw', |
23 |
| - onBrokenMarkdownLinks: 'warn', |
| 22 | + onBrokenLinks: "throw", |
| 23 | + onBrokenMarkdownLinks: "warn", |
24 | 24 |
|
25 | 25 | // Even if you don't use internationalization, you can use this field to set
|
26 | 26 | // useful metadata like html lang. For example, if your site is Chinese, you
|
27 | 27 | // may want to replace "en" with "zh-Hans".
|
28 | 28 | i18n: {
|
29 |
| - defaultLocale: 'en', |
30 |
| - locales: ['en'], |
| 29 | + defaultLocale: "en", |
| 30 | + locales: ["en"], |
31 | 31 | },
|
32 | 32 |
|
33 | 33 | presets: [
|
34 | 34 | [
|
35 |
| - 'classic', |
| 35 | + "classic", |
36 | 36 | {
|
37 | 37 | docs: {
|
38 |
| - sidebarPath: './sidebars.ts', |
| 38 | + sidebarPath: "./sidebars.ts", |
39 | 39 | // Please change this to your repo.
|
40 | 40 | // Remove this to remove the "edit this page" links.
|
41 |
| - editUrl: |
42 |
| - 'https://github.com/sfuosdev/Docs', |
| 41 | + editUrl: "https://github.com/sfuosdev/Docs", |
43 | 42 | },
|
44 | 43 | blog: {
|
45 | 44 | showReadingTime: true,
|
46 | 45 | feedOptions: {
|
47 |
| - type: ['rss', 'atom'], |
| 46 | + type: ["rss", "atom"], |
48 | 47 | xslt: true,
|
49 | 48 | },
|
50 | 49 | // Please change this to your repo.
|
51 | 50 | // Remove this to remove the "edit this page" links.
|
52 |
| - editUrl: |
53 |
| - 'https://github.com/sfuosdev/Docs', |
| 51 | + editUrl: "https://github.com/sfuosdev/Docs", |
54 | 52 | // Useful options to enforce blogging best practices
|
55 |
| - onInlineTags: 'warn', |
56 |
| - onInlineAuthors: 'warn', |
57 |
| - onUntruncatedBlogPosts: 'warn', |
| 53 | + onInlineTags: "warn", |
| 54 | + onInlineAuthors: "warn", |
| 55 | + onUntruncatedBlogPosts: "warn", |
58 | 56 | },
|
59 | 57 | theme: {
|
60 |
| - customCss: './src/css/custom.css', |
| 58 | + customCss: "./src/css/custom.css", |
61 | 59 | },
|
62 | 60 | } satisfies Preset.Options,
|
63 | 61 | ],
|
64 | 62 | ],
|
65 | 63 |
|
66 | 64 | themeConfig: {
|
67 | 65 | // Replace with your project's social card
|
68 |
| - image: 'img/docusaurus-social-card.jpg', |
| 66 | + image: "img/social-card.jpg", |
69 | 67 | navbar: {
|
70 |
| - title: 'OS Dev Documentation', |
| 68 | + title: "OS Dev Documentation", |
71 | 69 | logo: {
|
72 |
| - alt: 'SFU OS Dev logo', |
73 |
| - src: 'img/oslogo_transparent.svg', |
| 70 | + alt: "SFU OS Dev logo", |
| 71 | + src: "img/oslogo_transparent.svg", |
74 | 72 | },
|
75 | 73 | items: [
|
76 | 74 | {
|
77 |
| - type: 'docSidebar', |
78 |
| - sidebarId: 'tutorialSidebar', |
79 |
| - position: 'left', |
80 |
| - label: 'Tutorial', |
| 75 | + type: "docSidebar", |
| 76 | + sidebarId: "tutorialSidebar", |
| 77 | + position: "left", |
| 78 | + label: "Tutorial", |
81 | 79 | },
|
82 | 80 | // {to: '/blog', label: 'Blog', position: 'left'},
|
83 | 81 | {
|
84 |
| - href: 'https://github.com/sfuosdev', |
85 |
| - label: 'OS Dev Github', |
86 |
| - position: 'right', |
| 82 | + href: "https://github.com/sfuosdev", |
| 83 | + label: "OS Dev Github", |
| 84 | + position: "right", |
87 | 85 | },
|
88 | 86 | {
|
89 |
| - href: 'https://go.sfss.ca/clubs/867/info', |
90 |
| - label: 'Join OS Dev', |
91 |
| - position: 'right', |
| 87 | + href: "https://go.sfss.ca/clubs/867/info", |
| 88 | + label: "Join OS Dev", |
| 89 | + position: "right", |
92 | 90 | },
|
93 | 91 | ],
|
94 | 92 | },
|
95 | 93 | footer: {
|
96 |
| - style: 'dark', |
| 94 | + style: "dark", |
97 | 95 | links: [
|
98 | 96 | {
|
99 |
| - title: 'Docs', |
| 97 | + title: "Docs", |
100 | 98 | items: [
|
101 | 99 | {
|
102 |
| - label: 'Tutorial', |
103 |
| - to: '/docs/intro', |
| 100 | + label: "Tutorial", |
| 101 | + to: "/docs/intro", |
104 | 102 | },
|
105 | 103 | ],
|
106 | 104 | },
|
107 | 105 | {
|
108 |
| - title: 'Community', |
| 106 | + title: "Community", |
109 | 107 | items: [
|
110 | 108 | {
|
111 |
| - label: 'Instagram', |
112 |
| - href: 'https://www.instagram.com/sfu_osdev/', |
| 109 | + label: "Instagram", |
| 110 | + href: "https://www.instagram.com/sfu_osdev/", |
113 | 111 | },
|
114 | 112 | {
|
115 |
| - label: 'Discord', |
116 |
| - href: 'https://discord.gg/2xn6cTKGUq', |
| 113 | + label: "Discord", |
| 114 | + href: "https://discord.gg/2xn6cTKGUq", |
117 | 115 | },
|
118 | 116 | {
|
119 |
| - label: 'LinkedIn', |
120 |
| - href: 'https://www.linkedin.com/company/sfu-osdev', |
| 117 | + label: "LinkedIn", |
| 118 | + href: "https://www.linkedin.com/company/sfu-osdev", |
121 | 119 | },
|
122 | 120 | ],
|
123 | 121 | },
|
124 | 122 | {
|
125 |
| - title: 'Helpful resources', |
| 123 | + title: "Helpful resources", |
126 | 124 | items: [
|
127 | 125 | {
|
128 |
| - label: 'Stack Overflow', |
129 |
| - href: 'https://stackoverflow.com', |
| 126 | + label: "Stack Overflow", |
| 127 | + href: "https://stackoverflow.com", |
130 | 128 | },
|
131 | 129 | {
|
132 |
| - label: 'GitHub', |
133 |
| - href: 'https://github.com', |
| 130 | + label: "GitHub", |
| 131 | + href: "https://github.com", |
134 | 132 | },
|
135 | 133 | ],
|
136 | 134 | },
|
|
0 commit comments