Skip to content

Feature: Update to docusaurus 3.10.0 #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
infeo wants to merge 8 commits into
base: develop
Choose a base branch
from
Open

Feature: Update to docusaurus 3.10.0 #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3c2e753
Update docusaurus to version 3.10.0
infeo Apr 27, 2026
6624439
Migrate to new heading ID syntax
infeo Apr 28, 2026
717e1b9
migrate to JSX comments
infeo Apr 28, 2026
06d919f
migrate to markdown directive admonitions
infeo Apr 28, 2026
a91fbfd
Migrate internal doc links to new file extension
infeo Apr 28, 2026
3a13697
Migrate files to new file extension
infeo Apr 28, 2026
7f95823
Enable docusaurus faster mode
infeo Apr 28, 2026
caf1bf5
update package-lock.json
infeo Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/update-windows-info.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ jobs:

Set-Content -Path $DocPath -Value $Content
env:
AUTOMATION_MARKER: '<!-- AUTOMATION MARKER FOR WORKFLOW -->'
AUTOMATION_MARKER: '{/* AUTOMATION MARKER FOR WORKFLOW */}'
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify which verify-installers file exists and what path the workflow uses.

fd -a '^verify-installers\.(md|mdx)$' docs/security
rg -n -C2 'verify-installers\.(md|mdx)' .github/workflows/update-windows-info.yml

Repository: cryptomator/docs

Length of output: 1571

Update workflow to reference verify-installers.mdx instead of .md.

The file exists as verify-installers.mdx but the workflow references verify-installers.md in multiple locations (lines 1, 41, 46, 52, 58, 74). The workflow will fail when attempting to read or write the non-existent .md file.

Update all references:

  • Line 1: Workflow name
  • Line 41: Step name
  • Line 46: $DocPath variable assignment
  • Line 52 & 58: Error messages
  • Line 74: git stage command
Proposed fix 
-name: Updates verify-installers.md after desktop release
+name: Updates verify-installers.mdx after desktop release
 
-      - name: Update verify-installers.md
+      - name: Update verify-installers.mdx
         shell: pwsh
         run: |
           $Thumbprint = (Get-AuthenticodeSignature -FilePath 'cryptomator.msi' -ErrorAction Stop).SignerCertificate.Thumbprint
 
-          $DocPath = 'docs/security/verify-installers.md'
+          $DocPath = 'docs/security/verify-installers.mdx'
           $Content = Get-Content -Path $DocPath -Raw
 
           $UpdatedContent = $CurrentThumbprintRegex.Replace($Content, ($env:AUTOMATION_MARKER + '`' + $Thumbprint + '`'), 1)
           if ($UpdatedContent -eq $Content) {
-            throw 'Failed to update the current Windows thumbprint in verify-installers.md.'
+            throw 'Failed to update the current Windows thumbprint in verify-installers.mdx.'
           }
           $Content = $UpdatedContent
 
           $MarkedRow = (Get-Content -Path $DocPath | Where-Object { $_.TrimStart().StartsWith('|') -and $_.Contains($env:AUTOMATION_MARKER) } | Select-Object -First 1)
           if ($null -eq $MarkedRow) {
-            throw 'Failed to find the marked Windows certificate table row in verify-installers.md.'
+            throw 'Failed to find the marked Windows certificate table row in verify-installers.mdx.'
           }
 
-          git stage docs/security/verify-installers.md
+          git stage docs/security/verify-installers.mdx
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/update-windows-info.yml at line 67, Update the workflow to
reference the correct file name verify-installers.mdx everywhere it currently
uses verify-installers.md: change the workflow name string, the step name that
mentions the document, the $DocPath assignment (set to verify-installers.mdx),
both error message strings that mention the .md filename, and the git stage
command to stage verify-installers.mdx instead of the .md file so all steps
(step names, $DocPath variable, error messages, and the git add/git stage
invocation) consistently point to verify-installers.mdx.

- name: Commit and push
id: commit-and-push
run: |
Expand Down
24 changes: 12 additions & 12 deletions docs/android/access-vault.md → docs/android/access-vault.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 4

This section shows you how to work with a vault like view its content, move files or access it with other applications.

## Unlock Vault {#unlock-vault}
## Unlock Vault {/* #unlock-vault */}

If you want to access the data inside a vault, you have to unlock it by selecting it.

Expand All @@ -32,7 +32,7 @@ After providing the credentials, the vault gets unlocked and opened.

You're now able to edit the content of the vault.

## Lock Vault {#lock-vault}
## Lock Vault {/* #lock-vault */}

To lock an unlocked vault, there are several ways to do this:

Expand All @@ -57,7 +57,7 @@ All of the possibilities will result in the locked vault.
The auto-lock timeout specified in the settings will lock the vault if Cryptomator is in background. Furthermore if not changed in settings, the vault gets locked if the screen turns off.
:::

## View and Edit File {#view-and-edit-file}
## View and Edit File {/* #view-and-edit-file */}

Start the view and edit process by clicking on a file.
Finish the editing or viewing using the back button of the device until you're back in Cryptomator.
Expand All @@ -67,7 +67,7 @@ If the content has changed, the upload process starts.
<Image src="/img/android/edit-file.gif" alt="How to edit a file with Android" width="540" height="1110" />
</MobileGrid>

## Rename File or Folder {#rename-file-or-folder}
## Rename File or Folder {/* #rename-file-or-folder */}

To change the name of a specific file or folder in Cryptomator, you select the `V` ① next to the file or folder and choose *Rename* ②.

Expand All @@ -83,7 +83,7 @@ Choose a new name and confirm using the `RENAME` button.
<Image src="/img/android/rename-vault-4-finish.png" alt="How to rename a vault with Android" width="1080" height="2220" />
</MobileGrid>

## Move File or Folder {#move-file-or-folder}
## Move File or Folder {/* #move-file-or-folder */}

To move a file or a folder into another folder, you select the `V` next to the file or folder ① and choose *Move* ②.

Expand Down Expand Up @@ -112,7 +112,7 @@ While moving, you can use the ③ button to create a new folder in the current f
<Image src="/img/android/move-file-5-move-folder-hint.png" alt="How to move a file or folder with Android" width="810" height="1665" />
</MobileGrid>

## Delete File or Folder {#delete-file-or-folder}
## Delete File or Folder {/* #delete-file-or-folder */}

To delete a specific file or folder in Cryptomator, you select the `V` next to the file or folder ① and choose *Delete* ②.

Expand All @@ -133,7 +133,7 @@ Confirm the deletion process using the `DELETE` button.
By deleting a folder, all subfolders and files inside are deleted recursively.
:::

## Export File or Folder {#export-file-or-folder}
## Export File or Folder {/* #export-file-or-folder */}

To export a specific file or folder in Cryptomator, you select the `V` next to the file or folder ① and choose *Export* ②.

Expand All @@ -150,7 +150,7 @@ Choose the target location where the file or folder should be exported to.
<Image src="/img/android/export-file-4-finish.png" alt="How to export a file or folder with Android" width="1080" height="2220" />
</MobileGrid>

## Share File with Other App {#share-file-with-other-app}
## Share File with Other App {/* #share-file-with-other-app */}

To share a specific file or folder in Cryptomator with another app, you select the `V` next to the file or folder ① and choose Share ②.

Expand All @@ -169,7 +169,7 @@ Choose the target app in which you will use the file or folder.
By sharing a file or folder from Cryptomator with Cryptomator, you can copy content from one vault to another one.
:::

## Share File with Cryptomator {#share-file-with-cryptomator}
## Share File with Cryptomator {/* #share-file-with-cryptomator */}

You can share files from another app with Cryptomator.
We use as example the Files app from Android.
Expand All @@ -195,7 +195,7 @@ Then the encryption and upload starts.
<Image src="/img/android/share-with-cm-4-finish.png" alt="How to share a file or folder with Android" width="1080" height="2220" />
</MobileGrid>

## Search in Folder {#search-in-folder}
## Search in Folder {/* #search-in-folder */}

Search for files or folders within the same folder using the magnifier ①.

Expand All @@ -222,13 +222,13 @@ In the settings there are two options that influence the behavior of the search:

For more information, see the Settings chapter.

## Sort Folder by… {#sort-folder-by}
## Sort Folder by… {/* #sort-folder-by */}

<MobileGrid>
<Image src="/img/android/sort.gif" alt="How to sort the content of a folder with Android" width="540" height="1110" />
</MobileGrid>

## Fast Scroll {#fast-scroll}
## Fast Scroll {/* #fast-scroll */}

<MobileGrid>
<Image src="/img/android/fast-scroll.gif" alt="How to scroll fast through the content of a folder with Android" width="540" height="1110" />
Expand Down
14 changes: 7 additions & 7 deletions docs/android/cloud-management.md → docs/android/cloud-management.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,29 +22,29 @@ You can't connect to (for example) two different *Dropbox* accounts.
If the provider requested permission to access your online files you can remove Cryptomator permissions from your online storage account at any time.
Please keep in mind that Cryptomator then cannot connect to your vault anymore.

## Login Dropbox {#login-dropbox}
## Login Dropbox {/* #login-dropbox */}

<MobileGrid>
<Image src="/img/android/add-dropbox-login-provider-0.png" alt="How to handle cloud services with Android" width="1080" height="1920" />
<Image src="/img/android/add-dropbox-login-provider-1.png" alt="How to handle cloud services with Android" width="1080" height="1920" />
</MobileGrid>

## Login Google Drive {#login-google-drive}
## Login Google Drive {/* #login-google-drive */}

<MobileGrid>
<Image src="/img/android/add-googledrive-login-provider.png" alt="How to handle cloud services with Android" width="1080" height="2220" />
</MobileGrid>

## Login OneDrive {#login-onedrive}
## Login OneDrive {/* #login-onedrive */}

<MobileGrid>
<Image src="/img/android/add-onedrive-login-provider-0.png" alt="How to handle cloud services with Android" width="1080" height="2220" />
<Image src="/img/android/add-onedrive-login-provider-1.png" alt="How to handle cloud services with Android" width="1080" height="2220" />
</MobileGrid>

## Login WebDAV {#login-webdav}
## Login WebDAV {/* #login-webdav */}

Please see [Cloud Services With WebDAV Support](/docs/misc/supported-cloud-services.md#cloud-services-with-webdav-support) for a non-exhaustive list of Cloud Services and information about accessing them with WebDAV.
Please see [Cloud Services With WebDAV Support](/docs/misc/supported-cloud-services.mdx#cloud-services-with-webdav-support) for a non-exhaustive list of Cloud Services and information about accessing them with WebDAV.

<MobileGrid>
<Image src="/img/android/add-webdav-login-provider-0.png" alt="How to handle cloud services with Android" width="810" height="1665" />
Expand All @@ -56,7 +56,7 @@ Please see [Cloud Services With WebDAV Support](/docs/misc/supported-cloud-servi
While creating the WebDAV connection, please make sure to add the root of the accessible storage and don't navigate directly into the vault.
:::

## Login S3 {#login-s3}
## Login S3 {/* #login-s3 */}

Generate a key that has permissions "Allow List All Bucket Names". (AWS root users have this by default and [this permission may not be necessary in the future](https://github.com/cryptomator/android/issues/339).)

Expand All @@ -66,7 +66,7 @@ Generate a key that has permissions "Allow List All Bucket Names". (AWS root use
<Image src="/img/android/add-s3-login-provider.png" alt="Android S3 connection form" width="1080" height="2520" />
</MobileGrid>

## Login Local Storage {#login-local-storage}
## Login Local Storage {/* #login-local-storage */}

The following pictures describes how to setup a location to access vaults stored on the internal storage of the device (the same applies for vaults located e.g. on a SD card):

Expand Down
0 docs/android/index.md → docs/android/index.mdx
View file
Open in desktop
File renamed without changes.
44 changes: 22 additions & 22 deletions docs/android/settings.md → docs/android/settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_position: 5
You can configure Cryptomator to your needs.
This section provides an overview of the different settings.

## General Settings {#general-settings}
## General Settings {/* #general-settings */}

After pressing the three dots ① and clicking on `Settings`, you will find options to customize Cryptomator.

Expand All @@ -18,15 +18,15 @@ After pressing the three dots ① and clicking on `Settings`, you will find opti
<Image src="/img/android/settings.png" alt="How to launch settings with Android" width="1080" height="2220" />
</MobileGrid>

### Cloud Services {#cloud-services}
### Cloud Services {/* #cloud-services */}

This setting lists all Cloud Services. When pressing on a service, the authentication starts or if you're already authenticated, you will be logged out.

<MobileGrid>
<Image src="/img/android/setting-cloud-services.png" alt="How to handle cloud services with Android" width="1080" height="2220" />
</MobileGrid>

### Fingerprint {#fingerprint}
### Fingerprint {/* #fingerprint */}

:::note
This setting is only available if your device supports the fingerprint authentication.
Expand All @@ -49,7 +49,7 @@ After enabling, you have to unlock the vault using the password.

To have access to the key stored in the keystore, you have to authenticate against the system using the fingerprint.

### Block App When Obscured {#block-app-when-obscured}
### Block App When Obscured {/* #block-app-when-obscured */}

Under certain circumstances, Cryptomator for Android may not respond to touches.

Expand All @@ -76,7 +76,7 @@ If you see this dialog, some app is able to draw over Cryptomator:
<Image src="/img/android/setting-app-obscured.png" alt="How to enable obscured app with Android" width="303" height="500" />
</MobileGrid>

### Screen Security {#screen-security}
### Screen Security {/* #screen-security */}

Android provides the possibility to prevent the system and other apps from doing screenshots, screen recordings etc. while Cryptomator is active.
This feature is very important because it prevents other apps from reading data across the screen.
Expand All @@ -86,7 +86,7 @@ For some devices, e.g. a Chromebook with a second display or to create a screens

Read more: [FLAG*SECURE](https://developer.android.com/reference/android/view/Display.html#FLAG*SECURE)

### Style {#style}
### Style {/* #style */}

You can choose between the following three styles:

Expand All @@ -99,7 +99,7 @@ You can choose between the following three styles:
<Image src="/img/android/setting-style-dark.png" alt="How to change style with Android" width="1080" height="2220" />
</MobileGrid>

## Search {#search}
## Search {/* #search */}

You can use the magnifier inside the cloud node list to search for specific nodes.
Thereby there are two settings:
Expand All @@ -109,7 +109,7 @@ Thereby there are two settings:

both are described in the following chapters.

### Live Search {#live-search}
### Live Search {/* #live-search */}

If this setting is enabled, the search mode is `live`.
That means, the search starts immediately after entering the search pattern.
Expand All @@ -120,7 +120,7 @@ That means, the search starts immediately after entering the search pattern.

If it is disabled, you have to use the magnifier or the enter button in your keyboard to start the search.

### Search using glob pattern matching {#search-using-glob-pattern-matching}
### Search using glob pattern matching {/* #search-using-glob-pattern-matching */}

If this setting is enabled, you have to enter a glob pattern into the search bar.

Expand All @@ -131,7 +131,7 @@ If this setting is enabled, you have to enter a glob pattern into the search bar
If it is disabled, the beginning of the cloud node names must match the entered text. Upper and lower case is not relevant in this option.


## Automatic Locking {#automatic-locking}
## Automatic Locking {/* #automatic-locking */}

If a vault is unlocked and Cryptomator isn't active, the automatic locking timeout is counting down.
After the timeout expires, all vaults get locked.
Expand All @@ -145,7 +145,7 @@ You can choose between:

`When screen is disabled` can be deactivated so that the vaults don't get locked when the screen locks.

## Automatic Photo Upload {#automatic-photo-upload}
## Automatic Photo Upload {/* #automatic-photo-upload */}

If the `Automatic photo upload` is enabled, all photos taken will be marked for upload and after the specified vault gets unlocked again, the upload starts.

Expand All @@ -156,12 +156,12 @@ Which pictures will be tracked, depends on the Android version on your phone:
* Nougat (API level 24 or 7.x) and later: All images which Android adds to the gallery will be uploaded to the vault
* Pre-Nougat: Only the images created with the camera will be uploaded to the vault

## Cache {#cache}
## Cache {/* #cache */}

Introduced in version 1.5.0, if enabled, all downloaded files will be cached (encrypted) on the file system. Further downloads will only verify with the server, that the cached file is still the latest version.
If so it will not be downloaded again but directly retrieved from the file system. The cache is implemented using a least recently used mechanism, that means, the oldest entry will be overwritten if the max cache size is reached.

### Cache Size Per Cloud {#cache-size-per-cloud}
### Cache Size Per Cloud {/* #cache-size-per-cloud */}

Using this setting, you can specify the total max cache size per Cloud Service.

Expand All @@ -178,38 +178,38 @@ You can choose between the following options:
The more memory is given to caching, the greater the convenience factor. However, this memory can be used up to the maximum on the system and is then no longer available.
:::

### Clear Cache {#clear-cache}
### Clear Cache {/* #clear-cache */}

This setting will flush all cached files.

## Support {#support}
## Support {/* #support */}

If you have problems with the app you can enable the `Debug mode`.
After reproducing the problem, you can disable the `Debug mode` again and `Send log file`.

## Advanced Settings {#advanced-settings}
## Advanced Settings {/* #advanced-settings */}

### Workaround Opening Microsoft Files {#workaround-opening-microsoft-files}
### Workaround Opening Microsoft Files {/* #workaround-opening-microsoft-files */}

With this setting enabled, files are opened in Microsoft applications with write permission.

Due to a bug in Microsoft apps, the file to be edited must be shared with these apps in a public media folder on the device. After Cryptomator is resumed, the publicly accessible file is deleted again but Cryptomator cannot influence what has happened to this file in the meantime. Make sure that you are aware of this behavior when activating this option. This will only apply to Microsoft file types.

### Keep Unlocked {#keep-unlocked}
### Keep Unlocked {/* #keep-unlocked */}

With this setting enabled, all vaults remain unlocked when a file is opened by a third-party application, which can be useful in combination with the "Workaround Opening Microsoft Files".

### Accelerate Unlock {#accelerate-unlock}
### Accelerate Unlock {/* #accelerate-unlock */}

Download files to unlock the vault in the background while prompted to enter the password or biometric authentication. Keep it activated unless unlocking the vault does not work.

## Version {#version}
## Version {/* #version */}

This setting displays the current version of this app.

The following sub settings are only available, if you're using the APK-Store variant of Cryptomator and not the Google Play Store one.

### Update Check Interval {#update-check-interval}
### Update Check Interval {/* #update-check-interval */}

Using the specified interval below, the app checks if the latest version is installed.

Expand All @@ -220,6 +220,6 @@ You can choose between the following options:
* Once a month
* Never

### Check For Updates {#check-for-updates}
### Check For Updates {/* #check-for-updates */}

This setting displays the timestamp of the latest update check. You can click on this setting to trigger a update check.
Loading