Skip to content

Commit 501e6f1

Browse files
authoredNov 1, 2023
Docusaurus V3 (#22)
* V3 Upgrade * Update docusaurus.config.ts with new theme and footer styling * Update variable documentation for time and touser * pkg lock
1 parent 9b70f55 commit 501e6f1

File tree

10 files changed

+4246
-4382
lines changed

10 files changed

+4246
-4382
lines changed
 

Diff for: ‎docs/chatbot/commands/default/timer.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ tags:
44
- chatbot
55
- commands
66
---
7+
78
# !timer
89

910
The `!timer` command is used to manage timers in the chat. It can enable or disable specific timers.

Diff for: ‎docs/chatbot/timers/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ Each timer can be configured with multiple messages, which will be cycled throug
1515

1616
The frequency of each timer can be set in minutes, determining how often it will be activated. Additionally, a minimum amount of chat lines that must be sent in the interval for the timer to be activated can be set, ensuring the timer only runs when chat activity is high enough.
1717

18-
You can find your timers here: <https://streamelements.com/dashboard/bot/timers>
18+
You can find your timers here: [Dashboard](https://streamelements.com/dashboard/bot/timers)

Diff for: ‎docs/chatbot/variables/time.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tags:
99

1010
## $(time.timezone)
1111

12-
Displays the time in the given timezone. A list can be found here: <https://nodatime.org/TimeZones>
12+
Displays the time in the given timezone. A list can be found here [Timezones](https://nodatime.org/TimeZones).
1313

1414
#### Parameters
1515

Diff for: ‎docs/chatbot/variables/touser.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tags:
77

88
# $(touser)
99

10-
Displays either the first word after the command $[1], or the sender’s name. This is an alias for ${1|sender}
10+
Displays either the first word after the command $[1], or the sender’s name. This is an alias for $(1|sender)
1111

1212
#### Parameters
1313

Diff for: ‎docusaurus.config.js

-125
This file was deleted.

Diff for: ‎docusaurus.config.ts

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
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+
5+
const config: Config = {
6+
title: "StreamElements Docs",
7+
tagline: "The official documentation for StreamElements",
8+
favicon: "/favicon.ico",
9+
10+
// Set the production url of your site here
11+
url: "https://docs.streamelements.com",
12+
// Set the /<baseUrl>/ pathname under which your site is served
13+
// For GitHub pages deployment, it is often '/<projectName>/'
14+
baseUrl: "/",
15+
trailingSlash: false,
16+
17+
// GitHub pages deployment config.
18+
// If you aren't using GitHub pages, you don't need these.
19+
organizationName: "StreamElements", // Usually your GitHub org/user name.
20+
projectName: "docs", // Usually your repo name.
21+
22+
onBrokenLinks: "throw",
23+
onBrokenMarkdownLinks: "warn",
24+
25+
// Even if you don't use internalization, you can use this field to set useful
26+
// metadata like html lang. For example, if your site is Chinese, you may want
27+
// to replace "en" with "zh-Hans".
28+
i18n: {
29+
defaultLocale: "en",
30+
locales: ["en"],
31+
},
32+
33+
plugins: [],
34+
35+
presets: [
36+
[
37+
"classic",
38+
{
39+
docs: {
40+
sidebarPath: "./sidebars.ts",
41+
editUrl: "https://github.com/Streamelements/docs/tree/master/",
42+
routeBasePath: "/",
43+
showLastUpdateAuthor: false,
44+
showLastUpdateTime: true,
45+
},
46+
blog: false,
47+
theme: {
48+
customCss: "./src/css/custom.css",
49+
},
50+
} satisfies Preset.Options,
51+
],
52+
],
53+
54+
themeConfig: {
55+
image: "img/open_graph_preview.jpg",
56+
navbar: {
57+
title: "StreamElements Docs",
58+
},
59+
metadata: [
60+
{
61+
name: "keywords",
62+
content:
63+
"StreamElements, Commands, Timers, Variables, Twitch, YouTube, Command Variables, Chatbot Modules, Chatbot Timers, Spam Filters, Documentation, Guides, Tutorials",
64+
},
65+
{ name: "twitter:card", content: "summary_large_image" },
66+
],
67+
headTags: [
68+
{
69+
tagName: 'link',
70+
attributes: {
71+
rel: 'preconnect',
72+
href: 'https://docs.streamelements.com',
73+
},
74+
},
75+
],
76+
colorMode: {
77+
respectPrefersColorScheme: true,
78+
defaultMode: "dark",
79+
},
80+
footer: {
81+
style: "dark",
82+
links: [
83+
{
84+
title: "Docs",
85+
items: [
86+
{
87+
label: "Getting Started",
88+
to: "/chatbot/gettingstarted/customcommands/creating",
89+
},
90+
{
91+
label: "Variables",
92+
to: "/chatbot/variables",
93+
},
94+
],
95+
},
96+
{
97+
title: "Community",
98+
items: [
99+
{
100+
label: "Twitch",
101+
href: "https://twitch.tv/StreamElements",
102+
},
103+
{
104+
label: "Discord",
105+
href: "https://discord.gg/se",
106+
},
107+
{
108+
label: "Twitter",
109+
href: "https://twitter.com/StreamElements",
110+
},
111+
],
112+
},
113+
{
114+
title: "More",
115+
items: [
116+
{
117+
label: "GitHub",
118+
href: "https://github.com/StreamElements",
119+
},
120+
],
121+
},
122+
],
123+
copyright: `Copyright © ${new Date().getFullYear()} StreamElements.`,
124+
},
125+
prism: {
126+
theme: prismThemes.github,
127+
darkTheme: prismThemes.dracula,
128+
},
129+
} satisfies Preset.ThemeConfig,
130+
};
131+
132+
export default config;

0 commit comments

Comments
 (0)
Please sign in to comment.