From 210b54d35d7f9b6fd0e926271e89e247f8faa4b7 Mon Sep 17 00:00:00 2001 From: Olivier Tassinari Date: Wed, 30 Aug 2017 21:10:06 +0200 Subject: [PATCH] docs(API): explain a bit more publicPath --- .eslintignore | 1 + README.md | 1 + docs/src/Body.js | 6 +- docs/src/Footer.js | 20 +- docs/src/Head.js | 8 +- docs/src/Main.js | 10 +- package.json | 34 +- yarn.lock | 862 ++++++++++++++++++++++++++++----------------- 8 files changed, 576 insertions(+), 366 deletions(-) diff --git a/.eslintignore b/.eslintignore index 85dd5dd..49878e9 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1,3 +1,4 @@ +node_modules /lib /docs/dist /flow/interfaces diff --git a/README.md b/README.md index a7d5925..d554242 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,7 @@ Exclude matched assets from being added to the `serviceWorkerOption.assets` vari Include matched assets added to the `serviceWorkerOption.assets` variable. (Whitelist) - `publicPath`, *string*, default `'/'`: Specifies the public URL address of the output files when referenced in a browser. +We use this value to load the service worker over the network. - `template`, *function*, default noop: This callback function can be used to inject statically generated service worker. It's taking a `serviceWorkerOption` argument and must return a promise. diff --git a/docs/src/Body.js b/docs/src/Body.js index 62fdd29..2a84fcc 100644 --- a/docs/src/Body.js +++ b/docs/src/Body.js @@ -11,11 +11,7 @@ const styles = { const Body = props => { const { children } = props - return ( -
- {children} -
- ) + return
{children}
} Body.propTypes = { diff --git a/docs/src/Footer.js b/docs/src/Footer.js index 32cce89..04da3f3 100644 --- a/docs/src/Footer.js +++ b/docs/src/Footer.js @@ -8,28 +8,18 @@ const Footer = props => { return ( diff --git a/docs/src/Head.js b/docs/src/Head.js index e6168fb..5dc0477 100644 --- a/docs/src/Head.js +++ b/docs/src/Head.js @@ -7,12 +7,8 @@ const Head = props => { return (
-

- {name} -

-

- {description} -

+

{name}

+

{description}

{children}
) diff --git a/docs/src/Main.js b/docs/src/Main.js index f8cddac..f07214f 100644 --- a/docs/src/Main.js +++ b/docs/src/Main.js @@ -75,9 +75,7 @@ class Main extends Component { -

- {'Logs'} -

+

{'Logs'}