2020-10-07 12:01:03 -07:00
|
|
|
---
|
|
|
|
|
id: os
|
2022-05-16 08:20:03 -07:00
|
|
|
title: OS
|
2020-10-07 12:01:03 -07:00
|
|
|
sidebar_label: OS
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## What
|
|
|
|
|
|
2021-11-20 02:14:26 -08:00
|
|
|
Display OS specific info - defaults to Icon.
|
2020-10-07 12:01:03 -07:00
|
|
|
|
|
|
|
|
## Sample Configuration
|
|
|
|
|
|
2023-03-31 11:55:36 -07:00
|
|
|
import Config from '@site/src/components/Config.js';
|
|
|
|
|
|
|
|
|
|
<Config data={{
|
2020-10-07 12:01:03 -07:00
|
|
|
"type": "os",
|
|
|
|
|
"style": "plain",
|
|
|
|
|
"foreground": "#26C6DA",
|
|
|
|
|
"background": "#546E7A",
|
2022-03-27 01:12:47 -07:00
|
|
|
"template": " {{ if .WSL }}WSL at {{ end }}{{.Icon}}\uE0B1",
|
2020-10-07 12:01:03 -07:00
|
|
|
"properties": {
|
|
|
|
|
"macos": "mac"
|
|
|
|
|
}
|
2023-03-31 11:55:36 -07:00
|
|
|
}}/>
|
2020-10-07 12:01:03 -07:00
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
|
2024-05-09 02:28:52 -07:00
|
|
|
| Name | Type | Default | Description |
|
|
|
|
|
| --------------------- | :-------: | :------: | -------------------------------------------------------- |
|
|
|
|
|
| `macos` | `string` | `\uF179` | the string to use for macOS |
|
|
|
|
|
| `linux` | `string` | `\uF17C` | the icon to use for Linux |
|
|
|
|
|
| `windows` | `string` | `\uE62A` | the icon to use for Windows |
|
|
|
|
|
| `display_distro_name` | `boolean` | `false` | display the distro name instead of icon for Linux or WSL |
|
|
|
|
|
| `alma` | `string` | `\uF31D` | the icon to use for AlmaLinux OS |
|
|
|
|
|
| `almalinux` | `string` | `\uF31D` | the icon to use for AlmaLinux OS |
|
|
|
|
|
| `almalinux9` | `string` | `\uF31D` | the icon to use for AlmaLinux OS 9 |
|
|
|
|
|
| `alpine` | `string` | `\uF300` | the icon to use for Alpine Linux |
|
|
|
|
|
| `android` | `string` | `\uF17b` | the icon to use for Android |
|
|
|
|
|
| `aosc` | `string` | `\uF301` | the icon to use for AOSC OS |
|
|
|
|
|
| `arch` | `string` | `\uF303` | the icon to use for Arch Linux |
|
|
|
|
|
| `centos` | `string` | `\uF304` | the icon to use for CentOS |
|
|
|
|
|
| `coreos` | `string` | `\uF305` | the icon to use for CoreOS Container Linux |
|
|
|
|
|
| `debian` | `string` | `\uF306` | the icon to use for Debian |
|
|
|
|
|
| `deepin` | `string` | `\uF321` | the icon to use for deepin |
|
|
|
|
|
| `devuan` | `string` | `\uF307` | the icon to use for Devuan GNU+Linux |
|
|
|
|
|
| `elementary` | `string` | `\uF309` | the icon to use for elementary OS |
|
2024-06-14 23:36:20 -07:00
|
|
|
| `endeavouros` | `string` | `\uF322` | the icon to use for EndeavourOS |
|
2024-05-09 02:28:52 -07:00
|
|
|
| `fedora` | `string` | `\uF30a` | the icon to use for Fedora |
|
|
|
|
|
| `gentoo` | `string` | `\uF30d` | the icon to use for Gentoo Linux |
|
|
|
|
|
| `mageia` | `string` | `\uF310` | the icon to use for Mageia |
|
|
|
|
|
| `manjaro` | `string` | `\uF312` | the icon to use for Manjaro Linux |
|
|
|
|
|
| `mint` | `string` | `\uF30e` | the icon to use for Linux Mint |
|
|
|
|
|
| `nixos` | `string` | `\uF313` | the icon to use for NixOS |
|
|
|
|
|
| `opensuse` | `string` | `\uF314` | the icon to use for openSUSE |
|
|
|
|
|
| `opensuse-tumbleweed` | `string` | `\uF314` | the icon to use for openSUSE Tumbleweed |
|
|
|
|
|
| `raspbian` | `string` | `\uF315` | the icon to use for Raspberry Pi OS (Raspbian) |
|
|
|
|
|
| `redhat` | `string` | `\uF316` | the icon to use for Red Hat Enterprise Linux (RHEL) |
|
|
|
|
|
| `rocky` | `string` | `\uF32B` | the icon to use for Rocky Linux |
|
|
|
|
|
| `sabayon` | `string` | `\uF317` | the icon to use for Sabayon |
|
|
|
|
|
| `slackware` | `string` | `\uF319` | the icon to use for Slackware Linux |
|
|
|
|
|
| `ubuntu` | `string` | `\uF31b` | the icon to use for Ubuntu |
|
2021-04-24 12:31:56 -07:00
|
|
|
|
2022-02-01 03:10:46 -08:00
|
|
|
## Template ([info][templates])
|
2021-04-24 12:31:56 -07:00
|
|
|
|
2022-02-01 03:10:46 -08:00
|
|
|
:::note default template
|
|
|
|
|
|
2022-09-16 07:32:48 -07:00
|
|
|
```template
|
2022-02-01 03:10:46 -08:00
|
|
|
{{ if .WSL }}WSL at {{ end }}{{.Icon}}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
### Properties
|
|
|
|
|
|
2022-09-16 07:32:48 -07:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| ------- | -------- | ----------- |
|
|
|
|
|
| `.Icon` | `string` | the OS icon |
|
2022-01-22 10:46:56 -08:00
|
|
|
|
2022-04-20 09:43:59 -07:00
|
|
|
[templates]: /docs/configuration/templates
|
