Skip to content

Commit

Permalink
Merge pull request #4 from josh-wong/change-syntax-to-docusaurus
Browse files Browse the repository at this point in the history
Change syntax in docs from Material for MkDocs to Docusaurus; revise text; change Markdown file extension
  • Loading branch information
josh-wong authored May 19, 2024
2 parents 0d109c8 + cc49df0 commit 0e6ff67
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 24 deletions.
9 changes: 6 additions & 3 deletions docs/index.md → docs/01_overview.mdx
Original file line number Diff line number Diff line change
@@ -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

<!-- ## Auto width for passGen download button -->
[: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 }
<CardRowPassGen />

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.
19 changes: 13 additions & 6 deletions docs/generating-passwords.md → docs/02_generating-passwords.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,33 @@
# 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

To create a 14-character password containing **symbols**, **numbers**, **uppercase letters**, and **lowercase letters**, select **Create a password with symbols**.

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

To create a 14-character password containing **numbers**, **uppercase letters**, and **lowercase letters**, select **Create a password without symbols**.

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

Expand Down
10 changes: 6 additions & 4 deletions docs/updating-the-app.md → docs/03_updating-the-app.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# 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.

![Example: Updating the app](https://github.com/josh-wong/passGen/blob/main/docs/assets/screenshots/update-available.png?raw=true)

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).

:::
7 changes: 7 additions & 0 deletions docs/04_uninstalling.mdx
Original file line number Diff line number Diff line change
@@ -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)
File renamed without changes.
File renamed without changes.
11 changes: 0 additions & 11 deletions docs/uninstalling.md

This file was deleted.

0 comments on commit 0e6ff67

Please sign in to comment.