Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mockbukkit/docs
Documentation for the Mockbukkit Project
https://github.com/mockbukkit/docs
docs mockbukkit vitepress
Last synced: 6 days ago
JSON representation
Documentation for the Mockbukkit Project
- Host: GitHub
- URL: https://github.com/mockbukkit/docs
- Owner: MockBukkit
- License: mit
- Created: 2024-10-20T20:02:05.000Z (28 days ago)
- Default Branch: main
- Last Pushed: 2024-11-08T19:54:04.000Z (9 days ago)
- Last Synced: 2024-11-08T20:35:04.759Z (9 days ago)
- Topics: docs, mockbukkit, vitepress
- Language: CSS
- Homepage: https://docs.mockbukkit.org/
- Size: 1.27 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Mockbukkit Docs
This repository is the place where you can find the code for all documentation
provided by the MockBukkit project. The repository is published under
[docs.mockbukkit.org](https://docs.mockbukkit.org).
## Getting started
This is how you can get started working on the docs on your local development
machine.
### Prerequisites
- [node](https://nodejs.org)
- [pnpm](https://pnpm.io/)
### Building
1. First, clone the repository:
```bash
git clone https://github.com/MockBukkit/docs.git
```
2. Then, install the dependencies:
```bash
pnpm install
```
3. Finally, run the server:
```bash
pnpm docs:dev // dev server
pnpm docs:build // build for production
```
In the case of building for production, the site will be generated in the
`.vitepress/dist` directory.
### Previewing
You can preview the site by running the following command:
```bash
pnpm docs:preview
```
This will start a local server on port 5173.
You can then access the site at .
## Contributing
Contributions are welcome! Please read the
[contribution guidelines](https://github.com/MockBukkit/docs/blob/main/CONTRIBUTING.md)
before submitting a pull request.
## License
The MockBukkit documentation is licensed under two licenses:
- Docs:
[Creative Commons Attribution-ShareAlike 4.0 International](https://github.com/MockBukkit/docs/blob/main/docs/LICENSE)
- Supporting Code:
- [MIT License](https://github.com/MockBukkit/docs/blob/main/LICENSE)