Skip to content

Commit c3c1796

Browse files
authored
Merge pull request #6 from sfuosdev/issue_5/social-card
update social card
2 parents ab52d04 + 755ab86 commit c3c1796

File tree

2 files changed

+54
-56
lines changed

2 files changed

+54
-56
lines changed

Diff for: docusaurus.config.ts

+54-56
Original file line numberDiff line numberDiff line change
@@ -1,136 +1,134 @@
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";
44

55
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",
99

1010
// Set the production url of your site here
11-
url: 'https://sfuosdev.github.io',
11+
url: "https://sfuosdev.github.io",
1212
// Set the /<baseUrl>/ pathname under which your site is served
1313
// For GitHub pages deployment, it is often '/<projectName>/'
14-
baseUrl: '/Docs',
14+
baseUrl: "/Docs",
1515

1616
// GitHub pages deployment config.
1717
// 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",
2121

22-
onBrokenLinks: 'throw',
23-
onBrokenMarkdownLinks: 'warn',
22+
onBrokenLinks: "throw",
23+
onBrokenMarkdownLinks: "warn",
2424

2525
// Even if you don't use internationalization, you can use this field to set
2626
// useful metadata like html lang. For example, if your site is Chinese, you
2727
// may want to replace "en" with "zh-Hans".
2828
i18n: {
29-
defaultLocale: 'en',
30-
locales: ['en'],
29+
defaultLocale: "en",
30+
locales: ["en"],
3131
},
3232

3333
presets: [
3434
[
35-
'classic',
35+
"classic",
3636
{
3737
docs: {
38-
sidebarPath: './sidebars.ts',
38+
sidebarPath: "./sidebars.ts",
3939
// Please change this to your repo.
4040
// Remove this to remove the "edit this page" links.
41-
editUrl:
42-
'https://github.com/sfuosdev/Docs',
41+
editUrl: "https://github.com/sfuosdev/Docs",
4342
},
4443
blog: {
4544
showReadingTime: true,
4645
feedOptions: {
47-
type: ['rss', 'atom'],
46+
type: ["rss", "atom"],
4847
xslt: true,
4948
},
5049
// Please change this to your repo.
5150
// Remove this to remove the "edit this page" links.
52-
editUrl:
53-
'https://github.com/sfuosdev/Docs',
51+
editUrl: "https://github.com/sfuosdev/Docs",
5452
// 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",
5856
},
5957
theme: {
60-
customCss: './src/css/custom.css',
58+
customCss: "./src/css/custom.css",
6159
},
6260
} satisfies Preset.Options,
6361
],
6462
],
6563

6664
themeConfig: {
6765
// Replace with your project's social card
68-
image: 'img/docusaurus-social-card.jpg',
66+
image: "img/social-card.jpg",
6967
navbar: {
70-
title: 'OS Dev Documentation',
68+
title: "OS Dev Documentation",
7169
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",
7472
},
7573
items: [
7674
{
77-
type: 'docSidebar',
78-
sidebarId: 'tutorialSidebar',
79-
position: 'left',
80-
label: 'Tutorial',
75+
type: "docSidebar",
76+
sidebarId: "tutorialSidebar",
77+
position: "left",
78+
label: "Tutorial",
8179
},
8280
// {to: '/blog', label: 'Blog', position: 'left'},
8381
{
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",
8785
},
8886
{
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",
9290
},
9391
],
9492
},
9593
footer: {
96-
style: 'dark',
94+
style: "dark",
9795
links: [
9896
{
99-
title: 'Docs',
97+
title: "Docs",
10098
items: [
10199
{
102-
label: 'Tutorial',
103-
to: '/docs/intro',
100+
label: "Tutorial",
101+
to: "/docs/intro",
104102
},
105103
],
106104
},
107105
{
108-
title: 'Community',
106+
title: "Community",
109107
items: [
110108
{
111-
label: 'Instagram',
112-
href: 'https://www.instagram.com/sfu_osdev/',
109+
label: "Instagram",
110+
href: "https://www.instagram.com/sfu_osdev/",
113111
},
114112
{
115-
label: 'Discord',
116-
href: 'https://discord.gg/2xn6cTKGUq',
113+
label: "Discord",
114+
href: "https://discord.gg/2xn6cTKGUq",
117115
},
118116
{
119-
label: 'LinkedIn',
120-
href: 'https://www.linkedin.com/company/sfu-osdev',
117+
label: "LinkedIn",
118+
href: "https://www.linkedin.com/company/sfu-osdev",
121119
},
122120
],
123121
},
124122
{
125-
title: 'Helpful resources',
123+
title: "Helpful resources",
126124
items: [
127125
{
128-
label: 'Stack Overflow',
129-
href: 'https://stackoverflow.com',
126+
label: "Stack Overflow",
127+
href: "https://stackoverflow.com",
130128
},
131129
{
132-
label: 'GitHub',
133-
href: 'https://github.com',
130+
label: "GitHub",
131+
href: "https://github.com",
134132
},
135133
],
136134
},

Diff for: static/img/social-card.jpg

183 KB
Loading

0 commit comments

Comments
 (0)