{"id":26784495,"url":"https://github.com/image-js/image-js-docs","last_synced_at":"2026-07-01T03:32:49.564Z","repository":{"id":77636236,"uuid":"520883449","full_name":"image-js/image-js-docs","owner":"image-js","description":"Documentation site for the image-js library","archived":false,"fork":false,"pushed_at":"2026-02-23T14:40:41.000Z","size":42008,"stargazers_count":0,"open_issues_count":15,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-02-23T22:44:43.343Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://image-js-docs.pages.dev/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/image-js.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-08-03T13:04:33.000Z","updated_at":"2026-02-23T14:40:57.000Z","dependencies_parsed_at":"2023-10-01T20:58:31.967Z","dependency_job_id":"bd7a07eb-5678-4a48-9c62-445b77a358b1","html_url":"https://github.com/image-js/image-js-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/image-js/image-js-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/image-js%2Fimage-js-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/image-js%2Fimage-js-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/image-js%2Fimage-js-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/image-js%2Fimage-js-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/image-js","download_url":"https://codeload.github.com/image-js/image-js-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/image-js%2Fimage-js-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34992071,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-01T02:00:05.325Z","response_time":130,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2025-03-29T10:28:52.079Z","updated_at":"2026-07-01T03:32:49.505Z","avatar_url":"https://github.com/image-js.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# image-js-docs\n\nThis is the source code repository for the documentation of [image-js](https://github.com/image-js/image-js)\n\nThe documentation is available on \u003chttps://docs.image-js.org/\u003e.\n\n## Generating demo images\n\nTo regenerate the demo images (only needed when adding/updating images):\n\n```bash\nnpm run generate-images\n```\n\nThis will:\n\n- Fetch images from the URLs defined in `defaultImageUrls.ts`\n- Save them to the `static/` folder\n- Generate `imageData.json` with metadata\n\n## Create demos\n\nA demo is simply a function which takes an image or mask as input and returns an image or mask as output. When imported in `md` files, it will be transformed into a demo component which allows choosing from various image or video sources to showcase the image transformation.\n\n### Image example\n\nIn `docs/demos/gaussian-blur.demo.tsx`, define your demo function.\n\n```ts\nimport { Image } from 'image-js';\n\nexport default function blur(image: Image) {\n  return image.gaussianBlur({ sigma: 2 });\n}\n```\n\n### Mask example\n\nIn `docs/demos/invert-filter.mask.demo.tsx`, define your demo function.\n\n```ts\nimport { Mask } from 'image-js';\n\nexport default function invert(mask: Mask) {\n  return mask.invert();\n}\n```\n\n### Usage in markdown\n\nThen in `docs/page.md`, import and use the demo component.\n\n```markdown\nimport GaussianBlur from './demos/gaussian-blur.demo.tsx';\nimport MaskInvert from './demos/invert-filter.mask.demo.tsx';\n\n# Gaussian blur\n\n\u003cGaussianBlur /\u003e\n\n# Mask invert\n\n\u003cMaskInvert /\u003e\n```\n\n### Caveats\n\n1. The file must end with `.demo.tsx` for image filters and `.mask.demo.tsx` for masks to work. The file extension should be `.tsx`, even if the file does not render any JSX.\n2. For image demos, the file must export a default function, which takes an `image: Image` as input and returns an `Image` or a `Mask` as output.\n3. For mask demos, the file must export a default function, which takes an `image: Mask` as input and returns an `Image` or a `Mask` as output.\n4. The demo must only import from `image-js`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimage-js%2Fimage-js-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimage-js%2Fimage-js-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimage-js%2Fimage-js-docs/lists"}