Thanks to visit codestin.com
Credit goes to Github.com

Skip to content
Open
Show file tree
Hide file tree
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
18 changes: 13 additions & 5 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- run: npm i
- run: npm run lint:formatting
- run: npm run lint:check-frontmatter
- name: Install package manager
run: |
corepack enable
corepack prepare --activate
- run: pnpm i
- run: pnpm run lint:formatting
- run: pnpm run lint:check-frontmatter

check_quickstarts:
runs-on: ubuntu-latest
Expand All @@ -25,10 +29,14 @@ jobs:
git fetch origin ${{ github.base_ref }}
git checkout ${{ github.base_ref }}
git checkout ${{ github.sha }}
- run: npm i
- name: Install package manager
run: |
corepack enable
corepack prepare --activate
- run: pnpm i
- id: check
run: |
OUTPUT=$(npm run lint:check-quickstarts | tail -n +4)
OUTPUT=$(pnpm run lint:check-quickstarts | tail -n +4)
# We need this specific syntax because the output has multiple lines
echo "output<<EOF" >> $GITHUB_OUTPUT
echo "$OUTPUT" >> $GITHUB_OUTPUT
Expand Down
8 changes: 6 additions & 2 deletions .github/workflows/test-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,9 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- run: npm i
- run: npm run test
- name: Install package manager
run: |
corepack enable
corepack prepare --activate
- run: pnpm i
- run: pnpm run test
2 changes: 0 additions & 2 deletions .npmrc

This file was deleted.

3 changes: 2 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
data/api_errors.json
clerk-typedoc/
local-clerk-typedoc/
local-clerk-typedoc/
pnpm-lock.yaml
6 changes: 3 additions & 3 deletions contributing/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@ Clerk's documentation content is written in a variation of markdown called [MDX]

Clerk's documentation uses [`mdx-annotations`](https://www.npmjs.com/package/mdx-annotations) which provides a consistent way to apply props to markdown elements. This is utilized for various features such as [controlling image quality](#images-and-static-assets) and [defining code block line highlights](#highlighting).

MDX files ([including any code blocks](#prettier-integration)) are formatted using [a custom Prettier plugin](https://github.com/clerk/clerk-docs/blob/main/prettier-mdx.mjs). It is recommended to enable "format on save" (or similar) in your code editor, but the formatter can also be run manually on all files using `npm run format`.
MDX files ([including any code blocks](#prettier-integration)) are formatted using [a custom Prettier plugin](https://github.com/clerk/clerk-docs/blob/main/prettier-mdx.mjs). It is recommended to enable "format on save" (or similar) in your code editor, but the formatter can also be run manually on all files using `pnpm run format`.

## Project setup

1. Fork or clone the repo.
2. Run `npm install` to install dependencies.
2. Run `pnpm install` to install dependencies.
3. Create a branch for your PR with `git checkout -b pr/your-branch-name`.

> Tip: If you forked the repo, keep your `main` branch pointing at the original repository
Expand Down Expand Up @@ -123,7 +123,7 @@ Before committing your changes, run our linting checks to validate the changes y
To run all linting steps:

```shell
npm run lint
pnpm run lint
```

## Getting your contributions reviewed
Expand Down
Loading
Loading