Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme: Readability and convenience improvements #431

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 22 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,80 +6,83 @@

[Install](https://chrome.google.com/webstore/detail/prettier/fbcfnmplppajblbmdehballiekfgdkhp) the extension from the store.

## Usage

<!-- markdownlint-disable-next-line no-inline-html -->
Press <kbd>Control</kbd>+<kbd>Shift</kbd>+<kbd>,</kbd> (or <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>,</kbd> on macOS) in a `<textarea>` to format valid [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) that are contained inside.

## Development

### Install Dependencies

```
```sh
yarn
```

### Build

For a one-time build in production:

```
```sh
yarn build
```

#### Test in Chrome locally

To watch files and rebuild when files change in development:

```
```sh
yarn dev:chrome
```

# or
To load the extension in Chrome:

yan dev:firefox
```
- Chrome Settings > More Tools > Extensions...
- Turn on Developer mode
- Load unpacked > Select the `extension/chrome` directory

To open React devtools for the options page:

```
```sh
yarn react-devtools
```

- Chrome Settings > More Tools > Extensions...
- Turn on Developer mode
- Load unpacked > Select the `extension/chrome` directory

#### Test in Chrome locally
#### Test in Firefox locally

To watch files and rebuild when files change in development:

```
yarn build:firefox:dev
```sh
yarn dev:firefox
yarn launch:firefox
```

To open React devtools for the options page:

```
```sh
yarn react-devtools
```

### Lint files

```
```sh
yarn lint
```

### Format files

```
```sh
yarn format
```

### Run tests (to be added in the future)

```
```sh
yarn test-only
```

### Run all of the above

```
```sh
yarn test
```

Expand Down