mirror of
https://github.com/mivodev/mivodev.github.io.git
synced 2026-01-26 13:32:07 +07:00
Update docs: template variables list, README, and LICENSE
This commit is contained in:
34
README.md
Normal file
34
README.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# MIVO Documentation
|
||||
|
||||
This repository hosts the source code for the official [MIVO Documentation](https://mivodev.github.io).
|
||||
|
||||
## Overview
|
||||
|
||||
MIVO (Mikrotik Voucher) is a modern, lightweight voucher management system. This documentation covers installation, configuration, and usage guides.
|
||||
|
||||
## Running Locally
|
||||
|
||||
This project uses [VitePress](https://vitepress.dev). To run the documentation locally:
|
||||
|
||||
1. **Install Dependencies**:
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
2. **Start Development Server**:
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
3. **Build**:
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions! Please see our [Contributing Guide](https://github.com/dyzulk/mivo/blob/main/CONTRIBUTING.md) for more details.
|
||||
|
||||
## License
|
||||
|
||||
Code released under the [MIT License](LICENSE).
|
||||
Reference in New Issue
Block a user