Skip to content

FrostleafDev/docs

Repository files navigation

docs Discord License

The docs page is highly insperated by the PaperMC docs page

This is the repository for the official documentation of Jozelot's projects. Content is published to docs.jozelot.de.
You can look into our code and-or modify it by forking it.

Getting Started

How to get docs running on your local machine for development.

Prerequisites

Local Development

  1. Clone the repository. If you plan to make changes, create a fork first!
$ git clone https://github.com/FrostleafDev/docs
  1. Install all required dependencies.
$ npm install
  1. Start the development server.
$ npm run dev

This will start a local development server and open a browser window. The majority of changes will be instantly reflected live without the need to restart the development server or reload the page in your browser. Edit away!

Building

$ npm run build

This command builds a production-ready deployment into the dist/ directory. These files are ready to be hosted on any static content server.

❤️ Support the Project

If you want to support the development:

  • Contribute: Help us by reporting bugs or submitting pull requests.
  • Community: Join our Discord and share your feedback.
  • Spread the word: If you like the engine, tell your friends or share it on social media.

Proudly maintained by jozelot_ & the Frostleaf team.