feat(docs): migrate documentation site into monorepo (#5912)
This commit is contained in:
1 parent
3e464a76f2
commit
9e421c67bd
605 files changed
+26764
-219
No files matched your search
Binary file not shown.
|
After Width: | Height: | Size: 3.9 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 5.7 KiB |
@@ -0,0 +1,37 @@
|
||||
---
|
||||
title: 'App'
|
||||
description: 'Embeds an app into the board.'
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
import { AddingWidget } from '@site/src/components/widgets/adding';
|
||||
import { WidgetConfig } from '@site/src/components/widgets/configuration';
|
||||
import { WidgetHeader } from '@site/src/components/widgets/header';
|
||||
import { appWidget } from '.';
|
||||
|
||||
|
||||
<WidgetHeader
|
||||
widget={appWidget}
|
||||
categories={['Links', 'Apps']}
|
||||
/>
|
||||
|
||||
The app widget allows you to add a link to an application or a website that you want to access quickly from your Homarr board.
|
||||
It also supports a status check to indicate whether Homarr can reach the application or website.
|
||||
|
||||
### Screenshots
|
||||
|
||||
import githubApp from './img/github.png';
|
||||
import jellyseerrApp from './img/jellyseerr-description-tooltip.png';
|
||||
import piHoleApp from './img/pi-hole-ping-icon.png';
|
||||
|
||||
<div className='flex gap-1'>
|
||||
<img src={githubApp} alt="app github with-status-check" width={128 * 1.5} height={128 * 1.5} />
|
||||
<img src={piHoleApp} alt="app pi-hole with-status-check status-check-icon" width={128 * 1.5} height={128 * 1.5} />
|
||||
<img src={jellyseerrApp} alt="app jellyseerr with-description-tooltip" height={128 * 1.5} />
|
||||
</div>
|
||||
### Adding the widget
|
||||
|
||||
<AddingWidget />
|
||||
|
||||
### Configuration
|
||||
<WidgetConfig configuration={appWidget.configuration} />
|
||||
@@ -0,0 +1,52 @@
|
||||
import { WidgetDefinition } from "@site/src/types";
|
||||
import { IconApps } from "@tabler/icons-react";
|
||||
|
||||
export const appWidget: WidgetDefinition = {
|
||||
icon: IconApps,
|
||||
name: "App",
|
||||
description: "Embeds an app into the board.",
|
||||
path: "../../widgets/app",
|
||||
configuration: {
|
||||
items: [
|
||||
{
|
||||
name: "Choose app",
|
||||
description: "Select one of your created apps.",
|
||||
values: "App from your apps list",
|
||||
defaultValue: "-",
|
||||
},
|
||||
{
|
||||
name: "Open in new tab",
|
||||
description: "Whether to open the link in a new tab.",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show app name",
|
||||
description: "Whether to show the name of the app on the widget.",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Description display mode",
|
||||
description: "Choose how to display the app description",
|
||||
values: { type: "select", options: ["Within widget", "As tooltip", "Hidden"] },
|
||||
defaultValue: "Hidden",
|
||||
},
|
||||
{
|
||||
name: "Layout",
|
||||
description: "How to arrange the app widget.",
|
||||
values: {
|
||||
type: "select",
|
||||
options: ["Horizontal", "Horizontal (reversed)", "Vertical", "Vertical (reversed)"],
|
||||
},
|
||||
defaultValue: "Vertical",
|
||||
},
|
||||
{
|
||||
name: "Enable status check",
|
||||
description: "Whether to enable the status check for the app.",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
Reference in new issue
Block a user