Skip to content

Commit da37499

Browse files
committed
ID-458 Removed manifest stuff and explained it with example in getting-started
1 parent 597ec15 commit da37499

6 files changed

Lines changed: 11 additions & 24 deletions

File tree

docs/assets/pwa/manifest.json renamed to docs/_includes/getting-started/progressive-web-apps.html

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
<h2 id="pwa" class="page-header">Progressive Web Apps</h2>
2+
<p>We've included icons to help you set up your application as a Progressive Web App (PWA) if you want. You'll find them
3+
in the images folder with the form <em>pwa-icon-[size]x[size].png</em>.</p>
4+
5+
<p>Here's an example of a PWA manifest.json file you can update and use for your application:</p>
6+
7+
<pre>
18
{
29
"short_name": "ID7",
310
"name": "ID7 - University of Warwick brand",
@@ -22,18 +29,7 @@
2229
"scope": "/",
2330
"theme_color": "#A499F4",
2431
"description": "Standalone app for University of Warwick's ID7 brand",
25-
"screenshots": [
26-
{
27-
"src": "/dist/images/screenshot-540x720.jpg",
28-
"type": "image/jpg",
29-
"sizes": "540x720",
30-
"form_factor": "narrow"
31-
},
32-
{
33-
"src": "/dist/images/screenshot-720x540.jpg",
34-
"type": "image/jpg",
35-
"sizes": "720x540",
36-
"form_factor": "wide"
37-
}
38-
]
3932
}
33+
</pre>
34+
35+
<p>There's more you can do with PWAs if you're intending for people to actually install your app. See <a href="https://web.dev/learn/pwa?hl=en">web.dev's guidelines</a> for more.</p>

docs/_includes/header-borderless.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@
3737
<meta name="msapplication-TileImage" content="/dist/images/mstile-144x144.png">
3838
<meta name="theme-color" content="#204f79">
3939

40-
<link rel="manifest" href="/dist/docs/pwa/manifest.json">
41-
4240
<title>
4341
{% if page.layout == "home" %}
4442
{{ page.title }}

docs/_includes/header-wide.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,6 @@
3333
<link rel="icon" href="/dist/images/favicon-dark-mode-96x96.png" type="image/png" media="(prefers-color-scheme: dark)" sizes="96x96">
3434
<link rel="icon" href="/dist/images/favicon-dark-mode-192x192.png" type="image/png" media="(prefers-color-scheme: dark)" sizes="192x192">
3535

36-
<link rel="manifest" href="/dist/docs/pwa/manifest.json">
37-
3836
<meta name="msapplication-TileColor" content="#204f79">
3937
<meta name="msapplication-TileImage" content="/dist/images/mstile-144x144.png">
4038
<meta name="theme-color" content="#204f79">

docs/_includes/header.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@
3737
<meta name="msapplication-TileImage" content="/dist/images/mstile-144x144.png">
3838
<meta name="theme-color" content="#204f79">
3939

40-
<link rel="manifest" href="/dist/docs/pwa/manifest.json">
41-
4240
<title>
4341
{% if page.layout == "home" %}
4442
{{ page.title }}

docs/getting-started/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
{% include getting-started/template.html %}
1313
{% include getting-started/security-headers.html %}
1414
{% include getting-started/browser-and-device-support.html %}
15+
{% include getting-started/progressive-web-apps.html %}
1516
</section>
1617
<aside class="col-sm-3">
1718
<div class="id7-docs-sidebar" role="complementary">

webpack.config.babel.js

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,6 @@ const docsConfig = merge([
154154
ignore: ['*.less', '*.js'],
155155
to: path.join(paths.DOCS_ASSETS, 'docs/site'),
156156
},
157-
{
158-
from: './docs/assets/pwa',
159-
to: path.join(paths.DOCS_ASSETS, 'docs/pwa'),
160-
},
161157
]),
162158
],
163159
},

0 commit comments

Comments
 (0)