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
|
|
|
|
|
|
2022-11-25 04:30:29 -08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| --------------------- | --------- | ------------------------------------------------------------------------- |
|
|
|
|
|
| `macos` | `string` | the string to use for macOS - defaults to `\uF179` |
|
|
|
|
|
| `linux` | `string` | the icon to use for Linux - defaults to `\uF17C` |
|
|
|
|
|
| `windows` | `string` | the icon to use for Windows - defaults to `\uE62A` |
|
|
|
|
|
| `display_distro_name` | `boolean` | display the distro name or icon (for WSL and Linux) - defaults to `false` |
|
|
|
|
|
| `alma` | `string` | the icon to use for Alma - defaults to `\uF31D` |
|
|
|
|
|
| `alpine` | `string` | the icon to use for Alpine - defaults to `\uF300` |
|
|
|
|
|
| `aosc` | `string` | the icon to use for Aosc - defaults to `\uF301` |
|
|
|
|
|
| `arch` | `string` | the icon to use for Arch - defaults to `\uF303` |
|
|
|
|
|
| `centos` | `string` | the icon to use for Centos - defaults to `\uF304` |
|
|
|
|
|
| `coreos` | `string` | the icon to use for Coreos - defaults to `\uF305` |
|
|
|
|
|
| `debian` | `string` | the icon to use for Debian - defaults to `\uF306` |
|
|
|
|
|
| `devuan` | `string` | the icon to use for Devuan - defaults to `\uF307` |
|
|
|
|
|
| `raspbian` | `string` | the icon to use for Raspbian - defaults to `\uF315` |
|
|
|
|
|
| `elementary` | `string` | the icon to use for Elementary - defaults to `\uF309` |
|
|
|
|
|
| `fedora` | `string` | the icon to use for Fedora - defaults to `\uF30a` |
|
|
|
|
|
| `gentoo` | `string` | the icon to use for Gentoo - defaults to `\uF30d` |
|
|
|
|
|
| `mageia` | `string` | the icon to use for Mageia - defaults to `\uF310` |
|
|
|
|
|
| `manjaro` | `string` | the icon to use for Manjaro - defaults to `\uF312` |
|
|
|
|
|
| `mint` | `string` | the icon to use for Mint - defaults to `\uF30e` |
|
|
|
|
|
| `nixos` | `string` | the icon to use for Nixos - defaults to `\uF313` |
|
|
|
|
|
| `opensuse` | `string` | the icon to use for Opensuse - defaults to `\uF314` |
|
|
|
|
|
| `redhat` | `string` | the icon to use for Redhat - defaults to `\uF316` |
|
|
|
|
|
| `rocky` | `string` | the icon to use for Rocky - defaults to `\uF32B` |
|
|
|
|
|
| `sabayon` | `string` | the icon to use for Sabayon - defaults to `\uF317` |
|
|
|
|
|
| `slackware` | `string` | the icon to use for Slackware - defaults to `\uF319` |
|
|
|
|
|
| `ubuntu` | `string` | the icon to use for Ubuntu - defaults to `\uF31b` |
|
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
|
