Skip to content

Commit 8930e76

Browse files
authored
docs: update to latest docusaurus (#237)
1 parent 12b9788 commit 8930e76

10 files changed

Lines changed: 9022 additions & 10311 deletions

File tree

website/babel.config.js

Lines changed: 0 additions & 3 deletions
This file was deleted.

website/docs/authentication/authenticating-manually.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Authenticating Manually
22

3-
The most common auth flow that users interacting with PSN's APIs use is the manual authentication flow. This flow is also described in the [Quick Start guide](/#quick-start).
3+
The most common auth flow that users interacting with PSN's APIs use is the manual authentication flow. This flow is also described in the [Quick Start guide](/get-started#quick-start).
44

55
The disadvantage to this flow is that after two months you will need to remember to manually retrieve another NPSSO token to ultimately exchange for access and refresh tokens.
66

website/docusaurus.config.js

Lines changed: 0 additions & 113 deletions
This file was deleted.

website/docusaurus.config.ts

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
import type { Config } from "@docusaurus/types";
2+
import type * as Preset from "@docusaurus/preset-classic";
3+
import { themes as prismThemes } from "prism-react-renderer";
4+
5+
const config: Config = {
6+
title: "psn-api",
7+
tagline: "Dinosaurs are cool",
8+
url: "https://psn-api.achievements.app",
9+
baseUrl: "/",
10+
onBrokenLinks: "throw",
11+
favicon: "img/favicon.ico",
12+
organizationName: "achievements.app",
13+
projectName: "psn-api",
14+
15+
markdown: {
16+
format: "detect"
17+
},
18+
19+
scripts: [
20+
{
21+
src: "https://plausible.io/js/plausible.js",
22+
defer: true,
23+
"data-domain": "psn-api.achievements.app"
24+
}
25+
],
26+
27+
presets: [
28+
[
29+
"classic",
30+
{
31+
docs: {
32+
sidebarPath: "./sidebars.ts",
33+
routeBasePath: "/",
34+
editUrl:
35+
"https://github.com/achievements-app/psn-api/edit/main/website/",
36+
37+
remarkPlugins: [
38+
[require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }]
39+
]
40+
},
41+
theme: {
42+
customCss: "./src/css/custom.css"
43+
},
44+
sitemap: {
45+
changefreq: "weekly",
46+
priority: 0.5
47+
}
48+
} satisfies Preset.Options
49+
]
50+
],
51+
52+
themeConfig: {
53+
navbar: {
54+
title: "psn-api",
55+
56+
items: [
57+
{
58+
type: "doc",
59+
docId: "get-started",
60+
position: "left",
61+
label: "Quick start"
62+
},
63+
{
64+
href: "https://github.com/achievements-app/psn-api",
65+
label: "GitHub",
66+
position: "right"
67+
}
68+
]
69+
},
70+
71+
footer: {
72+
style: "dark",
73+
links: [
74+
{
75+
title: "Community",
76+
items: [
77+
{
78+
label: "Twitter",
79+
href: "https://twitter.com/wescopeland_"
80+
}
81+
]
82+
},
83+
{
84+
title: "More",
85+
items: [
86+
{
87+
label: "GitHub",
88+
href: "https://github.com/achievements-app/psn-api"
89+
}
90+
]
91+
}
92+
],
93+
copyright: `Copyright © ${new Date().getFullYear()} achievements.app.`
94+
},
95+
96+
prism: {
97+
theme: prismThemes.github,
98+
darkTheme: prismThemes.dracula
99+
},
100+
101+
algolia: {
102+
appId: "BH4D9OD16A",
103+
apiKey: "2ce8bc4c877d89ada212a38523a0d4d0",
104+
indexName: "psn-api"
105+
}
106+
} satisfies Preset.ThemeConfig
107+
};
108+
109+
export default config;

website/package.json

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "website-2",
2+
"name": "website",
33
"version": "0.0.0",
44
"private": true,
55
"scripts": {
@@ -15,23 +15,20 @@
1515
"typecheck": "tsc"
1616
},
1717
"dependencies": {
18-
"@docusaurus/core": "^2.0.0-beta.9",
19-
"@docusaurus/preset-classic": "^2.0.0-beta.9",
20-
"@docusaurus/remark-plugin-npm2yarn": "^2.0.0-beta.9",
21-
"@docusaurus/theme-search-algolia": "^2.0.0-beta.9",
22-
"@mdx-js/react": "^1.6.21",
23-
"@svgr/webpack": "^5.5.0",
24-
"clsx": "^1.2.1",
25-
"file-loader": "^6.2.0",
26-
"prism-react-renderer": "^1.3.5",
27-
"react": "^17.0.1",
28-
"react-dom": "^17.0.1",
29-
"url-loader": "^4.1.1"
18+
"@docusaurus/core": "^3.7.0",
19+
"@docusaurus/preset-classic": "^3.7.0",
20+
"@docusaurus/remark-plugin-npm2yarn": "^3.7.0",
21+
"@docusaurus/theme-search-algolia": "^3.7.0",
22+
"@mdx-js/react": "^3.1.0",
23+
"clsx": "^2.1.1",
24+
"prism-react-renderer": "^2.4.1",
25+
"react": "^18.3.1",
26+
"react-dom": "^18.3.1"
3027
},
3128
"devDependencies": {
32-
"@docusaurus/module-type-aliases": "^2.0.0-beta.9",
33-
"@tsconfig/docusaurus": "^1.0.6",
34-
"typescript": "^4.7.4"
29+
"@docusaurus/module-type-aliases": "^3.7.0",
30+
"@docusaurus/tsconfig": "^3.7.0",
31+
"typescript": "^5.7.0"
3532
},
3633
"browserslist": {
3734
"production": [

0 commit comments

Comments
 (0)