From e39f063568045c8ab72ecbf8577b600076b1f3e7 Mon Sep 17 00:00:00 2001 From: Jonah Aragon Date: Wed, 13 Apr 2022 19:19:13 -0500 Subject: [PATCH] Add support for localization (#995) --- .github/workflows/build.yml | 46 -------- .github/workflows/deploy.yml | 1 + Pipfile | 1 + Pipfile.lock | 9 +- README.md | 11 +- crowdin.yml | 12 ++ docs/{about.md => about.en.md} | 0 docs/about/{notices.md => notices.en.md} | 3 - ...privacy-policy.md => privacy-policy.en.md} | 3 - docs/{android.md => android.en.md} | 0 docs/{browsers.md => browsers.en.md} | 2 +- ...ar-contacts.md => calendar-contacts.en.md} | 2 +- docs/{cloud.md => cloud.en.md} | 2 +- docs/{dns.md => dns.en.md} | 0 .../{email-clients.md => email-clients.en.md} | 2 +- docs/{email.md => email.en.md} | 2 +- docs/{encryption.md => encryption.en.md} | 2 +- docs/{file-sharing.md => file-sharing.en.md} | 2 +- docs/{index.md => index.en.md} | 2 +- .../{linux-desktop.md => linux-desktop.en.md} | 2 +- ...-tools.md => metadata-removal-tools.en.md} | 2 +- ...n.md => multi-factor-authentication.en.md} | 2 +- ...-aggregators.md => news-aggregators.en.md} | 2 +- docs/{notebooks.md => notebooks.en.md} | 2 +- docs/{passwords.md => passwords.en.md} | 2 +- docs/{productivity.md => productivity.en.md} | 2 +- docs/{qubes.md => qubes.en.md} | 2 +- ...ation.md => real-time-communication.en.md} | 2 +- docs/{router.md => router.en.md} | 2 +- ...search-engines.md => search-engines.en.md} | 2 +- ...n.md => multi-factor-authentication.en.md} | 3 +- ...works.md => self-contained-networks.en.md} | 2 +- ....md => integrating-metadata-removal.en.md} | 3 +- docs/technology/{dns.md => dns.en.md} | 0 ...reat-modeling.md => threat-modeling.en.md} | 3 +- docs/{tools.md => tools.en.md} | 2 +- ...deo-streaming.md => video-streaming.en.md} | 2 +- docs/{vpn.md => vpn.en.md} | 2 +- mkdocs.production.yml | 10 -- mkdocs.yml | 108 ++++++++++-------- theme/overrides/{home.html => home.en.html} | 4 +- 41 files changed, 113 insertions(+), 150 deletions(-) delete mode 100644 .github/workflows/build.yml create mode 100644 crowdin.yml rename docs/{about.md => about.en.md} (100%) rename docs/about/{notices.md => notices.en.md} (95%) rename docs/about/{privacy-policy.md => privacy-policy.en.md} (96%) rename docs/{android.md => android.en.md} (100%) rename docs/{browsers.md => browsers.en.md} (99%) rename docs/{calendar-contacts.md => calendar-contacts.en.md} (99%) rename docs/{cloud.md => cloud.en.md} (99%) rename docs/{dns.md => dns.en.md} (100%) rename docs/{email-clients.md => email-clients.en.md} (99%) rename docs/{email.md => email.en.md} (99%) rename docs/{encryption.md => encryption.en.md} (99%) rename docs/{file-sharing.md => file-sharing.en.md} (99%) rename docs/{index.md => index.en.md} (98%) rename docs/{linux-desktop.md => linux-desktop.en.md} (99%) rename docs/{metadata-removal-tools.md => metadata-removal-tools.en.md} (99%) rename docs/{multi-factor-authentication.md => multi-factor-authentication.en.md} (99%) rename docs/{news-aggregators.md => news-aggregators.en.md} (99%) rename docs/{notebooks.md => notebooks.en.md} (99%) rename docs/{passwords.md => passwords.en.md} (99%) rename docs/{productivity.md => productivity.en.md} (99%) rename docs/{qubes.md => qubes.en.md} (97%) rename docs/{real-time-communication.md => real-time-communication.en.md} (99%) rename docs/{router.md => router.en.md} (98%) rename docs/{search-engines.md => search-engines.en.md} (99%) rename docs/security/{multi-factor-authentication.md => multi-factor-authentication.en.md} (98%) rename docs/{self-contained-networks.md => self-contained-networks.en.md} (99%) rename docs/setup/{integrating-metadata-removal.md => integrating-metadata-removal.en.md} (98%) rename docs/technology/{dns.md => dns.en.md} (100%) rename docs/{threat-modeling.md => threat-modeling.en.md} (99%) rename docs/{tools.md => tools.en.md} (99%) rename docs/{video-streaming.md => video-streaming.en.md} (99%) rename docs/{vpn.md => vpn.en.md} (99%) delete mode 100644 mkdocs.production.yml rename theme/overrides/{home.html => home.en.html} (72%) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml deleted file mode 100644 index 52c61713..00000000 --- a/.github/workflows/build.yml +++ /dev/null @@ -1,46 +0,0 @@ -name: Build Website -on: - pull_request: - branches: - - main - -env: - PYTHON_VERSION: 3.x - -jobs: - build: - name: Build website - runs-on: ubuntu-latest - steps: - - - name: Checkout repository - uses: actions/checkout@v3 - - - name: Set up Python runtime - uses: actions/setup-python@v3 - with: - python-version: ${{ env.PYTHON_VERSION }} - - - name: Cache files - uses: actions/cache@v3.0.2 - with: - key: ${{ github.ref }} - path: .cache - - - name: Install Python dependencies - run: | - pip install mkdocs - pip install mkdocs-material - - - name: Build website - run: | - mkdocs build - mv .well-known site/ - tar cvf site.tar site - mkdocs --version - - - name: Package website - uses: actions/upload-artifact@v3 - with: - name: generated-site - path: site.tar diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index af1e410e..20bdbb29 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -29,6 +29,7 @@ jobs: - name: Install Python dependencies run: | pip install 'mkdocs>=1.3.0' + pip install mkdocs-static-i18n - name: Install mkdocs-material Insiders build if: github.event.repository.fork == false diff --git a/Pipfile b/Pipfile index b1348541..bacceef8 100644 --- a/Pipfile +++ b/Pipfile @@ -6,6 +6,7 @@ name = "pypi" [packages] mkdocs = "*" mkdocs-material = {path = "./mkdocs-material"} +mkdocs-static-i18n = "*" [dev-packages] scour = "*" diff --git a/Pipfile.lock b/Pipfile.lock index d817aa3a..86e89001 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "18f7bfb9a1d405016b6c63e1253e974e974d3e67b8e8a6b98d132ac1e780c822" + "sha256": "57e0161a7d6dbb050b1a0ab71eaaf145b951010f8a3054dfab1c5f24d4a293cf" }, "pipfile-spec": 6, "requires": { @@ -305,6 +305,13 @@ "markers": "python_version >= '3.6'", "version": "==1.0.3" }, + "mkdocs-static-i18n": { + "hashes": [ + "sha256:0d97df64b5be7b34dc112d4ccfba28352b9fccd1b7a3babf229f30d25f6ebb36" + ], + "index": "pypi", + "version": "==0.44" + }, "packaging": { "hashes": [ "sha256:dd47c42927d89ab911e606518907cc2d3a1f38bbd026385970643f9c5b8ecfeb", diff --git a/README.md b/README.md index 06b85405..9dad8c21 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,7 @@ Our current list of team members can be found [here](https://github.com/orgs/pri - 💬 [Start a discussion or suggest an idea](https://github.com/privacyguides/privacyguides.org/discussions) - 💖 [Sponsor the project](https://github.com/sponsors/privacyguides) +- 🈴 [Help translate the site](https://crwd.in/privacyguides) [[Matrix chat](https://matrix.to/#/#pg-i18n:aragon.sh)] - 📝 Edit the site, everything's accessible in this repo - Browse our [open issues](https://github.com/privacyguides/privacyguides.org/issues) to see what needs to be updated - When making more significant (than simple typo fixes, etc.) changes, update the [changelog](/CHANGELOG.md) @@ -54,16 +55,6 @@ Our current list of team members can be found [here](https://github.com/orgs/pri ## Developing -1. Clone this repository: `git clone https://github.com/privacyguides/privacyguides.org` -2. Install [Python 3.6+](https://www.python.org/downloads/) -3. Install [mkdocs-material](https://squidfunk.github.io/mkdocs-material/getting-started/): `pip install mkdocs-material` -4. Serve the site locally: `mkdocs serve` - - The site will be available at `http://localhost:8000/` - -Your local site will appear slightly different, because the production version of the website uses a private/custom build of mkdocs-material with additional features. - -Team members with access to [mkdocs-material-insiders](https://github.com/privacyguides/mkdocs-material-insiders) should instead: - 1. Clone this repository and submodules: `git clone --recurse-submodules https://github.com/privacyguides/privacyguides.org` 2. Install [Python 3.6+](https://www.python.org/downloads/) 3. Install **pipenv**: `pip install pipenv` diff --git a/crowdin.yml b/crowdin.yml new file mode 100644 index 00000000..932356e3 --- /dev/null +++ b/crowdin.yml @@ -0,0 +1,12 @@ +"preserve_hierarchy": true +files: +- source: "/docs/**/*.en.md" + translation: "/docs/**/%file_name%.%locale_with_underscore%.md" + translation_replace: + "en.": "" + update_option: update_as_unapproved +- source: "/theme/overrides/*.en.html" + translation: "/theme/overrides/%file_name%.%locale_with_underscore%.html" + translation_replace: + "en.": "" + update_option: update_as_unapproved diff --git a/docs/about.md b/docs/about.en.md similarity index 100% rename from docs/about.md rename to docs/about.en.md diff --git a/docs/about/notices.md b/docs/about/notices.en.md similarity index 95% rename from docs/about/notices.md rename to docs/about/notices.en.md index 775f4b62..dbcd6025 100644 --- a/docs/about/notices.md +++ b/docs/about/notices.en.md @@ -1,8 +1,5 @@ --- -layout: page -permalink: /terms-and-notices/ title: "Notices and Disclaimers" -description: "Privacy Guides is provided with good intentions on an "as-is" basis, without warranty, and disclaiming liability for damages." icon: material/message-alert hide: - toc diff --git a/docs/about/privacy-policy.md b/docs/about/privacy-policy.en.md similarity index 96% rename from docs/about/privacy-policy.md rename to docs/about/privacy-policy.en.md index 0c58c28a..5ee683a3 100644 --- a/docs/about/privacy-policy.md +++ b/docs/about/privacy-policy.en.md @@ -1,8 +1,5 @@ --- -layout: page -permalink: /privacy-policy/ title: "Privacy Policy" -description: "This Privacy Statement explains what information Privacy Guides and its related entities collect about its users, what we do with that information, and how we handle the content you place in our products and services." icon: material/file-search --- diff --git a/docs/android.md b/docs/android.en.md similarity index 100% rename from docs/android.md rename to docs/android.en.md diff --git a/docs/browsers.md b/docs/browsers.en.md similarity index 99% rename from docs/browsers.md rename to docs/browsers.en.md index e989a4fe..b98c46c8 100644 --- a/docs/browsers.md +++ b/docs/browsers.en.md @@ -1,5 +1,5 @@ --- -title: Browser Recommendations +title: "Web Browsers" icon: octicons/browser-16 --- These are our current web browser recommendations and settings. We recommend keeping extensions to a minimum: they have privileged access within your browser, require you to trust the developer, can make you [stand out](https://en.wikipedia.org/wiki/Device_fingerprint#Browser_fingerprint), and [weaken](https://groups.google.com/a/chromium.org/g/chromium-extensions/c/0ei-UCHNm34/m/lDaXwQhzBAAJ) site isolation. diff --git a/docs/calendar-contacts.md b/docs/calendar-contacts.en.md similarity index 99% rename from docs/calendar-contacts.md rename to docs/calendar-contacts.en.md index 52f64265..58f4dbe7 100644 --- a/docs/calendar-contacts.md +++ b/docs/calendar-contacts.en.md @@ -1,5 +1,5 @@ --- -title: Calendar and Contact Sync Tools +title: "Calendar and Contact Sync" icon: material/calendar --- Calendaring and contacts are some of the most sensitive data posess. Use only products that use end-to-end encryption (E2EE) at rest. This prevents a provider from reading your data. diff --git a/docs/cloud.md b/docs/cloud.en.md similarity index 99% rename from docs/cloud.md rename to docs/cloud.en.md index e1e6d141..053e4a80 100644 --- a/docs/cloud.md +++ b/docs/cloud.en.md @@ -1,5 +1,5 @@ --- -title: Cloud Storage +title: "Cloud Storage" icon: material/file-cloud --- If you are currently using a Cloud Storage Service like Dropbox, Google Drive, Microsoft OneDrive or Apple iCloud, you are putting complete trust in your service provider to not look at your files. diff --git a/docs/dns.md b/docs/dns.en.md similarity index 100% rename from docs/dns.md rename to docs/dns.en.md diff --git a/docs/email-clients.md b/docs/email-clients.en.md similarity index 99% rename from docs/email-clients.md rename to docs/email-clients.en.md index c924ab93..3a55ec5f 100644 --- a/docs/email-clients.md +++ b/docs/email-clients.en.md @@ -1,5 +1,5 @@ --- -title: Email Clients +title: "Email Clients" icon: material/email-open --- Our recommendation list contains email clients that support both [OpenPGP](/encryption/#openpgp) and strong authentication such as [Open Authorization (OAuth)](https://en.wikipedia.org/wiki/OAuth). OAuth allows you to use [Multi-Factor Authentication](/multi-factor-authentication) and prevent account theft. diff --git a/docs/email.md b/docs/email.en.md similarity index 99% rename from docs/email.md rename to docs/email.en.md index 2549fc38..1b2b1a76 100644 --- a/docs/email.md +++ b/docs/email.en.md @@ -1,5 +1,5 @@ --- -title: Private Email Providers +title: "Private Email Providers" icon: material/email --- diff --git a/docs/encryption.md b/docs/encryption.en.md similarity index 99% rename from docs/encryption.md rename to docs/encryption.en.md index 17dd70f5..105edf22 100644 --- a/docs/encryption.md +++ b/docs/encryption.en.md @@ -1,5 +1,5 @@ --- -title: Encryption Software +title: "Encryption Software" icon: material/file-lock --- Encryption of data is the only way to control who can access it. If you are currently not using encryption software for your hard disk, emails, or files, you should pick an option here. diff --git a/docs/file-sharing.md b/docs/file-sharing.en.md similarity index 99% rename from docs/file-sharing.md rename to docs/file-sharing.en.md index 5fd3a87c..588fadda 100644 --- a/docs/file-sharing.md +++ b/docs/file-sharing.en.md @@ -1,5 +1,5 @@ --- -title: File Sharing and Sync +title: "File Sharing and Sync" icon: material/share-variant --- Discover how to privately share your files between your devices, with your friends and family, or anonymously online. diff --git a/docs/index.md b/docs/index.en.md similarity index 98% rename from docs/index.md rename to docs/index.en.md index 758ce6b4..578bfb64 100644 --- a/docs/index.md +++ b/docs/index.en.md @@ -1,5 +1,5 @@ --- -template: overrides/home.html +template: overrides/home.en.html hide: - navigation - toc diff --git a/docs/linux-desktop.md b/docs/linux-desktop.en.md similarity index 99% rename from docs/linux-desktop.md rename to docs/linux-desktop.en.md index 3d334008..fae97ba7 100644 --- a/docs/linux-desktop.md +++ b/docs/linux-desktop.en.md @@ -1,5 +1,5 @@ --- -title: Linux +title: "Linux" icon: fontawesome/brands/linux --- Linux distributions are commonly recommended for privacy protection and user freedom. Below are some suggestions with some general privacy and security improvements. diff --git a/docs/metadata-removal-tools.md b/docs/metadata-removal-tools.en.md similarity index 99% rename from docs/metadata-removal-tools.md rename to docs/metadata-removal-tools.en.md index 155e0aec..4f108c68 100644 --- a/docs/metadata-removal-tools.md +++ b/docs/metadata-removal-tools.en.md @@ -1,5 +1,5 @@ --- -title: Metadata Removal Tools +title: "Metadata Removal Tools" icon: material/tag-remove --- When sharing files, be sure to remove associated metadata. Image files commonly include [EXIF](https://en.wikipedia.org/wiki/Exif) data. Photos sometimes even include [GPS](https://en.wikipedia.org/wiki/Global_Positioning_System) coordinates in the file metadata. diff --git a/docs/multi-factor-authentication.md b/docs/multi-factor-authentication.en.md similarity index 99% rename from docs/multi-factor-authentication.md rename to docs/multi-factor-authentication.en.md index 32c3454c..8d050ca9 100644 --- a/docs/multi-factor-authentication.md +++ b/docs/multi-factor-authentication.en.md @@ -1,5 +1,5 @@ --- -title: Multi-Factor Authenticator Recommendations +title: "Multi-Factor Authenticators" icon: 'material/two-factor-authentication' --- ## Hardware Security Keys diff --git a/docs/news-aggregators.md b/docs/news-aggregators.en.md similarity index 99% rename from docs/news-aggregators.md rename to docs/news-aggregators.en.md index 1fd8b44e..00454de8 100644 --- a/docs/news-aggregators.md +++ b/docs/news-aggregators.en.md @@ -1,5 +1,5 @@ --- -title: News Aggregators +title: "News Aggregators" icon: octicons/rss-24 --- diff --git a/docs/notebooks.md b/docs/notebooks.en.md similarity index 99% rename from docs/notebooks.md rename to docs/notebooks.en.md index 118c5c61..6275e19e 100644 --- a/docs/notebooks.md +++ b/docs/notebooks.en.md @@ -1,5 +1,5 @@ --- -title: Notebooks +title: "Notebooks" icon: material/notebook-edit-outline --- diff --git a/docs/passwords.md b/docs/passwords.en.md similarity index 99% rename from docs/passwords.md rename to docs/passwords.en.md index 962de0cf..02e15008 100644 --- a/docs/passwords.md +++ b/docs/passwords.en.md @@ -1,5 +1,5 @@ --- -title: Password Managers +title: "Password Managers" icon: material/form-textbox-password --- Stay safe and secure online with an encrypted and open-source password manager. diff --git a/docs/productivity.md b/docs/productivity.en.md similarity index 99% rename from docs/productivity.md rename to docs/productivity.en.md index 7d3d2d0a..a068ef74 100644 --- a/docs/productivity.md +++ b/docs/productivity.en.md @@ -1,5 +1,5 @@ --- -title: Productivity Tools +title: "Productivity Tools" icon: material/file-sign --- Get working and collaborating without sharing your documents with a middleman or trusting a cloud provider. diff --git a/docs/qubes.md b/docs/qubes.en.md similarity index 97% rename from docs/qubes.md rename to docs/qubes.en.md index 29377663..9de3a963 100644 --- a/docs/qubes.md +++ b/docs/qubes.en.md @@ -1,5 +1,5 @@ --- -title: Qubes OS +title: "Qubes OS" icon: pg/qubes-os --- Qubes OS is a distribution of Linux that uses [Xen](https://en.wikipedia.org/wiki/Xen) to provide app isolation. diff --git a/docs/real-time-communication.md b/docs/real-time-communication.en.md similarity index 99% rename from docs/real-time-communication.md rename to docs/real-time-communication.en.md index adcbfb75..48a4a6bb 100644 --- a/docs/real-time-communication.md +++ b/docs/real-time-communication.en.md @@ -1,5 +1,5 @@ --- -title: Real-Time Communication Tools +title: "Real-Time Communication" icon: material/chat-processing --- ## Encrypted Instant Messengers diff --git a/docs/router.md b/docs/router.en.md similarity index 98% rename from docs/router.md rename to docs/router.en.md index 65a38134..34cafed9 100644 --- a/docs/router.md +++ b/docs/router.en.md @@ -1,5 +1,5 @@ --- -title: Router Firmware +title: "Router Firmware" icon: material/router-wireless --- Below are a few alternative operating systems, that can be used on routers, Wi-Fi access points etc. diff --git a/docs/search-engines.md b/docs/search-engines.en.md similarity index 99% rename from docs/search-engines.md rename to docs/search-engines.en.md index f19d0743..c9701b29 100644 --- a/docs/search-engines.md +++ b/docs/search-engines.en.md @@ -1,5 +1,5 @@ --- -title: Search Engines +title: "Search Engines" icon: material/search-web --- Use a search engine that doesn't build an advertising profile based on your searches. diff --git a/docs/security/multi-factor-authentication.md b/docs/security/multi-factor-authentication.en.md similarity index 98% rename from docs/security/multi-factor-authentication.md rename to docs/security/multi-factor-authentication.en.md index 2d49e90c..39d55365 100644 --- a/docs/security/multi-factor-authentication.md +++ b/docs/security/multi-factor-authentication.en.md @@ -1,6 +1,5 @@ --- -title: Multi-factor Authentication -description: "Using strong MFA can stop over 99% of unauthorized account accesses, and it's easy to set up on the services you already use." +title: "Multi-factor Authentication" icon: 'material/two-factor-authentication' --- **Multi-factor authentication** (MFA, or 2FA) is a security mechanism that requires additional steps beyond entering your username (or email) and password. The most common method are time limited codes you might receive from an SMS or app. diff --git a/docs/self-contained-networks.md b/docs/self-contained-networks.en.md similarity index 99% rename from docs/self-contained-networks.md rename to docs/self-contained-networks.en.md index 9d52f4a9..500028e7 100644 --- a/docs/self-contained-networks.md +++ b/docs/self-contained-networks.en.md @@ -1,5 +1,5 @@ --- -title: Self-Contained Networks +title: "Self-Contained Networks" icon: material/security-network --- If you are currently browsing clearnet and want to access the dark web, this section is for you. diff --git a/docs/setup/integrating-metadata-removal.md b/docs/setup/integrating-metadata-removal.en.md similarity index 98% rename from docs/setup/integrating-metadata-removal.md rename to docs/setup/integrating-metadata-removal.en.md index 05d1dde6..f57d2de2 100644 --- a/docs/setup/integrating-metadata-removal.md +++ b/docs/setup/integrating-metadata-removal.en.md @@ -1,6 +1,5 @@ --- -title: Integrating Metadata Removal -description: "Guides for integrating metadata removal solutions in a native fashion." +title: "Integrating Metadata Removal" icon: 'material/data-matrix-remove' --- diff --git a/docs/technology/dns.md b/docs/technology/dns.en.md similarity index 100% rename from docs/technology/dns.md rename to docs/technology/dns.en.md diff --git a/docs/threat-modeling.md b/docs/threat-modeling.en.md similarity index 99% rename from docs/threat-modeling.md rename to docs/threat-modeling.en.md index 8019f1d9..4ffadec5 100644 --- a/docs/threat-modeling.md +++ b/docs/threat-modeling.en.md @@ -1,6 +1,5 @@ --- -layout: evergreen -title: What are threat models? +title: "What are threat models?" icon: 'material/target-account' --- diff --git a/docs/tools.md b/docs/tools.en.md similarity index 99% rename from docs/tools.md rename to docs/tools.en.md index 0448c2c1..a5f11ec4 100644 --- a/docs/tools.md +++ b/docs/tools.en.md @@ -1,5 +1,5 @@ --- -title: Recommended Privacy Tools +title: "Privacy Tools" icon: material/tools hide: - toc diff --git a/docs/video-streaming.md b/docs/video-streaming.en.md similarity index 99% rename from docs/video-streaming.md rename to docs/video-streaming.en.md index a1e41586..140d0b1e 100644 --- a/docs/video-streaming.md +++ b/docs/video-streaming.en.md @@ -1,5 +1,5 @@ --- -title: Video Streaming +title: "Video Streaming" icon: material/video-wireless --- The primary threat when using a video streaming platform is that your streaming habits and subscription lists could be used to profile you. You should combine these tools with a [VPN](/vpn) or [Tor](https://www.torproject.org/) to make it harder to profile your usage. diff --git a/docs/vpn.md b/docs/vpn.en.md similarity index 99% rename from docs/vpn.md rename to docs/vpn.en.md index 986961e4..a68c9c6c 100644 --- a/docs/vpn.md +++ b/docs/vpn.en.md @@ -1,5 +1,5 @@ --- -title: VPN Services +title: "VPN Services" icon: material/vpn --- diff --git a/mkdocs.production.yml b/mkdocs.production.yml deleted file mode 100644 index 9ccc4dd1..00000000 --- a/mkdocs.production.yml +++ /dev/null @@ -1,10 +0,0 @@ -INHERIT: mkdocs.yml -site_url: "https://www.privacyguides.org/" -watch: - - theme - - mkdocs.yml -plugins: - - search - - privacy: - externals_exclude: - - cdn.jsdelivr.net/npm/mathjax@3/* diff --git a/mkdocs.yml b/mkdocs.yml index 89f92788..d2d030f4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,3 +1,7 @@ +docs_dir: 'docs' +site_url: "https://www.privacyguides.org/" +site_dir: 'site' + site_name: Privacy Guides site_description: | Massive organizations are monitoring your online activities. Privacy Guides is your central privacy and security resource to protect yourself online. @@ -5,6 +9,7 @@ copyright: | Privacy Guides is a non-profit, socially motivated website that provides information for protecting your data security and privacy.
We do not make money from recommending certain products, and we do not utilize affiliate links.
This content was made available by the Privacy Guides team and contributors. Get involved! + extra: generator: false social: @@ -20,52 +25,6 @@ repo_url: https://github.com/privacyguides/privacyguides.org repo_name: privacyguides.org edit_uri: edit/main/docs/ -nav: - - Home: 'index.md' - - 'Privacy Introduction': - - 'Threat Modeling': 'threat-modeling.md' - - 'Technology Basics': - - 'DNS': 'technology/dns.md' - - 'Security Basics': - - 'Multi-Factor Authentication': 'security/multi-factor-authentication.md' - - 'Setup Guides': - - 'Integrating Metadata Removal': 'setup/integrating-metadata-removal.md' - - 'Recommendations': - - 'Privacy Tools': 'tools.md' - - 'Browsers': - - 'Web Browsers': 'browsers.md' - - 'Operating Systems': - - 'Android': 'android.md' - - 'Linux Desktop': 'linux-desktop.md' - - 'Qubes OS': 'qubes.md' - - 'Router Firmware': 'router.md' - - 'Providers': - - 'Cloud Storage': 'cloud.md' - - 'DNS Servers': 'dns.md' - - 'Email Providers': 'email.md' - - 'Search Engines': 'search-engines.md' - - 'VPN Providers': 'vpn.md' - - 'Software': - - 'Calendar/Contacts Sync': 'calendar-contacts.md' - - 'Digital Notebooks': 'notebooks.md' - - 'Email Clients': 'email-clients.md' - - 'Encryption Tools': 'encryption.md' - - 'File Sharing/Sync': 'file-sharing.md' - - 'Metadata Removal Tools': 'metadata-removal-tools.md' - - 'Multi-Factor Authenticators': 'multi-factor-authentication.md' - - 'Password Managers': 'passwords.md' - - 'Productivity Tools': 'productivity.md' - - 'Real-Time Communication': 'real-time-communication.md' - - 'News Aggregators': 'news-aggregators.md' - - 'Self-Contained Networks': 'self-contained-networks.md' - - 'Video Streaming': 'video-streaming.md' - - 'About Us': - - 'Privacy Guides': 'about.md' - - 'Notices': 'about/notices.md' - - 'Privacy Policy': 'about/privacy-policy.md' - - 'Discussions': 'https://github.com/orgs/privacyguides/discussions' - - 'Blog': 'https://blog.privacyguides.org/' - theme: name: material custom_dir: theme @@ -95,7 +54,18 @@ watch: - theme plugins: + - i18n: + default_language: en + material_alternate: true + languages: + en: + name: English + build: false - tags + - search + - privacy: + externals_exclude: + - cdn.jsdelivr.net/npm/mathjax@3/* extra_css: - stylesheets/extra.css markdown_extensions: @@ -129,3 +99,49 @@ markdown_extensions: extra_javascript: - javascripts/mathjax.js + +nav: + - Home: 'index.md' + - 'Privacy Introduction': + - 'threat-modeling.md' + - 'Technology Basics': + - 'technology/dns.md' + - 'Security Basics': + - 'security/multi-factor-authentication.md' + - 'Setup Guides': + - 'setup/integrating-metadata-removal.md' + - 'Recommendations': + - 'tools.md' + - 'Browsers': + - 'browsers.md' + - 'Operating Systems': + - 'android.md' + - 'linux-desktop.md' + - 'qubes.md' + - 'router.md' + - 'Providers': + - 'cloud.md' + - 'dns.md' + - 'email.md' + - 'search-engines.md' + - 'vpn.md' + - 'Software': + - 'calendar-contacts.md' + - 'notebooks.md' + - 'email-clients.md' + - 'encryption.md' + - 'file-sharing.md' + - 'metadata-removal-tools.md' + - 'multi-factor-authentication.md' + - 'passwords.md' + - 'productivity.md' + - 'real-time-communication.md' + - 'news-aggregators.md' + - 'self-contained-networks.md' + - 'video-streaming.md' + - 'About Us': + - 'about.md' + - 'about/notices.md' + - 'about/privacy-policy.md' + - 'Discussions': 'https://github.com/orgs/privacyguides/discussions' + - 'Blog': 'https://blog.privacyguides.org/' diff --git a/theme/overrides/home.html b/theme/overrides/home.en.html similarity index 72% rename from theme/overrides/home.html rename to theme/overrides/home.en.html index fc4fe0a8..5a501e77 100644 --- a/theme/overrides/home.html +++ b/theme/overrides/home.en.html @@ -10,8 +10,8 @@

The guide to restoring your online privacy.

-

{{ config.site_description }}

- +

Massive organizations are monitoring your online activities. Privacy Guides is your central privacy and security resource to protect yourself online.

+ Recommended Tools