Skip to content

Commit c5e70a3

Browse files
author
hywax
committed
docs: ip api service
1 parent fe4a219 commit c5e70a3

7 files changed

Lines changed: 95 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ The basic concept of `Mafl` is to create not just a homepage, but to create an i
8989

9090
List of services:
9191
* **[Base](https://mafl.hywax.space/services/base.html)** - The main card of the service. Other services are created on the basis of this service.
92+
* **[IP API](https://mafl.hywax.space/services/ip-api.html)** - Shows information about your IP address.
9293

9394
## 🎨 Themes
9495

‎docs/.vitepress/locales/en.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ export default defineConfig({
4242
base: '/services',
4343
items: [
4444
{ text: 'Base', link: '/base' },
45+
{ text: 'IP API', link: '/ip-api' },
4546
],
4647
},
4748
{

‎docs/.vitepress/locales/ru.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ export default defineConfig({
4242
base: '/ru/services',
4343
items: [
4444
{ text: 'Базовый', link: '/base' },
45+
{ text: 'IP API', link: '/ip-api' },
4546
],
4647
},
4748
{
6.62 KB
Loading

‎docs/public/services/ip-api.png‎

6.95 KB
Loading

‎docs/ru/services/ip-api.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# IP API <in-version value="0.8.0" />
2+
3+
<preview-service name="ip-api" />
4+
5+
Показывает информацию о вашем IP адресе.
6+
7+
::: warning Настройка
8+
Здесь описаны только дополнительные поля. Сервис поддерживает все поля из [базового сервиса](base.md).
9+
:::
10+
11+
## Иконка флага
12+
13+
Иконка флага страны, в которой находится ваш IP адрес. В случае, если передать `false` то будет использоваться [базовая иконка](base.md#иконка).
14+
15+
```yaml
16+
options:
17+
flagIcon: true
18+
```
19+
20+
Поддерживаемые значения: `true`, `false`
21+
22+
Значение по умолчанию: `true`
23+
24+
## Примеры
25+
26+
### Базовый сервис
27+
28+
::: code-group
29+
```yaml [config.yml]
30+
services:
31+
- type: ip-api
32+
```
33+
:::
34+
35+
### Своя иконка
36+
37+
::: code-group
38+
```yaml [config.yml]
39+
services:
40+
- type: ip-api
41+
options:
42+
flagIcon: false
43+
icon:
44+
name: oui:token-ip
45+
```
46+
:::

‎docs/services/ip-api.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# IP API <in-version value="0.8.0" />
2+
3+
<preview-service name="ip-api" />
4+
5+
Shows information about your IP address.
6+
7+
::: warning Настройка
8+
There are only additional fields described here. The service supports all fields from the [base service](base.md).
9+
:::
10+
11+
## Flag icon
12+
13+
Icon of the country flag where your IP address is located. If you pass `false`, the [base icon](base.md#icon) will be used.
14+
15+
```yaml
16+
options:
17+
flagIcon: true
18+
```
19+
20+
Values: `true`, `false`
21+
22+
Default: `true`
23+
24+
## Examples
25+
26+
### Base service
27+
28+
::: code-group
29+
```yaml [config.yml]
30+
services:
31+
- type: ip-api
32+
```
33+
:::
34+
35+
### Custom icon
36+
37+
::: code-group
38+
```yaml [config.yml]
39+
services:
40+
- type: ip-api
41+
options:
42+
flagIcon: false
43+
icon:
44+
name: oui:token-ip
45+
```
46+
:::

0 commit comments

Comments
 (0)