Skip to content

setupmd/docs

Repository files navigation

📝 setup.md

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

👨‍💻 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):

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

$ git clone https://github.com/setupmd/docs.git

Step into the directory:

$ cd docs

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

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run astro -- --help Get help using the Astro CLI

🙏 Thanks to all Contributors

Thanks a lot for spending your time in helping setup.md grow. Thanks a lot! ❤️

📑 License

Licensed under CC BY-NC-SA 4.0 DEED.

⭐️ One more thing

Don't forget to leave us a star ⭐️