https://github.com/luminolmc/docs
Document for LuminolMC
https://github.com/luminolmc/docs
Last synced: 3 months ago
JSON representation
Document for LuminolMC
- Host: GitHub
- URL: https://github.com/luminolmc/docs
- Owner: LuminolMC
- License: agpl-3.0
- Created: 2024-04-14T07:57:48.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-30T06:13:11.000Z (10 months ago)
- Last Synced: 2025-01-09T09:33:01.205Z (5 months ago)
- Language: Vue
- Homepage:
- Size: 61.5 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Luminol docs **(Fork from [Leaves/Documentation](https://github.com/LeavesMC/Documentation))**
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org)
- [pnpm](https://pnpm.io/installation)
### Local Development
1. Clone the repository. If you plan to make changes, create a fork first!
```bash
git clone https://github.com/LuminolMC/docs.git
```
2. Install all required dependencies.
```bash
pnpm install
```
3. Start the development server
```bash
pnpm 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
```bash
pnpm 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 docs (e.g., `.md` files in the `/src` folder) is [CC-BY-SA-4.0](https://github.com/LuminolMC/docs/blob/main/LICENSE-DOCS) licensed.
The supporting code is
[AGPL-3.0](https://github.com/LuminolMC/docs/blob/main/LICENSE) licensed.