Skip to content

Commit

Permalink
update: better routes
Browse files Browse the repository at this point in the history
  • Loading branch information
Purple-CSGO committed Dec 22, 2023
1 parent c6cc9b7 commit 8f7c6c3
Show file tree
Hide file tree
Showing 41 changed files with 193 additions and 44 deletions.
4 changes: 2 additions & 2 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export default defineConfig({

nav: [
{ text: "Guides", link: "/guides/" },
{ text: "Tutorials", link: "/tutorials/" },
{ text: "Commands", link: "/commands/" },
{ text: "FAQ", link: "/faq/" },
{ text: "Blog", link: "/blog/" },
{ text: "Releases", link: "/releases/" },
Expand Down Expand Up @@ -114,7 +114,7 @@ export default defineConfig({
},
nav: [
{ text: "指南", link: "/zh-hans/guides/" },
{ text: "教程", link: "/zh-hans/tutorials/" },
{ text: "指令", link: "/zh-hans/commands/" },
{ text: "常见问题", link: "/zh-hans/faq/" },
{ text: "博客", link: "/zh-hans/blog/" },
{ text: "发布", link: "/zh-hans/releases/" },
Expand Down
65 changes: 47 additions & 18 deletions docs/.vitepress/sidebar.ts
Original file line number Diff line number Diff line change
@@ -1,30 +1,59 @@
import { DefaultTheme } from "vitepress";
import { generateSidebar } from "vitepress-sidebar";

// Common Options to reduce sidebar config
const common_options = {
documentRootPath: "/docs",
useTitleFromFrontmatter: true,
useTitleFromFileHeading: false,
sortMenusByFrontmatterOrder: true,
useFolderTitleFromIndexFile: true,
collapsed: true,
collapseDepth: 2,
};

// Auto Sidebar generation config
const sidebar = generateSidebar([
{
documentRootPath: "/docs",
...common_options,
scanStartPath: "",
resolvePath: "/",
useTitleFromFrontmatter: true,
useTitleFromFileHeading: false,
sortMenusByFrontmatterOrder: true,
useFolderTitleFromIndexFile: true,
collapsed: false,
collapseDepth: 2,
// ignore other language folders
excludeFolders: ["zh-hans", "zh-hant"],
excludeFolders: ["releases", "blog", "zh-hans", "zh-hant"],
},
{
...common_options,
scanStartPath: "releases",
resolvePath: "/releases/",
sortMenusOrderByDescending: true,
},
{
...common_options,
scanStartPath: "blog",
resolvePath: "/blog/",
sortMenusOrderByDescending: true,
},

// zh-hans: Simplified Chinese
{
...common_options,
documentRootPath: "/docs/zh-hans",
scanStartPath: "",
resolvePath: "/",
excludeFolders: ["releases", "blog"],
},
{
...common_options,
documentRootPath: "/docs/zh-hans",
scanStartPath: "releases",
resolvePath: "/releases/",
sortMenusOrderByDescending: true,
},
{
documentRootPath: "/docs",
scanStartPath: "zh-hans",
resolvePath: "/zh-hans/",
useTitleFromFrontmatter: true,
useTitleFromFileHeading: false,
sortMenusByFrontmatterOrder: true,
useFolderTitleFromIndexFile: true,
collapsed: true,
collapseDepth: 2,
...common_options,
documentRootPath: "/docs/zh-hans",
scanStartPath: "blog",
resolvePath: "/blog/",
sortMenusOrderByDescending: true,
},
// NOTE: Add more language support
]);
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar: false
sidebar: true
title: Blog
order: 50
---
File renamed without changes.
4 changes: 4 additions & 0 deletions docs/commands/AfxHookGoldSrc/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: AfxHookGoldSrc
---
# The main file
5 changes: 5 additions & 0 deletions docs/commands/AfxHookGoldSrc/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Intro
order: 10
---
# Counter Strike
File renamed without changes.
5 changes: 5 additions & 0 deletions docs/commands/AfxHookSource/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Intro
order: 10
---
# Counter Strike: Global Offensive
File renamed without changes.
File renamed without changes.
4 changes: 4 additions & 0 deletions docs/commands/AfxHookSource2/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: AfxHookSource2
---
# The main file
File renamed without changes.
5 changes: 5 additions & 0 deletions docs/commands/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Commands
order: 20
---
# Commands
6 changes: 6 additions & 0 deletions docs/guides/get_started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Get Started
order: 0
---

# Get Started
6 changes: 6 additions & 0 deletions docs/guides/help_translation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Help Translation
order: 9999
---

# Help Translation
5 changes: 3 additions & 2 deletions docs/guides/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Guide
title: Guides
order: 10
---
# The main file

# Guides
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ hero:
actions:
- theme: brand
text: Get Started
link: /guides/
link: /guides/get_started
- theme: alt
text: View on GitHub
link: https://github.com/advancedfx/advancedfx
Expand Down
2 changes: 2 additions & 0 deletions docs/releases/v0.0.0.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: v0.0.0
order: 0000000000
# v123.456.789.x => v123456789x
---

# v0.0.0
1 change: 1 addition & 0 deletions docs/releases/v0.0.1.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: v0.0.1
order: 000000001
---

# v0.0.1
1 change: 0 additions & 1 deletion docs/tutorials/demo.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/tutorials/index.md

This file was deleted.

5 changes: 5 additions & 0 deletions docs/zh-hans/blog/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar: true
title: Blog
order: 50
---
5 changes: 5 additions & 0 deletions docs/zh-hans/blog/start_up.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Start up
---

# New afx-doc site~
4 changes: 4 additions & 0 deletions docs/zh-hans/commands/AfxHookGoldSrc/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: AfxHookGoldSrc
---
# The main file
5 changes: 5 additions & 0 deletions docs/zh-hans/commands/AfxHookGoldSrc/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Intro
order: 10
---
# Counter Strike
4 changes: 4 additions & 0 deletions docs/zh-hans/commands/AfxHookSource/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: AfxHookSource2
---
# The main file
5 changes: 5 additions & 0 deletions docs/zh-hans/commands/AfxHookSource/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Intro
order: 10
---
# Counter Strike: Global Offensive
10 changes: 10 additions & 0 deletions docs/zh-hans/commands/AfxHookSource/mirv_campath.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: mirv_campath
order: 20
---

# mirv_campath

::: warning test
Testing
:::
9 changes: 9 additions & 0 deletions docs/zh-hans/commands/AfxHookSource/mirv_input.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: input
order: 30
---
# mirv_input

> Hello, world
`input everything`
4 changes: 4 additions & 0 deletions docs/zh-hans/commands/AfxHookSource2/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: AfxHookSource2
---
# The main file
5 changes: 5 additions & 0 deletions docs/zh-hans/commands/AfxHookSource2/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Intro
order: 10
---
# Counter Strike 2
5 changes: 5 additions & 0 deletions docs/zh-hans/commands/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Commands
order: 20
---
# Commands
4 changes: 4 additions & 0 deletions docs/zh-hans/faq/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: FAQ
order: 30
---
3 changes: 3 additions & 0 deletions docs/zh-hans/faq/vac.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


# VAC
6 changes: 6 additions & 0 deletions docs/zh-hans/guides/get_started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Get Started
order: 0
---

# Get Started
6 changes: 6 additions & 0 deletions docs/zh-hans/guides/help_translation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Help Translation
order: 9999
---

# Help Translation
5 changes: 4 additions & 1 deletion docs/zh-hans/guides/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Guides
---
order: 10
---

# Guides
12 changes: 0 additions & 12 deletions docs/zh-hans/guides/mirv_campath.md

This file was deleted.

4 changes: 4 additions & 0 deletions docs/zh-hans/releases/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Releases
order: 40
---
7 changes: 7 additions & 0 deletions docs/zh-hans/releases/v0.0.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: v0.0.0
order: 0000000000
# v123.456.789.x => v123456789x
---

# v0.0.0
6 changes: 6 additions & 0 deletions docs/zh-hans/releases/v0.0.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: v0.0.1
order: 000000001
---

# v0.0.1

0 comments on commit 8f7c6c3

Please sign in to comment.