|
1 | | -# Documentation |
2 | | -Documentation for all projects from jozelot_ and Frostleaf. |
| 1 | +# docs [](https://jozelot.de/discord) ![License] |
| 2 | + |
| 3 | +This is the repository for the official documentation of Jozelot's projects. |
| 4 | +Content is published to [docs.jozelot.de](https://docs.jozelot.de).<br> |
| 5 | +You can look into our code and-or modify it by forking it. |
| 6 | + |
| 7 | +## Getting Started |
| 8 | + |
| 9 | +How to get docs running on your local machine for development. |
| 10 | + |
| 11 | +### Prerequisites |
| 12 | + |
| 13 | +- [node 22](https://nodejs.org) |
| 14 | +- [npm](https://npm.io/installation) |
| 15 | + |
| 16 | +### Local Development |
| 17 | + |
| 18 | +1. Clone the repository. If you plan to make changes, create a fork first! |
| 19 | + |
| 20 | +```bash |
| 21 | +$ git clone https://github.com/FrostleafDev/docs |
| 22 | +``` |
| 23 | + |
| 24 | +2. Install all required dependencies. |
| 25 | + |
| 26 | +```bash |
| 27 | +$ npm install |
| 28 | +``` |
| 29 | + |
| 30 | +3. Start the development server. |
| 31 | + |
| 32 | +```bash |
| 33 | +$ npm run dev |
| 34 | +``` |
| 35 | + |
| 36 | +This will start a local development server and open a browser window. The majority of changes will |
| 37 | +be instantly reflected live without the need to restart the development server or reload the page in |
| 38 | +your browser. Edit away! |
| 39 | + |
| 40 | +### Building |
| 41 | + |
| 42 | +```bash |
| 43 | +$ npm run build |
| 44 | +``` |
| 45 | + |
| 46 | +This command builds a production-ready deployment into the `dist/` directory. These files are ready |
| 47 | +to be hosted on any static content server. |
| 48 | + |
| 49 | +## ❤️ Support the Project |
| 50 | +JManhunt is a passion project developed in our free time. If you want to support the development: |
| 51 | + |
| 52 | +* **Contribute:** Help us by reporting bugs or submitting pull requests. |
| 53 | +* **Community:** Join our [Discord](https://jozelot.de/discord) and share your feedback. |
| 54 | +* **Spread the word:** If you like the engine, tell your friends or share it on social media. |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +Proudly maintained by **jozelot_** & the **Frostleaf** team. |
0 commit comments