Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
9aa3804
feat: major site improvements
muhdfdeen Oct 21, 2025
60b61d1
refactor: simplify project information items structure
muhdfdeen Oct 21, 2025
f45767d
refactor: standardize frontmatter across all documentation files
muhdfdeen Oct 21, 2025
f676717
fix: resolved issues with slug paths
muhdfdeen Oct 21, 2025
4c39ebb
refactor: update configuration and further restructure documentation
muhdfdeen Oct 21, 2025
8ad694d
refactor: plugin badges in astro config instead of frontmatter
muhdfdeen Oct 21, 2025
2528722
docs: badge text improvements
muhdfdeen Oct 21, 2025
a4b1b86
chore: more manual sidebar stuff
muhdfdeen Oct 21, 2025
7923e5d
refactor: utilize Astro Image component
muhdfdeen Oct 21, 2025
ddcdf10
refactor: move and simplify content config
muhdfdeen Oct 21, 2025
a73eb9a
refactor: remove slug as it is automatically generated based on file …
muhdfdeen Oct 21, 2025
9a4e52d
feat: organize asset structure with separate images and logos subfolders
muhdfdeen Oct 21, 2025
ef4e915
docs: improve README.md
muhdfdeen Oct 21, 2025
859caae
fix: attempt to correct logo path in README
muhdfdeen Oct 21, 2025
058a298
fix: second attempt to correct logo path in README
muhdfdeen Oct 21, 2025
363873b
fix: proper image sizing
muhdfdeen Oct 21, 2025
1bc064a
docs: remove heading in favor of new logo in README
muhdfdeen Oct 21, 2025
1dbf954
Merge branch 'setupmd:restructure' into restructure
muhdfdeen Oct 21, 2025
28d7094
feat: merge changes from origin nicely
muhdfdeen Oct 21, 2025
4f795e7
refactor: remove sidebar frontmatter options from MDX files
muhdfdeen Oct 22, 2025
f349feb
chore: rename intro MDX to index
muhdfdeen Oct 22, 2025
c7c49b0
chore: rearrange frontmatter properties
muhdfdeen Oct 22, 2025
8040440
docs: restructure topics
muhdfdeen Oct 24, 2025
3bda9fe
docs: restructure customise/plugins directory
muhdfdeen Oct 24, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,36 @@
# 📝 setup.md
<div align="center">

<picture>
<source media="(prefers-color-scheme: dark)" srcset="src/assets/logos/logo-light.svg" width="25%" height="25%">
<source media="(prefers-color-scheme: light)" srcset="src/assets/logos/logo-dark.svg" width="25%" height="25%">
<img alt="Minecraft Bookshelf" src="src/assets/logos/bookshelf.png" width="25%" height="25%">
</picture>

---

Welcome to the Minecraft server administration knowledgebase designed to provide accurate and meaningful data in one place.

</div>

## 👨‍💻 Contributing

- Contributions make the open source community such an amazing place to learn, inspire, and create.
- Any contributions you make are **truly appreciated**

## 💻 Development

1. Fork the project: Click the gray `Fork` button in the top right of this page. This creates _your_ copy of the project and saves it as a new repository in your github account
2. Click on the green `Code` button, then either the HTTPS or SSH option and, click the icon to copy the URL. Now you have a copy of the project. Thus, you can play around with it locally on your computer.
3. Run the following commands into a terminal window (Command Prompt, Powershell, Terminal, Git Bash, ZSH):
1. Fork the project: Click the gray `Fork` button in the top right of this page. This creates _your_ own copy of the project and saves it as a new repository in your GitHub account.
2. Run the following commands into a terminal window (Command Prompt, Powershell, Terminal, Git Bash, ZSH):

Do this to download the forked copy of this repository to your computer:

```bash
$ git clone https://github.com/setupmd/docs.git
git clone https://github.com/YOUR_GITHUB_USERNAME/docs.git
```

Step into the directory:
Step into the directory:
```bash
$ cd docs
cd docs
```

All commands are run from the root of the project, from a terminal:
Expand Down
Loading
Loading