Skip to content

Commit c2b0521

Browse files
Add logo
1 parent 6e3eb0a commit c2b0521

File tree

8 files changed

+49
-69
lines changed

8 files changed

+49
-69
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -2,53 +2,4 @@
22

33
Thank you for your interest in contributing to the Multi Theft Auto: Wiki. This guide will help you get started.
44

5-
## Getting Started
6-
7-
1. **Fork the Repository**
8-
- Click the "Fork" button at the top-right of this GitHub repository's page to create your own copy.
9-
10-
2. **Clone the Repository**
11-
- Clone your forked repository to your local machine ([tutorial](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)).
12-
13-
3. **Create a Branch**
14-
- Before making any changes, create a new branch to keep your work organized ([tutorial](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)).
15-
16-
## Editing Wiki Pages
17-
18-
The Wiki is generated by code, which relies on data present in this repository. Most text content uses the Markdown format. You can edit the files to make changes to the Wiki pages.
19-
20-
1. Navigate to the folder that contains the page you want to edit.
21-
22-
- Articles are defined in the [articles](/articles) folder.
23-
- Lua Functions are defined in the [functions](/functions) folder.
24-
- Lua Events are defined in the [events](/events) folder.
25-
- Lua Elements are defined in the [elements](/elements) folder.
26-
- Additional asset files can be stored in the [assets](/assets) folder.
27-
28-
2. Each folder may contain a `README.md` file with instructions or guidelines specific to the files in that directory. **Read these instructions carefully before making changes.**
29-
30-
3. Make your edits to the relevant file(s) using your preferred text editor.
31-
32-
## Testing Your Changes
33-
34-
Follow the provided instructions in the [`web/README.md`](/web/README.md) file.
35-
36-
## Submitting Your Changes
37-
38-
1. Commit your changes with a clear and descriptive message, e.g. `Add new article on scripting events`.
39-
40-
2. Push your branch to your forked repository.
41-
42-
3. Open a Pull Request:
43-
- Go to the original repository ([https://github.com/multitheftauto/mtasa-wiki](https://github.com/multitheftauto/mtasa-wiki)).
44-
- Click "Pull Requests" and then "New Pull Request."
45-
- Select your branch from your fork as the source and submit your pull request.
46-
47-
## Guidelines
48-
49-
- Follow the structure and formatting conventions used in the existing files.
50-
- Make sure your edits are clear, concise, and accurate.
51-
- Provide useful commit messages to explain your changes.
52-
- If you have questions or need clarification, open an issue or ask for help in your pull request.
53-
54-
We appreciate your contributions to improving the Multi Theft Auto: Wiki!
5+
TBA

web/astro.config.mjs

Lines changed: 40 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,55 @@ import mtasaStarlightThemePlugin from '@multitheftauto/starlight-theme-mtasa';
55

66
// https://astro.build/config
77
export default defineConfig({
8+
redirects: {
9+
"/wiki/[...slug]": "/[...slug]"
10+
},
811
integrations: [
912
starlight({
1013
plugins: [ mtasaStarlightThemePlugin() ],
1114
title: 'Multi Theft Auto: Wiki',
15+
logo: {
16+
replacesTitle: true,
17+
light: './src/assets/logo-black.png',
18+
dark: './src/assets/logo-white.png',
19+
},
1220
sidebar: [
1321
{
14-
slug: 'introduction',
22+
label: 'Start here',
23+
items: [
24+
{
25+
slug: 'introduction',
26+
},
27+
]
1528
},
1629
{
17-
label: 'Lua API Reference',
30+
label: 'Reference',
1831
items: [
19-
{slug: 'Client_Scripting_Functions'},
20-
{slug: 'Client_Scripting_Events'},
21-
{slug: 'Server_Scripting_Functions'},
22-
{slug: 'Server_Scripting_Events'},
23-
{slug: 'Shared_Scripting_Functions'},
24-
// {slug: 'Useful_Functions'},
25-
{slug: 'Element'},
26-
{slug: 'Element_tree'},
32+
{
33+
slug: 'Lua_API',
34+
},
35+
{
36+
label: 'Functions',
37+
items: [
38+
{slug: 'Client_Scripting_Functions'},
39+
{slug: 'Server_Scripting_Functions'},
40+
{slug: 'Shared_Scripting_Functions'},
41+
]
42+
},
43+
{
44+
label: 'Events',
45+
items: [
46+
{slug: 'Client_Scripting_Events'},
47+
{slug: 'Server_Scripting_Events'},
48+
]
49+
},
50+
{
51+
label: 'Elements',
52+
items: [
53+
{slug: 'Element'},
54+
{slug: 'Element_tree'},
55+
]
56+
},
2757
]
2858
},
2959
],

web/src/assets/logo-black.png

9.14 KB
Loading

web/src/assets/logo-white.png

3.09 KB
Loading

web/src/content/docs/index.mdx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,6 @@ hero:
1010
- text: Get Started
1111
link: /introduction
1212
icon: right-arrow
13-
- text: Visit the old Wiki
14-
link: https://wiki.multitheftauto.com
15-
icon: external
16-
variant: minimal
17-
attrs:
18-
target: _blank
1913
- text: Contribute on GitHub
2014
link: https://github.com/multitheftauto/wiki.multitheftauto.com
2115
icon: github

web/src/content/docs/reference/element_tree.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Element Tree
2+
title: Element tree
33
slug: Element_tree
44
---
55

web/src/content/docs/reference/elements.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
2-
title: MTA Elements
3-
description: Learn about the element system in MTA
2+
title: Element types
43
slug: Element
54
---
65

web/src/content/docs/reference/lua.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Lua API
3+
slug: Lua_API
4+
---
5+
6+
...

0 commit comments

Comments
 (0)