Added remark-cli and pnpm lock file resolution logic

.github/workflows/lint.yaml

@@ -5,7 +5,7 @@ env:
 
 permissions:
   contents: read
-  pull-requests: write 
+  pull-requests: write
 
 on:
   push:
@@ -22,14 +22,11 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Install pnpm
-        uses: pnpm/action-setup@v4
+      - name: Install pixi
+        run: curl -fsSL https://pixi.sh/install.sh | bash
 
-      - name: remark-lint
-        uses: reviewdog/action-remark-lint@v5
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          reporter: github-pr-check
-          fail_level: "warning"
-          level: "warning"
-          remark_args: "--use=remark-preset-lint-recommended --use=remark-mdx"
+      - name: Set up pixi in $PATH
+        run: echo "$HOME/.pixi/bin" >> $GITHUB_PATH
+
+      - name: Run linting check
+        run: pixi run lint

.npmrc

@@ -0,0 +1 @@
+git-branch-lockfile=true

README.md

@@ -1,5 +1,71 @@
 # Research Technology Services @ NYU
 
+## For development locally 
+
+Please make sure to install [`pixi shell`](https://pixi.sh/latest/#installation), to install on Linux/MacOS run:
+
+```
+curl -fsSL https://pixi.sh/install.sh | bash
+```
+
+Verify pixi installation by running:
+
+```
+pixi help
+```
+
+To Create a local pixi `shell` then to install `pnpm` and `nodejs` run:
+
+```
+pixi install
+```
+
+> You may check the `pixi.toml` file for information on pnpm version and pixi scripts.
+
+Activate the `shell` by running:
+
+```
+pixi shell
+```
+
+Install `npm packages` using `pnpm` within this shell:
+
+```
+pnpm install
+```
+
+Build `docusaurus site` by running:
+
+```
+pnpm build
+```
+
+Serve the site with:
+
+```
+pnpm serve
+```
+
+To conduct a `linting` check with `remark-cli` run:
+
+```
+pnpm lint
+```
+
+To remove all node packages for downloading and building from scratch, exit pixi shell by running `exit`, then dry run `git clean`:
+
+```
+git clean -nXd
+```
+
+Check which files and directories will be removed, then to actually remove these files run:
+
+```
+git clean -fXd
+```
+
+Once done, you may begin from the start with `pixi install`.
+
 ## Deploy locally:
 On Linux/Macos run:
 ```

package.json

@@ -12,7 +12,15 @@
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
-    "typecheck": "tsc"
+    "typecheck": "tsc",
+    "lint": "remark --frail ."
+  },
+  "remarkConfig": {
+    "plugins": [
+      "remark-preset-lint-recommended",
+      "remark-mdx",
+      ["remark-lint-list-item-indent", false]
+    ]
   },
   "dependencies": {
     "@docusaurus/core": "^3.7.0",
@@ -27,6 +35,11 @@
     "@docusaurus/module-type-aliases": "^3.7.0",
     "@docusaurus/tsconfig": "^3.7.0",
     "@docusaurus/types": "^3.7.0",
+    "remark-cli": "^12.0.1",
+    "remark-lint-list-item-indent": "^4.0.1",
+    "remark-mdx": "^3.1.0",
+    "remark-preset-lint-consistent": "^6.0.1",
+    "remark-preset-lint-recommended": "^7.0.1",
     "typescript": "~5.7.3"
   },
   "browserslist": {

pixi.toml

@@ -9,6 +9,7 @@ version = "0.1.0"
 install = { cmd = ["pnpm", "install"] }
 build = { cmd = ["pnpm", "build"], depends-on = ["install"] }
 serve = { cmd = ["pnpm", "serve"], depends-on = ["build"] }
+lint = { cmd = ["pnpm", "lint"], depends-on = ["install"] }
 
 [dependencies]
 nodejs = ">=22.12.0,<22.14"