Skip to content

Commit f354033

Browse files
committed
changes
1 parent 7ce0050 commit f354033

4 files changed

Lines changed: 68 additions & 46 deletions

File tree

docusaurus.config.ts

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,47 @@ import {themes as prismThemes} from 'prism-react-renderer';
22
import type {Config} from '@docusaurus/types';
33
import type * as Preset from '@docusaurus/preset-classic';
44

5-
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
6-
75
const config: Config = {
86
title: 'Chezza Documentation',
97
tagline: 'Dokumentation & Guides',
108
favicon: 'img/favicon.ico',
119

12-
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
1310
future: {
14-
v4: true, // Improve compatibility with the upcoming Docusaurus v4
11+
v4: true,
1512
},
1613

17-
// Set the production url of your site here
1814
url: 'https://docu-chezza.musiker15.de',
19-
// Set the /<baseUrl>/ pathname under which your site is served
20-
// For GitHub pages deployment, it is often '/<projectName>/'
2115
baseUrl: '/',
2216

23-
// GitHub pages deployment config.
24-
// If you aren't using GitHub pages, you don't need these.
25-
organizationName: 'Chezza-Rework', // Usually your GitHub org/user name.
26-
projectName: 'chezza-documentation', // Usually your repo name.
17+
organizationName: 'Chezza-Rework',
18+
projectName: 'chezza-documentation',
2719

2820
onBrokenLinks: 'throw',
2921

30-
// Even if you don't use internationalization, you can use this field to set
31-
// useful metadata like html lang. For example, if your site is Chinese, you
32-
// may want to replace "en" with "zh-Hans".
3322
i18n: {
3423
defaultLocale: 'en',
3524
locales: ['en'],
3625
},
3726

27+
plugins: [
28+
[
29+
'@docusaurus/plugin-content-docs',
30+
{
31+
id: 'guides',
32+
path: 'guides',
33+
routeBasePath: 'guides',
34+
sidebarPath: './sidebars-guides.ts',
35+
editUrl: 'https://github.com/Chezza-Rework/chezza-documentation/tree/main/',
36+
},
37+
],
38+
],
39+
3840
presets: [
3941
[
4042
'classic',
4143
{
4244
docs: {
4345
sidebarPath: './sidebars.ts',
44-
// Please change this to your repo.
45-
// Remove this to remove the "edit this page" links.
4646
editUrl:
4747
'https://github.com/Chezza-Rework/chezza-documentation/tree/main/',
4848
},
@@ -55,7 +55,6 @@ const config: Config = {
5555
],
5656

5757
themeConfig: {
58-
// Replace with your project's social card
5958
image: 'img/chezza-social-card.jpg',
6059
colorMode: {
6160
defaultMode: 'dark',
@@ -75,11 +74,23 @@ const config: Config = {
7574
position: 'left',
7675
label: 'Dokumentation',
7776
},
77+
{
78+
type: 'docSidebar',
79+
sidebarId: 'guidesSidebar',
80+
docsPluginId: 'guides',
81+
position: 'left',
82+
label: 'Guides',
83+
},
7884
{
7985
href: 'https://www.chezza.dev',
8086
label: 'Dashboard',
8187
position: 'right',
8288
},
89+
{
90+
href: 'https://discord.com/invite/Cm9NNk2486',
91+
label: 'Discord',
92+
position: 'right',
93+
},
8394
],
8495
},
8596
footer: {
@@ -92,6 +103,10 @@ const config: Config = {
92103
label: 'Dokumentation',
93104
to: '/docs',
94105
},
106+
{
107+
label: 'Guides',
108+
to: '/guides',
109+
},
95110
],
96111
},
97112
{
@@ -104,9 +119,9 @@ const config: Config = {
104119
{
105120
label: 'Discord',
106121
href: 'https://discord.com/invite/Cm9NNk2486',
107-
}
122+
},
108123
],
109-
}
124+
},
110125
],
111126
copyright: `Copyright © ${new Date().getFullYear()} Chezza Rework`,
112127
},

guides/intro.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
sidebar_position: 1
3+
slug: /
4+
---
5+
6+
# Guides
7+
8+
Welcome to the Guides section of the Chezza Documentation.
9+
10+
Here you'll find step-by-step instructions, tips and best practices for Chezza resources — from initial setup to advanced customisation.
11+
12+
---
13+
14+
## What to expect
15+
16+
Guides go deeper than the pure API reference. Instead of individual events and exports, they show you how to accomplish common tasks from start to finish:
17+
18+
- **Setup & Configuration** — Get resources running and tailor them to your server
19+
- **Integration** — Connect Chezza scripts with other resources
20+
- **Customisation** — Icons, sounds, backgrounds and more
21+
22+
---
23+
24+
:::info
25+
New guides are added continuously. For questions and suggestions, join the [Discord](https://discord.com/invite/Cm9NNk2486).
26+
:::

sidebars-guides.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
2+
3+
const sidebars: SidebarsConfig = {
4+
guidesSidebar: [{ type: 'autogenerated', dirName: '.' }],
5+
};
6+
7+
export default sidebars;

sidebars.ts

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,7 @@
11
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
22

3-
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
4-
5-
/**
6-
* Creating a sidebar enables you to:
7-
- create an ordered group of docs
8-
- render a sidebar for each doc of that group
9-
- provide next/previous navigation
10-
11-
The sidebars can be generated from the filesystem, or explicitly defined here.
12-
13-
Create as many sidebars as you want.
14-
*/
153
const sidebars: SidebarsConfig = {
16-
// By default, Docusaurus generates a sidebar from the docs folder structure
17-
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
18-
19-
// But you can create a sidebar manually
20-
/*
21-
tutorialSidebar: [
22-
'intro',
23-
'hello',
24-
{
25-
type: 'category',
26-
label: 'Tutorial',
27-
items: ['tutorial-basics/create-a-document'],
28-
},
29-
],
30-
*/
4+
tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
315
};
326

337
export default sidebars;

0 commit comments

Comments
 (0)