diff --git a/.gitignore b/.gitignore index f27877cb..f4873f1b 100644 --- a/.gitignore +++ b/.gitignore @@ -24,6 +24,7 @@ memories.tar.gz /test-results/ /playwright-report/ /playwright/.cache/ +.cache/ exiftool-bin/ tools/ diff --git a/docs/config.md b/docs/config.md index 212c8d9e..34701dfb 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,3 +1,7 @@ +--- +description: Steps to configure Memories for the best experience and performance +--- + # Configuration Starting with v5.0.0, you can fully configure memories using the admin panel. With an admin account in Nextcloud, go to `Settings -> Memories`. Memories runs a background indexing job to extract EXIF metadata from photos and videos, as well as immediately on every upload. diff --git a/docs/faq.md b/docs/faq.md index a78a726e..e11e7bc9 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,3 +1,7 @@ +--- +description: Getting help with Memories +--- + # Help and FAQ ## Getting Help diff --git a/docs/file-types.md b/docs/file-types.md index ab2c343e..889b1c98 100644 --- a/docs/file-types.md +++ b/docs/file-types.md @@ -1,3 +1,7 @@ +--- +description: Steps to configure support for different image and video formats +--- + # File type support Memories supports the file types supported by the Nextcloud previews app. If you add support for any one of the file types below, you must run `occ memories:index` to index these files. diff --git a/docs/hw-transcoding.md b/docs/hw-transcoding.md index dac6d861..bdff21d1 100644 --- a/docs/hw-transcoding.md +++ b/docs/hw-transcoding.md @@ -1,3 +1,7 @@ +--- +description: Configuration for hardware acceleration for transcoding with VA-API and NVENC +--- + # Hardware transcoding Memories supports transcoding acceleration with VA-API and NVENC. diff --git a/docs/index.md b/docs/index.md index 1dbfb87f..260c59e7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,6 @@ --- title: Memories +description: Fast, modern and advanced photo management suite. Free and open source Nextcloud app. template: home.html hide: - navigation diff --git a/docs/install.md b/docs/install.md index d8b8fa99..d80095b1 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,3 +1,7 @@ +--- +description: Setting up Memories and Nextcloud +--- + # Installation This page describes how to install the latest version of Memories. diff --git a/docs/memories-vs-photos.md b/docs/memories-vs-photos.md index 22a9a1ca..76eaf0be 100644 --- a/docs/memories-vs-photos.md +++ b/docs/memories-vs-photos.md @@ -1,3 +1,7 @@ +--- +description: Comparison of Memories and Nextcloud Photos +--- + # Memories vs Photos Nextcloud comes bundled with an official "Photos" app. This page provides a brief feature comparison between Memories and Photos, and links some relevant issues in the Photos repository. diff --git a/docs/system-config.md b/docs/system-config.md index 2cdc8a8a..a2722a36 100644 --- a/docs/system-config.md +++ b/docs/system-config.md @@ -1,3 +1,7 @@ +--- +description: Documentation for config.php options that Memories uses +--- + # config.php options This is a list of all options in `config.php` that memories uses diff --git a/mkdocs.yml b/mkdocs.yml index 5b86cc09..8dabc59a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,6 +15,10 @@ theme: logo: material/camera custom_dir: docs/overrides +plugins: + - search + - social + nav: - Home: 'index.md' - Getting started: