https://github.com/leavesmc/documentation

Documentation for all projects made by the LeavesMC team.
https://github.com/leavesmc/documentation

Last synced: about 2 months ago
JSON representation

Documentation for all projects made by the LeavesMC team.

• Host: GitHub
• URL: https://github.com/leavesmc/documentation
• Owner: LeavesMC
• License: agpl-3.0
• Created: 2024-02-13T06:18:27.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-04-12T18:38:03.000Z (9 months ago)
• Last Synced: 2024-04-13T00:18:15.742Z (9 months ago)
• Language: Vue
• Homepage: https://docs.leavesmc.org
• Size: 97.7 KB
• Stars: 3
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Documentation

Documentation for all projects made by the LeavesMC team.

## Getting Started

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

### Prerequisites

- [Node.js](https://nodejs.org)

- [Bun](https://bun.sh)

### Local Development

1. Clone the repository. If you plan to make changes, create a fork first!

```bash

git clone https://github.com/LeavesMC/Documentation.git

```

2. Install all required dependencies.

```bash

bun install

```

3. Start the development server

```bash

bun 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

```bash

bun run build

```

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

## License

The Leaves Documentation (e.g., `.md` files in the `/src` folder) is [CC-BY-SA-4.0](https://github.com/LeavesMC/Documentation/blob/main/LICENSE-DOCS) licensed.

The supporting code is

[AGPL-3.0](https://github.com/LeavesMC/Documentation/blob/main/LICENSE) licensed.

The LeavesMC logomark does not inherit a license from any of the projects it represents.