https://github.com/minestom/minestom.net

Minestom's website & docs located at minestom.net
https://github.com/minestom/minestom.net

Last synced: about 2 months ago
JSON representation

Minestom's website & docs located at minestom.net

• Host: GitHub
• URL: https://github.com/minestom/minestom.net
• Owner: Minestom
• Created: 2021-08-12T19:31:18.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-09-04T13:27:53.000Z (4 months ago)
• Last Synced: 2024-09-05T16:11:57.989Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 5.33 MB
• Stars: 2
• Watchers: 5
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [minestom.net](https://minestom.net)

This is the repository for the official Minestom website. Feel free to create PRs for submitting servers, updating documetation, or updating the website in general.

## Submitting a Server

### Requirements

- Must be using Minestom (obviously)

- Must be publicly available for review.

### Submitting a server

1. First, fork the website repository [here](https://github.com/Minestom/minestom.net).

2. Next, add your server markdown file under the `/showcase` directory. To store media, upload it to the `/public/showcase/(server)` directory. Please note that PRs with media too large may get rejected due to hosting constraints. If this is the case, you can use an alternate service such as Dropbox or Imgur to host the images. To use the images, use `![Image Alt](/showcase/(server)/(image)` in your markdown.

3. To add the server to the sidebar, edit `themeConfig.sidebar./showcase`, in `/.vitepress/config.mts`. An example can be seen in the config.

4. Finally, commit, push your changes, and make a pull request!

5. Wait for someone to review the PR and make any changes/updates.