From 55d925283dba63e520c8ef2002588ed2633ebcaa Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Sun, 19 May 2024 17:35:32 +0900 Subject: [PATCH 1/8] Change syntax from Material for MkDocs to Docusaurus --- docs/generating-passwords.md | 12 ++++++++---- docs/uninstalling.md | 8 ++------ docs/updating-the-app.md | 8 +++++--- 3 files changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/generating-passwords.md b/docs/generating-passwords.md index 1912a1d..57a8c21 100644 --- a/docs/generating-passwords.md +++ b/docs/generating-passwords.md @@ -8,9 +8,11 @@ To create a 14-character password containing **symbols**, **numbers**, **upperca Select **Copy** to copy the password. -!!! note +:::note - To see the password that you generated, select the asterisks masking the password. +To see the password that you generated, select the asterisks masking the password. + +::: ## Generate a password *without* symbols @@ -18,9 +20,11 @@ To create a 14-character password containing **numbers**, **uppercase letters**, Select **Copy** to copy the password. -!!! note +:::note - To see the password that you generated, select the asterisks masking the password. +To see the password that you generated, select the asterisks masking the password. + +::: ## Open multiple password windows diff --git a/docs/uninstalling.md b/docs/uninstalling.md index 02da3b3..4daf93e 100644 --- a/docs/uninstalling.md +++ b/docs/uninstalling.md @@ -2,10 +2,6 @@ To uninstall passGen, open **Settings** in Windows, then navigate to **Add or remove programs**. -Search for **passGen** in the program list, and click the **three vertical dots**, then select **Uninstall**. +Search for **passGen** in the program list, and click the **three vertical dots**. Then, select **Uninstall**. -!!! example - - Uninstalling passGen - - ![Example: Uninstalling passGen](https://github.com/josh-wong/passGen/blob/main/docs/assets/screenshots/uninstall.gif?raw=true) +![Example: Uninstalling passGen](https://github.com/josh-wong/passGen/blob/main/docs/assets/screenshots/uninstall.gif?raw=true) diff --git a/docs/updating-the-app.md b/docs/updating-the-app.md index aaf6373..9fc937e 100644 --- a/docs/updating-the-app.md +++ b/docs/updating-the-app.md @@ -6,6 +6,8 @@ When a new version of passGen is released, the app will prompt you to update. If To update, select **OK**. Or if you want to skip the update, select **Skip**. -!!! warning - - If you skip an update, you will not be prompted again until the next update. If you skipped an update and later decide to install it, you can download the newer version from [Releases](https://github.com/josh-wong/passGen/releases). +:::warning + +If you skip an update, you will not be prompted again until the next update. If you skipped an update and later decide to install it, you can download the newer version from [Releases](https://github.com/josh-wong/passGen/releases). + +::: From dfc1f3498c53e97890da08c1846c988d42a47b1c Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Sun, 19 May 2024 17:35:59 +0900 Subject: [PATCH 2/8] Change file extension from `.md` to `.mdx` File extensions in Docusaurus need to be `.mdx` to take advantage of React components. --- docs/{contributions.md => contributions.mdx} | 0 docs/{generating-passwords.md => generating-passwords.mdx} | 0 docs/{index.md => index.mdx} | 0 docs/{references.md => references.mdx} | 0 docs/{uninstalling.md => uninstalling.mdx} | 0 docs/{updating-the-app.md => updating-the-app.mdx} | 0 6 files changed, 0 insertions(+), 0 deletions(-) rename docs/{contributions.md => contributions.mdx} (100%) rename docs/{generating-passwords.md => generating-passwords.mdx} (100%) rename docs/{index.md => index.mdx} (100%) rename docs/{references.md => references.mdx} (100%) rename docs/{uninstalling.md => uninstalling.mdx} (100%) rename docs/{updating-the-app.md => updating-the-app.mdx} (100%) diff --git a/docs/contributions.md b/docs/contributions.mdx similarity index 100% rename from docs/contributions.md rename to docs/contributions.mdx diff --git a/docs/generating-passwords.md b/docs/generating-passwords.mdx similarity index 100% rename from docs/generating-passwords.md rename to docs/generating-passwords.mdx diff --git a/docs/index.md b/docs/index.mdx similarity index 100% rename from docs/index.md rename to docs/index.mdx diff --git a/docs/references.md b/docs/references.mdx similarity index 100% rename from docs/references.md rename to docs/references.mdx diff --git a/docs/uninstalling.md b/docs/uninstalling.mdx similarity index 100% rename from docs/uninstalling.md rename to docs/uninstalling.mdx diff --git a/docs/updating-the-app.md b/docs/updating-the-app.mdx similarity index 100% rename from docs/updating-the-app.md rename to docs/updating-the-app.mdx From 05f57365429ddaf46bc7b96178e9de106800c89f Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Sun, 19 May 2024 17:38:32 +0900 Subject: [PATCH 3/8] Rename file Rename file to better auto-generate the sidebar navigation on the site. --- docs/{generating-passwords.mdx => 01_generating-passwords.mdx} | 0 docs/{updating-the-app.mdx => 02_updating-the-app.mdx} | 0 docs/{uninstalling.mdx => 03_uninstalling.mdx} | 0 docs/{references.mdx => 04_references.mdx} | 0 docs/{contributions.mdx => 05_contributions.mdx} | 0 5 files changed, 0 insertions(+), 0 deletions(-) rename docs/{generating-passwords.mdx => 01_generating-passwords.mdx} (100%) rename docs/{updating-the-app.mdx => 02_updating-the-app.mdx} (100%) rename docs/{uninstalling.mdx => 03_uninstalling.mdx} (100%) rename docs/{references.mdx => 04_references.mdx} (100%) rename docs/{contributions.mdx => 05_contributions.mdx} (100%) diff --git a/docs/generating-passwords.mdx b/docs/01_generating-passwords.mdx similarity index 100% rename from docs/generating-passwords.mdx rename to docs/01_generating-passwords.mdx diff --git a/docs/updating-the-app.mdx b/docs/02_updating-the-app.mdx similarity index 100% rename from docs/updating-the-app.mdx rename to docs/02_updating-the-app.mdx diff --git a/docs/uninstalling.mdx b/docs/03_uninstalling.mdx similarity index 100% rename from docs/uninstalling.mdx rename to docs/03_uninstalling.mdx diff --git a/docs/references.mdx b/docs/04_references.mdx similarity index 100% rename from docs/references.mdx rename to docs/04_references.mdx diff --git a/docs/contributions.mdx b/docs/05_contributions.mdx similarity index 100% rename from docs/contributions.mdx rename to docs/05_contributions.mdx From c41918cefbaf3cff116a4703483378885d32690e Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Sun, 19 May 2024 18:13:58 +0900 Subject: [PATCH 4/8] Change title --- docs/index.mdx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/index.mdx b/docs/index.mdx index 9a360a5..0b2df0b 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -1,11 +1,12 @@ -# How to use passGen to create 14-character passwords +# Overview + +import { CardRowPassGen } from '/src/components/Cards/buttons'; passGen is a lightweight Windows app for creating randomly generated, 14-character passwords that contain: - Uppercase letters, lowercase letters, numbers - Uppercase letters, lowercase letters, numbers, and symbols - -[:fontawesome-solid-download: Download passGen v3.2](https://github.com/josh-wong/passGen/releases/download/v3.2.0/passGen_installer.exe){ .md-button .md-button--primary } + For details about changes to the passGen app, see the [release notes](https://github.com/josh-wong/passGen/releases). From 91fe33b0434de1752e43715a18b12eb924bcb489 Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Sun, 19 May 2024 18:23:21 +0900 Subject: [PATCH 5/8] Revise title --- docs/02_updating-the-app.mdx | 2 +- docs/03_uninstalling.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/02_updating-the-app.mdx b/docs/02_updating-the-app.mdx index 9fc937e..61d9afa 100644 --- a/docs/02_updating-the-app.mdx +++ b/docs/02_updating-the-app.mdx @@ -1,4 +1,4 @@ -# How to update the app +# Update passGen When a new version of passGen is released, the app will prompt you to update. If you open the app and an update is available, the following screen will be displayed. diff --git a/docs/03_uninstalling.mdx b/docs/03_uninstalling.mdx index 4daf93e..cf33650 100644 --- a/docs/03_uninstalling.mdx +++ b/docs/03_uninstalling.mdx @@ -1,4 +1,4 @@ -# How to uninstall passGen +# Uninstall passGen To uninstall passGen, open **Settings** in Windows, then navigate to **Add or remove programs**. From dc5d6d7d8b7c144b448a71f59aec618f56b0fcef Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Sun, 19 May 2024 18:23:26 +0900 Subject: [PATCH 6/8] Revise text --- docs/index.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/index.mdx b/docs/index.mdx index 0b2df0b..72d6a5e 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -10,3 +10,5 @@ passGen is a lightweight Windows app for creating randomly generated, 14-charact For details about changes to the passGen app, see the [release notes](https://github.com/josh-wong/passGen/releases). + +After downloading passGen, double-click the installation file to install the app. From a68cf38ad51882a463bdf077cf3792bf196847f3 Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Sun, 19 May 2024 18:23:39 +0900 Subject: [PATCH 7/8] Revise title and text --- docs/01_generating-passwords.mdx | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/01_generating-passwords.mdx b/docs/01_generating-passwords.mdx index 57a8c21..949e45d 100644 --- a/docs/01_generating-passwords.mdx +++ b/docs/01_generating-passwords.mdx @@ -1,6 +1,9 @@ -# How to create a randomly generated, 14-character password +# Generate a password -After downloading passGen, double-click the installation file to install the app. You can then choose which type of password to generate. +In the passGen app, you can choose which type of password to generate: + +- Generate a password *with* symbols +- Generate a password *without* symbols ## Generate a password *with* symbols From cc49df0b44cfa3a12372260b96096c36f4a35a96 Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Sun, 19 May 2024 18:24:28 +0900 Subject: [PATCH 8/8] Change file name --- docs/{index.mdx => 01_overview.mdx} | 0 docs/{01_generating-passwords.mdx => 02_generating-passwords.mdx} | 0 docs/{02_updating-the-app.mdx => 03_updating-the-app.mdx} | 0 docs/{03_uninstalling.mdx => 04_uninstalling.mdx} | 0 docs/{04_references.mdx => 05_references.mdx} | 0 docs/{05_contributions.mdx => 06_contributions.mdx} | 0 6 files changed, 0 insertions(+), 0 deletions(-) rename docs/{index.mdx => 01_overview.mdx} (100%) rename docs/{01_generating-passwords.mdx => 02_generating-passwords.mdx} (100%) rename docs/{02_updating-the-app.mdx => 03_updating-the-app.mdx} (100%) rename docs/{03_uninstalling.mdx => 04_uninstalling.mdx} (100%) rename docs/{04_references.mdx => 05_references.mdx} (100%) rename docs/{05_contributions.mdx => 06_contributions.mdx} (100%) diff --git a/docs/index.mdx b/docs/01_overview.mdx similarity index 100% rename from docs/index.mdx rename to docs/01_overview.mdx diff --git a/docs/01_generating-passwords.mdx b/docs/02_generating-passwords.mdx similarity index 100% rename from docs/01_generating-passwords.mdx rename to docs/02_generating-passwords.mdx diff --git a/docs/02_updating-the-app.mdx b/docs/03_updating-the-app.mdx similarity index 100% rename from docs/02_updating-the-app.mdx rename to docs/03_updating-the-app.mdx diff --git a/docs/03_uninstalling.mdx b/docs/04_uninstalling.mdx similarity index 100% rename from docs/03_uninstalling.mdx rename to docs/04_uninstalling.mdx diff --git a/docs/04_references.mdx b/docs/05_references.mdx similarity index 100% rename from docs/04_references.mdx rename to docs/05_references.mdx diff --git a/docs/05_contributions.mdx b/docs/06_contributions.mdx similarity index 100% rename from docs/05_contributions.mdx rename to docs/06_contributions.mdx