From 35f9f36671b7f6c63cc0ea58b2b13d81fcceea87 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 6 Nov 2023 14:29:46 -0800 Subject: [PATCH] Use image lightbox --- Pipfile | 1 + Pipfile.lock | 10 +++++++++- docs/index.md | 40 ++++++++++++++++++++-------------------- 3 files changed, 30 insertions(+), 21 deletions(-) diff --git a/Pipfile b/Pipfile index 876ff481c..2daf9c8b8 100644 --- a/Pipfile +++ b/Pipfile @@ -75,6 +75,7 @@ imagehash = "*" daphne = "*" # Documentation mkdocs-material = "*" +mkdocs-glightbox = "*" [typing-dev] mypy = "*" diff --git a/Pipfile.lock b/Pipfile.lock index 93cd8fa24..2f69422ae 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "3c380d590439f008ec85f1d5821ed96b4ebd56fcee3f287e6e0a6f5923262229" + "sha256": "50c21aa701dff7657a4d33764af7623e7ec19f4f3ba577cc8bab9b243b487838" }, "pipfile-spec": 6, "requires": {}, @@ -2746,6 +2746,14 @@ "markers": "python_version >= '3.7'", "version": "==1.5.3" }, + "mkdocs-glightbox": { + "hashes": [ + "sha256:8f894435b4f75231164e5d9fb023c01e922e6769e74a121e822c4914f310a41d", + "sha256:96aaf98216f83c0d0fad2e42a8d805cfa6329d6ab25b54265012ccb2154010d8" + ], + "index": "pypi", + "version": "==0.3.4" + }, "mkdocs-material": { "hashes": [ "sha256:3274a47a4e55a541b25bd8fa4937cf3f3c82a51763453511661e0052062758b9", diff --git a/docs/index.md b/docs/index.md index 456919706..3847b1d58 100644 --- a/docs/index.md +++ b/docs/index.md @@ -58,66 +58,66 @@ Paperless-ngx aims to be as nice to use as it is useful. Check out some screensh The dashboard shows saved views which can be sorted. Documents can be uploaded with the button or dropped anywhere in the application: -[![image](assets/screenshots/dashboard.png)](assets/screenshots/dashboard.png) +![image](assets/screenshots/dashboard.png) The document list provides three different styles to browser your documents: -[![image](assets/screenshots/documents-table.png)](assets/screenshots/documents-table.png) +![image](assets/screenshots/documents-table.png) -[![image](assets/screenshots/documents-smallcards.png)](assets/screenshots/documents-smallcards.png) +![image](assets/screenshots/documents-smallcards.png) -[![image](assets/screenshots/documents-largecards.png)](assets/screenshots/documents-largecards.png) +![image](assets/screenshots/documents-largecards.png) Use the 'slim' sidebar to focus on just your docs: -[![image](assets/screenshots/documents-smallcards-slimsidebar.png)](assets/screenshots/documents-smallcards-slimsidebar.png) +![image](assets/screenshots/documents-smallcards-slimsidebar.png) Paperless-ngx also supports dark mode: -[![image](assets/screenshots/documents-smallcards-dark.png)](assets/screenshots/documents-smallcards-dark.png) +![image](assets/screenshots/documents-smallcards-dark.png) Quickly find documents with extensive filtering mechanisms: -[![image](assets/screenshots/documents-filter.png)](assets/screenshots/documents-filter.png) +![image](assets/screenshots/documents-filter.png) Bulk edit document tags, correspondents, etc. as well as permissions: -[![image](assets/screenshots/bulk-edit.png)](assets/screenshots/bulk-edit.png) +![image](assets/screenshots/bulk-edit.png) Side-by-side editing of documents: -[![image](assets/screenshots/editing.png)](assets/screenshots/editing.png) +![image](assets/screenshots/editing.png) Support for custom fields: -[![image](assets/screenshots/custom_field1.png){: style="width:50%; margin-left: 25%"}](assets/screenshots/custom_field1.png) -[![image](assets/screenshots/custom_field2.png)](assets/screenshots/custom_field2.png) +![image](assets/screenshots/custom_field1.png){: style="width:50%; margin-left: 25%"} +![image](assets/screenshots/custom_field2.png) A robust permissions system with support for 'global' and document / object permissions: -[![image](assets/screenshots/permissions_global.png){: style="width:50%; margin-left: 25%"}](assets/screenshots/permissions_global.png) -[![image](assets/screenshots/permissions_document.png)](assets/screenshots/permissions_document.png) +![image](assets/screenshots/permissions_global.png){: style="width:50%; margin-left: 25%"} +![image](assets/screenshots/permissions_document.png) Tag editing. This looks about the same for correspondents and document types. -[![image](assets/screenshots/new-tag.png){: style="width:50%; margin-left: 25%"}](assets/screenshots/new-tag.png) +![image](assets/screenshots/new-tag.png){: style="width:50%; margin-left: 25%"} Searching provides auto complete and highlights the results. -[![image](assets/screenshots/search-preview.png){: style="width:50%; margin-left: 25%"}](assets/screenshots/search-preview.png) +![image](assets/screenshots/search-preview.png){: style="width:50%; margin-left: 25%"} -[![image](assets/screenshots/search-results.png)](assets/screenshots/search-results.png) +![image](assets/screenshots/search-results.png) Fancy mail filters! -[![image](assets/screenshots/mail-rules-edited.png){: style="width:80%; margin-left: 10%"}](assets/screenshots/mail-rules-edited.png) +![image](assets/screenshots/mail-rules-edited.png){: style="width:80%; margin-left: 10%"} Mobile devices are supported. -[![image](assets/screenshots/mobile1.png){: style="width:33%"}](assets/screenshots/mobile1.png) -[![image](assets/screenshots/mobile2.png){: style="width:33%"}](assets/screenshots/mobile2.png) -[![image](assets/screenshots/mobile3.png){: style="width:33%"}](assets/screenshots/mobile3.png) +![image](assets/screenshots/mobile1.png){: style="width:33%"} +![image](assets/screenshots/mobile2.png){: style="width:33%"} +![image](assets/screenshots/mobile3.png){: style="width:33%"} ## Support