remove build output from repo

.github/actions/install-deps/action.yml

@@ -4,22 +4,29 @@ description: Setup action
 runs:
   using: "composite"
   steps:
-    - name: Use nodejs
-      uses: actions/setup-node@v3
+    - name: Setup Node
+      uses: actions/setup-node@v4
       with:
-        node-version: 16.18
+        node-version: 18
 
-    - name: restore workspace cache
-      uses: actions/cache@v3
-      id: node_modules
+    - uses: pnpm/action-setup@v3
       with:
-        path: |
-          node_modules
-          packages/*/node_modules
-        key: node-modules-v2-${{ runner.os }}-${{ steps.node-version.outputs.version }}-${{ hashFiles('yarn.lock', 'patches/*.patch') }}
+        version: 8
+        run_install: false
+
+    - name: Get pnpm store directory
+      shell: bash
+      run: |
+        echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+    - uses: actions/cache@v4
+      name: Setup pnpm cache
+      with:
+        path: ${{ env.STORE_PATH }}
+        key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
         restore-keys: |
-          node-modules-v2-${{ runner.os }}-${{ steps.node-version.outputs.version }}-
+          ${{ runner.os }}-pnpm-store-
 
-    - run: yarn install --frozen-lockfile --network-timeout 9000000
-      if: steps.node_modules.outputs.cache-hit != 'true'
+    - name: Install dependencies
       shell: bash
+      run: pnpm install

.github/workflows/deploy-website.yml

@@ -0,0 +1,53 @@
+name: Deploy Website
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: ./.github/actions/install-deps
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+
+      - name: Build with Astro
+        run: |
+          pnpm astro build \
+            --site "${{ steps.pages.outputs.origin }}" \
+            --base "${{ steps.pages.outputs.base_path }}"
+        working-directory: packages/docs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: packages/docs/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -8,6 +8,8 @@ pids
 *.pid
 *.seed
 
+packages/docs/src/content/docs/api/**
+
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov
 

README.md

@@ -6,71 +6,6 @@
   <p>An image processing library for Node written entirely in JavaScript, with zero native dependencies</p>
 </div>
 
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-- [Installation](#installation)
-- [Supported Image Types](#supported-image-types)
-- [Image Manipulation Methods (Default Plugins)](#image-manipulation-methods-default-plugins)
-- [Extra Plugins](#extra-plugins)
-- [Custom Jimp](#custom-jimp)
-- [Contributing](#contributing)
-- [License](#license)
-- [Project Using Jimp](#project-using-jimp)
-- [Contributors ✨](#contributors-)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-
-> ## Notice of potentially breaking change
->
-> As of v0.10.4, core-js is no longer included with jimp or its extensions. If you rely on core-js, install it with either `yarn add core-js` or `npm i core-js`
-
-> ## Read before installing
->
-> Please be aware that Jimp is built on JavaScript implementations of image formats so in some cases that might [allocate a lot of memory](https://github.com/jimp-dev/jimp/issues/153) before using.
-
-## Installation
-
-Installation: `npm install --save jimp`
-
-API documentation can be found in the main [jimp package](./packages/jimp)
-
-## Supported Image Types
-
-- [bmp](./packages/type-bmp)
-- [gif](./packages/type-gif)
-- [jpeg](./packages/type-jpeg)
-- [png](./packages/type-png)
-- [tiff](./packages/type-tiff)
-
-## Image Manipulation Methods (Default Plugins)
-
-- [blit](./packages/plugin-blit) - Blit an image onto another.
-- [blur](./packages/plugin-blur) - Quickly blur an image.
-- [color](./packages/plugin-color) - Various color manipulation methods.
-- [contain](./packages/plugin-contain) - Contain an image within a height and width.
-- [cover](./packages/plugin-cover) - Scale the image to the given width and height keeping the aspect ratio.
-- [displace](./packages/plugin-displace) - Displaces the image based on a displacement map
-- [dither](./packages/plugin-dither) - Apply a dither effect to an image.
-- [flip](./packages/plugin-flip) - Flip an image along its x or y axis.
-- [gaussian](./packages/plugin-gaussian) - Hardcore blur.
-- [invert](./packages/plugin-invert) - Invert an images colors
-- [mask](./packages/plugin-mask) - Mask one image with another.
-- [normalize](./packages/plugin-normalize) - Normalize the colors in an image
-- [print](./packages/plugin-print) - Print text onto an image
-- [resize](./packages/plugin-resize) - Resize an image.
-- [rotate](./packages/plugin-rotate) - Rotate an image.
-- [scale](./packages/plugin-scale) - Uniformly scales the image by a factor.
-
-## Extra Plugins
-
-- [circle](./packages/plugin-circle) - Creates a circle out of an image.
-- [shadow](./packages/plugin-shadow) - Creates a shadow on an image.
-- [fisheye](./packages/plugin-fisheye) - Apply a fisheye effect to an image.
-- [threshold](./packages/plugin-threshold) - Lighten an image. Good for scanned drawing and signatures.
-
-:rocket: If you want to add your plugins to this list make a PR! :rocket:
-
 ## Custom Jimp
 
 If you want to extend jimp or omit types or functions visit [@jimp/custom](./packages/custom).
@@ -80,40 +15,8 @@ If you want to extend jimp or omit types or functions visit [@jimp/custom](./pac
 
 ## Contributing
 
-Basically clone, change, test, push and pull request.
-
 Please read the [CONTRIBUTING documentation](CONTRIBUTING.md).
 
-## License
-
-Jimp is licensed under the MIT license. Open Sans is licensed under the Apache license
-
-## Project Using Jimp
-
-:star: [node-vibrant](https://www.npmjs.com/package/node-vibrant) - Extract prominent colors from an image.
-
-:star: [lqip](https://www.npmjs.com/package/lqip) - Low Quality Image Placeholders (LQIP) Module for Node
-
-:star: [webpack-pwa-manifest](https://www.npmjs.com/package/webpack-pwa-manifest) - A webpack plugin that generates a 'manifest.json' for your Progressive Web Application, with auto icon resizing and fingerprinting support.
-
-:star: [wdio-screenshot](https://www.npmjs.com/package/wdio-screenshot) - A WebdriverIO plugin. Additional commands for taking screenshots with WebdriverIO.
-
-:star: [asciify-image](https://www.npmjs.com/package/asciify-image) - Convert images to ASCII art
-
-:star: [node-sprite-generator](https://www.npmjs.com/package/node-sprite-generator) - Generates image sprites and their spritesheets (css, stylus, sass, scss or less) from sets of images. Supports retina sprites.
-
-:star: [merge-img](https://www.npmjs.com/package/merge-img) - Merge multiple images into a single image
-
-:star: [postcss-resemble-image](https://www.npmjs.com/package/postcss-resemble-image) - Provide a gradient fallback for an image that loosely resembles the original.
-
-:star: [differencify](https://www.npmjs.com/package/differencify) - Perceptual diffing tool
-
-:star: [gifwrap](https://www.npmjs.com/package/gifwrap) - A Jimp-compatible library for working with GIFs
-
-:star: [replace-color](https://www.npmjs.com/package/replace-color) - Replace color with another one pixel by pixel
-
-:star: [handwritten.js](https://www.npmjs.com/package/handwritten.js) - Convert typed text to realistic handwriting!
-
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

TODO.md

@@ -1,6 +1,5 @@
 ## Guides
 
-- [ ] Getting Started
 - [ ] Custom Jimp
 - [ ] Authoring Plugins
 - [] Using in Browser

packages/config-eslint/package.json

@@ -2,6 +2,7 @@
   "name": "@jimp/config-eslint",
   "version": "0.0.0",
   "license": "MIT",
+  "private": true,
   "scripts": {
     "clean": "rm -rf node_modules"
   },
@@ -13,4 +14,4 @@
     "eslint-plugin-only-warn": "^1.1.0",
     "typescript": "^5.4.2"
   }
-}
+}

packages/config-vitest/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@jimp/config-vitest",
   "version": "1.0.0",
+  "private": true,
   "repository": "jimp-dev/jimp",
   "scripts": {
     "lint": "eslint .",

packages/docs/astro.config.mjs

@@ -36,8 +36,10 @@ export default defineConfig({
           label: "Docs",
           items: [
             // Each item here is one entry in the navigation menu.
-            { label: "Example Guide", link: "/guides/example/" },
+            { label: "Getting Started", link: "/guides/getting-started/" },
             { label: "Using in Browser", link: "/guides/browser/" },
+            { label: "Writing Plugins", link: "/guides/writing-plugins/" },
+            { label: "Custom Jimp", link: "/guides/custom-jimp/" },
           ],
         },
         typeDocSidebarGroup,

packages/docs/package.json

@@ -7,7 +7,7 @@
     "lint": "eslint .",
     "dev": "astro dev",
     "start": "astro dev",
-    "build-off": "astro check && astro build",
+    "build-website": "rm -rf dist && astro check && astro build",
     "preview": "astro preview",
     "astro": "astro"
   },