From e48286c910932b6d1208d035f6e9907b91d47d16 Mon Sep 17 00:00:00 2001 From: MivoDev Date: Sun, 18 Jan 2026 11:43:41 +0700 Subject: [PATCH] Update docs: template variables list, README, and LICENSE --- LICENSE | 21 +++++++++++++++++ README.md | 34 ++++++++++++++++++++++++++++ docs/manual/settings/templates.md | 7 +++++- id/docs/manual/settings/templates.md | 7 +++++- 4 files changed, 67 insertions(+), 2 deletions(-) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1a14372 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 DyzulkDev + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..db9084a --- /dev/null +++ b/README.md @@ -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). diff --git a/docs/manual/settings/templates.md b/docs/manual/settings/templates.md index 7c2e9ee..890f7c5 100644 --- a/docs/manual/settings/templates.md +++ b/docs/manual/settings/templates.md @@ -6,7 +6,12 @@ MIVO features a powerful template engine to create beautiful, printable vouchers Templates use HTML and specialized placeholders to display voucher data. -- **Variables**: `{{username}}`, `{{password}}`, `{{price}}`, etc. +- **Variables**: + - **Credentials**: `\{\{username\}\}`, `\{\{password\}\}` + - **Server**: `\{\{server_name\}\}`, `\{\{dns_name\}\}` + - **Plan**: `\{\{profile\}\}`, `\{\{price\}\}`, `\{\{validity\}\}`, `\{\{time_limit\}\}`, `\{\{data_limit\}\}` + - **Network**: `\{\{ip_address\}\}`, `\{\{mac_address\}\}` + - **Extras**: `\{\{comment\}\}`, `\{\{copyright\}\}`, `\{\{qrcode\}\}` (supports options like `size=100 fg=red`) - **Preview**: Test your template instantly from the editor. ## Quick Print diff --git a/id/docs/manual/settings/templates.md b/id/docs/manual/settings/templates.md index aeddd90..3b5f372 100644 --- a/id/docs/manual/settings/templates.md +++ b/id/docs/manual/settings/templates.md @@ -6,7 +6,12 @@ MIVO memiliki engine template yang mumpuni untuk membuat voucher yang cantik dan Template menggunakan HTML dan placeholder khusus untuk menampilkan data voucher. -- **Variabel**: `{{username}}`, `{{password}}`, `{{price}}`, dll. +- **Variabel**: + - **Kredensial**: `\{\{username\}\}`, `\{\{password\}\}` + - **Server**: `\{\{server_name\}\}`, `\{\{dns_name\}\}` + - **Paket**: `\{\{profile\}\}`, `\{\{price\}\}`, `\{\{validity\}\}`, `\{\{time_limit\}\}`, `\{\{data_limit\}\}` + - **Jaringan**: `\{\{ip_address\}\}`, `\{\{mac_address\}\}` + - **Ekstra**: `\{\{comment\}\}`, `\{\{copyright\}\}`, `\{\{qrcode\}\}` (mendukung opsi seperti `size=100 fg=red`) - **Preview**: Uji template Anda secara instan dari editor. ## Cetak Cepat