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
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: 'Paperless-ngx'
|
||||
description: 'Displays document management statistics including inbox ratio, document counts, and metadata.'
|
||||
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 { paperlessNgxWidget } from '.';
|
||||
import { paperlessNgxIntegration } from '@site/docs/integrations/paperless-ngx';
|
||||
|
||||
|
||||
<WidgetHeader
|
||||
widget={paperlessNgxWidget}
|
||||
categories={['Documents']}
|
||||
/>
|
||||
|
||||
This widget displays statistics from your Paperless-ngx instance, including an inbox ratio ring showing how many documents are in your inbox versus total, along with counts for correspondents, tags, and document types.
|
||||
|
||||
### Supported Integrations
|
||||
|
||||
<WidgetIntegrations items={[{
|
||||
integration: paperlessNgxIntegration,
|
||||
note: "Displays document statistics and inbox ratio"
|
||||
}]} />
|
||||
|
||||
### Adding the widget
|
||||
|
||||
<AddingWidget />
|
||||
|
||||
### Configuration
|
||||
<WidgetConfig configuration={paperlessNgxWidget.configuration} />
|
||||
@@ -0,0 +1,55 @@
|
||||
import { WidgetDefinition } from "@site/src/types";
|
||||
import { IconFileText } from "@tabler/icons-react";
|
||||
|
||||
export const paperlessNgxWidget: WidgetDefinition = {
|
||||
icon: IconFileText,
|
||||
name: "Paperless-ngx",
|
||||
description: "Displays document management statistics including inbox ratio, document counts, and metadata.",
|
||||
path: "../../widgets/paperless-ngx",
|
||||
configuration: {
|
||||
items: [
|
||||
{
|
||||
name: "Show inbox ratio",
|
||||
description: "Displays the inbox-to-total documents ratio as a hero section",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show inbox ring",
|
||||
description: "Displays a ring progress indicator for the inbox ratio",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show documents total",
|
||||
description: "Displays the total number of documents",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show documents inbox",
|
||||
description: "Displays the number of documents in the inbox",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show correspondents",
|
||||
description: "Displays the number of correspondents",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show tags",
|
||||
description: "Displays the number of tags",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show document types",
|
||||
description: "Displays the number of document types",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
Reference in new issue
Block a user