Merge pull request #84 from devmount/chores/pnpm-migration

📦️ Migrate to pnpm, update deps and docs

Author: devmount

.github/CONTRIBUTING.md

@@ -60,8 +60,8 @@ Testing the current state and reporting bugs is a great way to help! Here's how:
 ```bash
 git clone https://github.com/devmount/sloth.css
 cd sloth.css
-npm i
-npm run docs:serve
+pnpm install
+pnpm docs:serve
 ```
 
 Now you can check <http://localhost:8080> (or the next available free port) to have the documentation pages served right from the latest repository state. If you run into any problems or find any issues, create a [bug report](https://github.com/devmount/sloth.css/issues/new?assignees=&labels=bug&projects=&template=bug_report.md) or start [a discussion thread](https://github.com/devmount/sloth.css/discussions).

.github/workflows/docs.yml

@@ -15,17 +15,15 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
+      - uses: actions/checkout@v6
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v6
       - name: Build docs
         run: |
-          npm ci
-          npm run docs:build
+          pnpm install
+          pnpm docs:build
       - name: Push Build files to prod
-        uses: burnett01/rsync-deployments@7.0.1
+        uses: burnett01/rsync-deployments@v8
         with:
           switches: -avzr --delete
           path: docs/public/

README.md

@@ -18,10 +18,10 @@ Check [the documentation](https://slothcss.devmount.com) to see it live in actio
 
 ## Installation
 
-See the [installation instructions](https://slothcss.devmount.com/getting-started/installation) for different setup options. Add it to your project's dependencies:
+See the [installation instructions](https://slothcss.devmount.com/getting-started/installation) for different setup options. Add it to your project's dependencies, e.g.:
 
 ```bash
-npm i @devmount/sloth.css
+pnpm add @devmount/sloth.css
 ```
 
 Or for a quick start include the following CSS file in your HTML head to get the complete package (drop-in core styles, utility classes and CSS components):

docs/pages/getting-started/contributing.md

@@ -59,8 +59,8 @@ Testing the current state and reporting bugs is a great way to help! Here's how:
 ```bash
 git clone {{ repoUrl }}/sloth.css
 cd sloth.css
-npm i
-npm run docs:serve
+pnpm install
+pnpm docs:serve
 ```
 
 Now you can check <http://localhost:8080> (or the next available free port) to have the documentation pages served right from the latest repository state. If you run into any problems or find any issues, create a [bug report]({{ repoUrl }}/sloth.css/issues/new?assignees=&labels=bug&projects=&template=bug_report.md) or start [a discussion thread]({{ repoUrl }}/sloth.css/discussions).

docs/pages/getting-started/installation.md

@@ -1,12 +1,12 @@
 ---
 title: 'Installation - Sloth.css'
 description: Installation instructions and how to get started
-tags: cdn npm drop-in setup download
+tags: cdn npm pnpm drop-in setup download
 ---
 
 ## Installation
 
-You can load Sloth.css directly via CDN or by installing it manually or via NPM. You can choose between 3 different variants according to your needs:
+You can load Sloth.css directly via CDN, install it manually or use a package manager. You can choose between 3 different variants according to your needs:
 
 1. `sloth.core.min.css`: Drop-in styling for semantic markup
 2. `sloth.util.min.css`: Utility classes for quick prototyping
@@ -38,15 +38,15 @@ Download the latest [Sloth.css release]({{ repoUrl }}/releases) (7.5KB):
 
 Extract the CSS files you need and include them in your markup or your bundler.
 
-### Install via NPM
+### Install via package manager
 
-If you don't want to use the CDN or manual download, you can install Sloth.css via npm with the following command.
+If you don't want to use the CDN or manual download, you can add Sloth.css via the package manager of your choice, e.g.:
 
 ```bash
-npm i @devmount/sloth.css
+pnpm add @devmount/sloth.css
 ```
 
-Now you need to make one of the CSS files under `node_modules/@devmount/sloth.css/` you want available to your app or include it in your build step or bundler. Since Sloth.css already serves minified styles, the simplest way would be to just include the file you want in your CSS, e.g.:
+Now you need to make one of the CSS files under `node_modules/@devmount/sloth.css/` available to your app or include it in your build step or bundler. Since Sloth.css already serves minified styles, the simplest way would be to just include the file you want in your CSS, e.g.:
 
 ```css
 @import '@devmount/sloth.css/sloth.min.css';