Skip to content

Commit 9a2ff6a

Browse files
committed
Merge branch 'main' into feature/hub-1.4.0-features
2 parents 3905002 + 005e93e commit 9a2ff6a

File tree

6 files changed

+62
-19
lines changed

6 files changed

+62
-19
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ help:
1414
.PHONY: help Makefile
1515

1616
livehtml:
17-
sphinx-autobuild -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
17+
sphinx-autobuild -b dirhtml $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/dirhtml
1818

1919
# Catch-all target: route all unknown targets to Sphinx using the new
2020
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
2121
%: Makefile
22-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
22+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,18 @@ We prefer contributions to our documentation to be in English, but if you wish t
2020
### Using Docker
2121

2222
- Install [Docker](https://www.docker.com/)
23-
- Build a Docker image as per the Dockerfile included in this repo. You just need to run the command below (don't omit the dot at the end).
23+
#### For live preview:
2424

2525
```
26-
docker build -t cryptomator_docs_image .
26+
docker compose up
2727
```
28-
29-
Run the commands below in the repo's directory to start a Docker container based on the built image.
3028

31-
For live preview:
29+
The live preview will be available at: [http://localhost:8000/](http://localhost:8000/)
3230

33-
```
34-
docker run -p 8000:8000 -v $(pwd)/source:/source -v $(pwd)/build:/build cryptomator_docs_image sphinx-autobuild -b html /source /build/html --host 0.0.0.0
35-
```
36-
37-
To build site:
31+
#### To build site:
3832

3933
```
40-
docker run -v $(pwd)/source:/source -v $(pwd)/build:/build cryptomator_docs_image sphinx-build -M html /source /build/html
34+
docker compose exec cryptomator-docs sphinx-build -M dirhtml /source /build/dirhtml
4135
```
4236

4337
### Without Using Docker
@@ -49,17 +43,17 @@ We prefer contributions to our documentation to be in English, but if you wish t
4943
pip install sphinx sphinx_rtd_theme sphinx-autobuild
5044
```
5145

52-
For live preview:
46+
#### For live preview:
5347

5448
```
5549
make clean livehtml
5650
```
5751

58-
To build site:
52+
#### To build site:
5953

6054
```
61-
make clean html
62-
```
55+
make clean dirhtml
56+
```
6357

6458
<!--
6559
How tow record `.gif`s:

docker-compose.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
services:
2+
cryptomator-docs:
3+
build: .
4+
ports:
5+
- "8000:8000"
6+
volumes:
7+
- ./source:/source
8+
- ./build:/build
9+
command: >
10+
sphinx-autobuild
11+
-b dirhtml
12+
/source
13+
/build/dirhtml
14+
--host 0.0.0.0

source/_static/js/remove-utm.js

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
function removeUTMParams() {
2+
const url = new URL(window.location.href);
3+
const params = url.searchParams;
4+
const utmParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content'];
5+
let modified = false;
6+
utmParams.forEach(param => {
7+
if (params.has(param)) {
8+
params.delete(param);
9+
modified = true;
10+
}
11+
});
12+
if (modified) {
13+
const newQuery = params.toString() ? '?' + params.toString() : '';
14+
const newUrl = url.pathname + newQuery + url.hash;
15+
window.history.replaceState({}, document.title, newUrl);
16+
}
17+
}
18+
if ('requestIdleCallback' in window) {
19+
requestIdleCallback(removeUTMParams);
20+
} else {
21+
// Fallback if not supported
22+
window.addEventListener('load', () => {
23+
removeUTMParams();
24+
});
25+
}

source/_templates/layout.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
{%- block extrahead %}
44
<script defer data-domain="docs.cryptomator.org" src="https://plausible.skymatic.de/js/script.file-downloads.outbound-links.js" integrity="sha384-+tt0STxxWB96REUfXF1ykJzPEC5cT+TVotVR/JnYqAP04zxND4o8a0JcHg+aq46t" crossorigin="anonymous"></script>
55
<script src="https://umami.skymatic.de/script.js" data-website-id="2df416f9-7a9c-4e58-9a45-7106f7e0a139" integrity="sha384-/WQteTtaLX4nU22mvCeTi4Yz3iK/J3yZ2rKq5jDxPMlizEQGzgJOlSofJxh+bx4B" crossorigin="anonymous" defer></script>
6+
<script src="../../_static/js/remove-utm.js" integrity="sha384-/GnxN3ANEPnKJ3hynuMg+gv/GYWn0RiaxFN+2i1RrxUqwCcThs/GCsMaP6aKlHxH" defer></script>
67
{% endblock %}
78

source/ios/setup.rst

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
Setup
22
=====
33

4-
You can get Cryptomator for iOS on the `App Store <https://apps.apple.com/app/cryptomator-2/id1560822163>`_.
4+
You can get Cryptomator for iOS on the `App Store <https://apps.apple.com/app/cryptomator/id1560822163>`_.
5+
6+
Cryptomator is available for free with in-app purchases. The free version gives you read-only access to your vaults. With the in-app purchase, you can unlock the full version to gain write access to your vaults. You can also try out the full version free for 30 days.
7+
8+
Full Version
9+
------------
10+
11+
A full version of Cryptomator without in-app purchases is available on the `App Store <https://apps.apple.com/app/cryptomator-full-version/id1665616242>`_ as well. This version is unlisted and only available via the direct link.
12+
13+
The "Full Version" is basically the same as Cryptomator with the in-app purchase "Full Version" unlocked. This app is available for interested parties using Apple School Manager or Apple Business Manager that are unable to buy in-app purchases. Or if you want to gift the app to your friends or family.
514

615
.. _ios/setup/requirements:
716

817
Requirements
918
------------
1019

11-
Requires iOS 13.0 or later. Compatible with iPhone, iPad, and iPod touch.
20+
Requires iOS 14.0 or later. Compatible with iPhone, iPad, and iPod touch.

0 commit comments

Comments
 (0)