Skip to content

Commit fd8c8e2

Browse files
Add WIP wiki structure
1 parent 2ccc07a commit fd8c8e2

File tree

6 files changed

+82
-0
lines changed

6 files changed

+82
-0
lines changed

articles/.gitkeep

Whitespace-only changes.

articles/getting-started.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Getting Started
2+
3+
This is the first article in the series. It will help you get started with the project.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Introduction to Scripting
2+
3+
Test

articles/introduction.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Introduction
2+
3+
Welcome to the Multi Theft Auto: Wiki website.
4+
5+
## This is the main page of the documentation
6+
7+
Test 123

navigation/structure.yaml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
wiki:
2+
# Homepage
3+
- title: "Introduction"
4+
description: "Welcome to the MTA Wiki"
5+
path: "/"
6+
article: "introduction"
7+
8+
# Guides Index
9+
- title: "Getting Started"
10+
description: "A guide to get you started with MTA"
11+
path: "/getting-started"
12+
article: "getting-started"
13+
children:
14+
- title: "Introduction to Scripting"
15+
path: "/guides/introduction-to-scripting"
16+
article: "guides/introduction-to-scripting"
17+
18+
# Reference Index
19+
- title: "Lua API Reference"
20+
path: "/lua"
21+
article: "lua"
22+
children:
23+
- title: "Client Functions"
24+
path: "/lua/client-functions"
25+
category: "Client functions"
26+
27+
- title: "Server Functions"
28+
path: "/lua/server-functions"
29+
category: "Server functions"
30+
31+
- title: "Shared Functions"
32+
path: "/lua/shared-functions"
33+
category: "Shared functions"

schemas/structure.yaml

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
$schema: "https://json-schema.org/draft/2020-12/schema"
2+
$id: "/schemas/structure"
3+
4+
title: "Wiki Navigation Schema"
5+
type: "array"
6+
items:
7+
$ref: "#/$defs/section"
8+
9+
$defs:
10+
section:
11+
type: "object"
12+
required:
13+
- title
14+
- path
15+
properties:
16+
title:
17+
type: "string"
18+
description: "The title of the section or article."
19+
description:
20+
type: "string"
21+
description: "A brief description of the section or article."
22+
path:
23+
type: "string"
24+
description: "The URL path for this section or article."
25+
article:
26+
type: "string"
27+
description: "The file or identifier of the corresponding article."
28+
pattern: "^[a-zA-Z0-9/_-]+$"
29+
category:
30+
type: "string"
31+
description: "The category name for the section."
32+
children:
33+
type: "array"
34+
description: "A list of subsections or subcategories."
35+
items:
36+
$ref: "#/$defs/section"

0 commit comments

Comments
 (0)