Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Shinigami92 committed Sep 23, 2023
1 parent 8ba5e36 commit b9dd294
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 44 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ At first: Thank you for being interested and using my plugin. :smiley_cat:
# Basic steps

1. Create a fork and checkout your fork.
2. Run `./release.sh` or at least the `Cleanup` and `Prepare` steps in this script.
2. Run `pnpm run preflight`.
3. Create an issue for your feature or fix.
4. Create a `Draft` pull request that also references your created issue.
<img src="https://user-images.githubusercontent.com/7195563/94909445-78ee5e00-04a3-11eb-8c9b-8e743c6d6c0e.png" width="197px" />
Expand Down
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,11 @@ pnpm add --save-dev prettier @prettier/plugin-pug
## Usage

```bash
npx prettier --write "**/*.pug"
npx prettier --write "**/*.pug" --plugin="@prettier/plugin-pug"
# or
yarn prettier --write "**/*.pug"
yarn prettier --write "**/*.pug" --plugin="@prettier/plugin-pug"
# or
pnpm prettier --write "**/*.pug"
pnpm prettier --write "**/*.pug" --plugin="@prettier/plugin-pug"
```

## Configuration
Expand Down Expand Up @@ -116,9 +116,7 @@ If you’re interested in contributing to the development of Prettier for Pug, y
To run `@prettier/plugin-pug` locally:

- Clone this repository.
- Execute `pnpm install`.
- Execute `pnpm run lint` to make sure that the code passes formatting and linting.
- Execute `pnpm run test` to make sure that TypeScript successfully compiles into JavaScript and all unit tests pass.
- Execute `pnpm run preflight`.

## Credits

Expand Down
6 changes: 3 additions & 3 deletions docs/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ Format all pug files in your project:
::: code-group

```shell [npm]
npx prettier --write "**/*.pug"
npx prettier --write "**/*.pug" --plugin="@prettier/plugin-pug"
```

```shell [pnpm]
pnpm prettier --write "**/*.pug"
pnpm prettier --write "**/*.pug" --plugin="@prettier/plugin-pug"
```

```shell [yarn]
yarn prettier --write "**/*.pug"
yarn prettier --write "**/*.pug" --plugin="@prettier/plugin-pug"
```

:::
Expand Down
34 changes: 0 additions & 34 deletions release.sh

This file was deleted.

0 comments on commit b9dd294

Please sign in to comment.