https://github.com/yardinternet/wp-webmanifest
Creates web app manifests
https://github.com/yardinternet/wp-webmanifest
Last synced: about 15 hours ago
JSON representation
Creates web app manifests
- Host: GitHub
- URL: https://github.com/yardinternet/wp-webmanifest
- Owner: yardinternet
- License: mit
- Created: 2024-10-28T12:43:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-06-16T01:21:17.000Z (13 days ago)
- Last Synced: 2026-06-16T03:13:59.889Z (13 days ago)
- Language: PHP
- Size: 521 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# wp-webmanifest
[](https://github.com/yardinternet/yard-webmanifest/actions/workflows/format-php.yml)
[](https://github.com/yardinternet/yard-webmanifest/actions/workflows/phpstan.yml)
[](https://github.com/yardinternet/yard-webmanifest/actions/workflows/run-tests.yml)
[](https://github.com/yardinternet/yard-webmanifest/actions/workflows/badges.yml)
[](https://github.com/yardinternet/yard-webmanifest/actions/workflows/badges.yml)
This package for WordPress (Sage & Acorn) automatically generates a
[manifest.webmanifest](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Manifest) JSON file.
It also creates maskable versions of the favicon that will be used as
the [icons](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Manifest/Reference/icons).
## Requirements
- [Sage](https://github.com/roots/sage) >= 10.0
- [Acorn](https://github.com/roots/acorn) >= 4.0
## Installation
To install this package using Composer, follow these steps:
1. Install this package with Composer:
```sh
composer require yard/webmanifest
```
2. Run the Acorn WP-CLI command to discover this package:
```shell
wp acorn package:discover
```
You can publish the config file with:
```shell
wp acorn vendor:publish --provider="Yard\Webmanifest\WebmanifestServiceProvider"
```
## Usage
In theory you don't have to do anything, the Webmanifest works out of the box.
This packages uses the favicon set in the theme to generate icons.
But you can alter behavior via the configuration.
### Manually configuring icons
You can do this by adding them to the `icons` array in the [config](./config/webmanifest.php)
```php
'icons' => [
[
'src' => 'path/to/icon.png',
'sizes' => '192x192',
'type' => 'image/png',
],
],
```
### Theme settings
You can set the background and theme color by changing the config values below.
```php
'background_color' => '#add8eb',
'theme_color' => '#ffffff',
```
### Icon sizes
```php
'iconSizes' => [192, 384, 512, 1024],
```
### Webmanifest URL path
```php
'url' => '/manifest.webmanifest',
```
### Webmanifest icons url
```php
'iconUrl' => '/webmanifest/icon',
```
## About us
[](https://www.yard.nl/werken-bij/)