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: 16 KiB |
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: 'Anchor Note'
|
||||
description: 'Display and edit a selected note from Anchor'
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
import { WidgetHeader } from '@site/src/components/widgets/header';
|
||||
import { AddingWidget } from '@site/src/components/widgets/adding';
|
||||
import { WidgetConfig } from '@site/src/components/widgets/configuration';
|
||||
import { WidgetIntegrations } from '@site/src/components/widgets/integrations';
|
||||
import { anchorNoteWidget } from '.';
|
||||
import { anchorIntegration } from '@site/docs/integrations/anchor';
|
||||
|
||||
|
||||
<WidgetHeader
|
||||
widget={anchorNoteWidget}
|
||||
categories={['Notes']}
|
||||
/>
|
||||
|
||||
The Anchor Note widget shows a selected note from your Anchor integration. If your note permissions allow it, you can also edit the note title and content directly in Homarr.
|
||||
|
||||
### Screenshots
|
||||
|
||||
import anchorNoteWidgetScreenshot from './img/widget.png';
|
||||
|
||||
<img src={anchorNoteWidgetScreenshot} alt="anchor-note-widget" width={256} height={256} />
|
||||
|
||||
### Supported Integrations
|
||||
|
||||
<WidgetIntegrations items={[{
|
||||
integration: anchorIntegration
|
||||
}]} />
|
||||
|
||||
### Interactions
|
||||
|
||||
- Click **Edit** to start editing the selected note.
|
||||
- Click **Save** to persist changes to Anchor.
|
||||
- Click **Cancel** to discard unsaved changes.
|
||||
|
||||
### Adding the widget
|
||||
|
||||
<AddingWidget />
|
||||
|
||||
### Configuration
|
||||
|
||||
<WidgetConfig configuration={anchorNoteWidget.configuration} />
|
||||
@@ -0,0 +1,31 @@
|
||||
import { WidgetDefinition } from "@site/src/types";
|
||||
import { IconNotes } from "@tabler/icons-react";
|
||||
|
||||
export const anchorNoteWidget: WidgetDefinition = {
|
||||
icon: IconNotes,
|
||||
name: "Anchor Note",
|
||||
description: "Display and edit a selected note from Anchor",
|
||||
path: "../../widgets/anchor-note",
|
||||
configuration: {
|
||||
items: [
|
||||
{
|
||||
name: "Note",
|
||||
description: "Select the note from your Anchor integration to display in the widget.",
|
||||
values: "One of the notes from your Anchor integration",
|
||||
defaultValue: "-",
|
||||
},
|
||||
{
|
||||
name: "Show title",
|
||||
description: "Show the note title at the top of the widget.",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show last updated",
|
||||
description: "Show the relative last updated time of the note.",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
Reference in new issue
Block a user