MCDOC is a documentation project for Minecraft tools and unlockers

Overview

This documentation aims to provide comprehensive information and guides on various tools and unlockers for Minecraft.

Technologies Used

• VitePress: A static site generator that allows you to build and maintain your documentation easily.
• Markdown: A lightweight markup language that you can use to add formatting elements to plaintext text documents

Getting Started

To get started with MCDOC using VitePress, follow these steps:

1. Clone the repository: git clone https://github.com/openm-project/mcdoc.github.io.git
2. Navigate to the project directory: cd mcdoc.github.io
3. Install pnpm: npm install -g pnpm
4. Install Dependencies with pnpm: pmpm install
5. Start the internal server: pnpm run docs:dev
6. Open your browser and visit http://localhost:5173 to view your local hosted version of MCDOC.

Contributing

Contributions to MCDOC are welcome! If you have any suggestions, improvements, or bug fixes, please feel free to submit a pull request, or create an issue. For requesting to add a material to MCDOC is accepted!, please do a Pull Request for it.

License

This project is licensed under the MIT License. For more info, check out the LICENSE file.

Contact

For any questions or inquiries, please contact the project maintainer at [email protected]

Feedback

We value your feedback! If you have any suggestions, comments, or questions about the documentation, please don't hesitate to reach out to us. You can submit an issue on the GitHub repository or instead, you can contact us directly via our socials such as Discord.

We appreciate your support and hope you find MCDOC helpful for your Minecraft: Bedrock Edition projects, tips, and tricks!