Skip to content

Commit

Permalink
Homepage is now index.md, keeping legacy index.md for now. Added addi…
Browse files Browse the repository at this point in the history
…tional links in Homepage and will expand the homepage in the future.
  • Loading branch information
RainlessSky committed Aug 5, 2024
1 parent 13cad31 commit 20e723a
Show file tree
Hide file tree
Showing 7 changed files with 45 additions and 35 deletions.
1 change: 1 addition & 0 deletions docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export default defineConfig({
{ text: 'Multiplayer support', link: '/multiplayer.md' },
{ text: 'Resources and guides', link: '/resources.md', collapsed: true, items: [
{ text: 'Bare minimum map JSON', link: '/guides/bare_minimum.md' },
{ text: 'How to contribute', link: '/guides/how_to_contribute.md' },
{ text: 'Getting Started', link: '/guides/getting_started.md' },
{ text: 'Map making PDF', link: '/guides/pdf.md' },
{ text: 'Worldpainter to MagicaVoxel', link: '/guides/worldpainter.md' }
Expand Down
1 change: 1 addition & 0 deletions docs/.vitepress/theme/custom.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
:root {
--vp-c-brand-1: #1af7ff;
--vp-c-brand-2: #14c5cb;
}
5 changes: 5 additions & 0 deletions docs/guides/how_to_contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## How to contribute
If you wish to contribute to the map making documentation, whether it be a guide, new page, or edits to an existing page, follow the methods below. I, RainlessSky, am really the only person working on this and so its probably good to contact me for anonymous contributions.

* Make a fork of the `main` branch, do what you wish, make a pull request and we'll review it.
* If you want to contribute anonymously, contact me: @rainlesssky on Discord. Optionally include a commit message for me to include.
16 changes: 0 additions & 16 deletions docs/hero_test.md

This file was deleted.

33 changes: 21 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,24 @@
---
layout: home
title: Home Page
lastUpdated: false
---

This documentation aims to give useful information about map making in [Sector's Edge](https://store.steampowered.com/app/1024890/Sectors_Edge/). If you want to contribute, make a fork of the GitHub repo and submit a pull request.

[Getting Started](guides/getting_started.md)

[Json file](json.md)

[Game modes](json/gamemodes.md)

[Multiplayer support](multiplayer.md)

[Resources](resources.md)
hero:
name: Sector's Edge
text: Mapmaking Documentation
tagline: Opening up map making to everybody.
image: { light: se-docs-dark, dark: se-docs-light, alt?: Sector's Edge docs }
actions:
- theme: brand
text: Get started
link: /guides/getting_started.md
- theme: brand
text: Guides
link: /resources.md
- theme: brand
text: JSON file
link: /json.md
- theme: alt
text: Contribute
link: /guides/how_to_contribute.md
---
15 changes: 15 additions & 0 deletions docs/old_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
lastUpdated: false
---

This documentation aims to give useful information about map making in [Sector's Edge](https://store.steampowered.com/app/1024890/Sectors_Edge/). If you want to contribute, make a fork of the GitHub repo and submit a pull request.

[Getting Started](guides/getting_started.md)

[Json file](json.md)

[Game modes](json/gamemodes.md)

[Multiplayer support](multiplayer.md)

[Resources](resources.md)
9 changes: 2 additions & 7 deletions docs/resources.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Resources
This page offers helpful resources such as recognized Discord servers and community-written guides. The official maps are a great resource for the `json` file. However, **do not reupload official maps**!
This page offers helpful resources such as recognized Discord servers and community-written guides. The official maps are a great resource for the `json` file. However, **do not reupload official maps**! You can find guides in the sidebar to the left nested under this page.

### Links
Our community Discord server is great. (source: trust me bro) We organize events every now and then.<br/>
Expand All @@ -9,9 +9,4 @@ The official mapmaking Discord server is an awesome resource for the `json` file
[Official Mapmaking Discord server](https://discord.gg/sJA3cs4DEV)

Youtube Channel with MagicaVoxel Tutorials<br/>
[ArtChanny97](https://youtube.com/c/ArtChanny97)

### Guides
[World Painter to MagicaVoxel](/guides/worldpainter.md)<br/>
[Bare minimum map JSON](/guides/bare_minimum.md)<br/>
[Old Map making PDF](/guides/pdf.md)
[ArtChanny97](https://youtube.com/c/ArtChanny97)

0 comments on commit 20e723a

Please sign in to comment.