diff --git a/docs/index.md b/docs/01_overview.mdx similarity index 54% rename from docs/index.md rename to docs/01_overview.mdx index 9a360a5..72d6a5e 100644 --- a/docs/index.md +++ b/docs/01_overview.mdx @@ -1,11 +1,14 @@ -# 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). + +After downloading passGen, double-click the installation file to install the app. diff --git a/docs/generating-passwords.md b/docs/02_generating-passwords.mdx similarity index 63% rename from docs/generating-passwords.md rename to docs/02_generating-passwords.mdx index 1912a1d..949e45d 100644 --- a/docs/generating-passwords.md +++ b/docs/02_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 @@ -8,9 +11,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 +23,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/updating-the-app.md b/docs/03_updating-the-app.mdx similarity index 57% rename from docs/updating-the-app.md rename to docs/03_updating-the-app.mdx index aaf6373..61d9afa 100644 --- a/docs/updating-the-app.md +++ b/docs/03_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. @@ -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). + +::: diff --git a/docs/04_uninstalling.mdx b/docs/04_uninstalling.mdx new file mode 100644 index 0000000..cf33650 --- /dev/null +++ b/docs/04_uninstalling.mdx @@ -0,0 +1,7 @@ +# Uninstall passGen + +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**. + +![Example: Uninstalling passGen](https://github.com/josh-wong/passGen/blob/main/docs/assets/screenshots/uninstall.gif?raw=true) diff --git a/docs/references.md b/docs/05_references.mdx similarity index 100% rename from docs/references.md rename to docs/05_references.mdx diff --git a/docs/contributions.md b/docs/06_contributions.mdx similarity index 100% rename from docs/contributions.md rename to docs/06_contributions.mdx diff --git a/docs/uninstalling.md b/docs/uninstalling.md deleted file mode 100644 index 02da3b3..0000000 --- a/docs/uninstalling.md +++ /dev/null @@ -1,11 +0,0 @@ -# How to uninstall passGen - -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**. - -!!! example - - Uninstalling passGen - - ![Example: Uninstalling passGen](https://github.com/josh-wong/passGen/blob/main/docs/assets/screenshots/uninstall.gif?raw=true)