docs(links): hide back to readme links (#24)

americanexpress · Aug 28, 2020 · 51ded8b · 51ded8b
1 parent e4db567
commit 51ded8b
Show file tree

Hide file tree

Showing 20 changed files with 52 additions and 28 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,4 @@ dist
 /index.*
 
 one*tgz
+.idea
diff --git a/docs/Demo.md b/docs/Demo.md
@@ -1,6 +1,7 @@
 # One Service Worker Demo
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../README.md)
+<!--ONE-DOCS-HIDE end-->
 
 For convenience, we have a demo project to run for exploring the service worker
 and the library. We've bound a few `npm` scripts that can be run to manage the demo.

diff --git a/docs/Development.md b/docs/Development.md
@@ -1,6 +1,8 @@
 # Developing with the library
 
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../README.md)
+<!--ONE-DOCS-HIDE end-->
 
 For those developing in this library, there are several tools to create a richer
 DX for users and better explanation of failures during library usage.

diff --git a/docs/api/Cache.md b/docs/api/Cache.md
@@ -12,9 +12,11 @@
 
 # Cache
 
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `API`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 ## 📖 Table of Contents
 
@@ -594,4 +596,4 @@ export async function deleteMetaForKey(key) {
 
 &nbsp;
 
-[☝️ Return To Top](#-&#x1F4D6;-table-of-contents)
+[☝️ Return To Top](#-&#x1F4D6;-table-of-contents)
diff --git a/docs/api/Core.md b/docs/api/Core.md
@@ -29,10 +29,11 @@
 [handbook-docs]: ../../docs/Handbook.md
 
 # Core
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `API`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 ## 📖 Table of Contents
 
@@ -499,4 +500,4 @@ export async function getAllTags() {
 
 &nbsp;
 
-[☝️ Return To Top](#-&#x1F4D6;-table-of-contents)
+[☝️ Return To Top](#-&#x1F4D6;-table-of-contents)
diff --git a/docs/api/Errors.md b/docs/api/Errors.md
@@ -1,8 +1,9 @@
 # Errors
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `API`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 ## 📖 Table of Contents
 
@@ -97,4 +98,4 @@ exception.reject().catch(onError);
 
 &nbsp;
 
-[☝️ Return To Top](#-&#x1F4D6;-table-of-contents)
+[☝️ Return To Top](#-&#x1F4D6;-table-of-contents)
diff --git a/docs/api/Events.md b/docs/api/Events.md
@@ -1,8 +1,9 @@
 # Event System
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `API`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 ## 📖 Table of Contents
 
@@ -251,4 +252,4 @@ createMiddlewareContext({
 
 &nbsp;
 
-[☝️ Return To Top](#-&#x1F4D6;-table-of-contents)
+[☝️ Return To Top](#-&#x1F4D6;-table-of-contents)
diff --git a/docs/api/Middleware.md b/docs/api/Middleware.md
@@ -5,10 +5,11 @@
 [cache-clear-docs]: ../cache/README.md#clear
 
 # Service Worker Middleware
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `API`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 ## 📖 Table of Contents
 

diff --git a/docs/api/README.md b/docs/api/README.md
@@ -1,4 +1,6 @@
+<!--ONE-DOCS-HIDE start-->
 [👈 Return to README](../../README.md)
+<!--ONE-DOCS-HIDE end-->
 
 # 🎛️ API
 

diff --git a/docs/api/Runtime.md b/docs/api/Runtime.md
@@ -1,8 +1,9 @@
 # Runtime
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `API`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 ## 📖 Table of Contents
 

diff --git a/docs/api/Validation.md b/docs/api/Validation.md
@@ -1,8 +1,9 @@
 # Validation
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `API`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 ## 📖 Table of Contents
 
@@ -64,4 +65,4 @@ const cacheOptions = {
 
 &nbsp;
 
-[☝️ Return To Top](#-&#x1F4D6;-table-of-contents)
+[☝️ Return To Top](#-&#x1F4D6;-table-of-contents)
diff --git a/docs/recipes/Analytics.md b/docs/recipes/Analytics.md
@@ -1,8 +1,9 @@
 # Analytics
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `Recipes`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 ### Overview
 
@@ -291,4 +292,4 @@ register('/sw.js', {
 
 ```
 
-[☝️ Return To Top](#-analytics)
+[☝️ Return To Top](#-analytics)
diff --git a/docs/recipes/Basics.md b/docs/recipes/Basics.md
@@ -1,8 +1,9 @@
 # Service Worker Basics
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `Recipes`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 ## 📖 Table of Contents
 
@@ -300,4 +301,4 @@ on('message', [
 
 ```
 
-[☝️ Return To Top](#-service-worker-basics)
+[☝️ Return To Top](#-service-worker-basics)
diff --git a/docs/recipes/BestPractices.md b/docs/recipes/BestPractices.md
@@ -1,10 +1,11 @@
 [clear-site-data-header]: https://w3c.github.io/webappsec-clear-site-data/#example-killswitch
 
 # Best Practices
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `Recipes`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 ## 📖 Table of Contents
 
@@ -126,4 +127,4 @@ It might be beneficial to create an `html` document that would be cached on
 lifecycle events for users to manually intervene and manage the cache on their
 browser as well as remove the service worker altogether.
 
-[☝️ Return To Top](#-&#x1F4D6;-table-of-contents)
+[☝️ Return To Top](#-&#x1F4D6;-table-of-contents)
diff --git a/docs/recipes/Cache.md b/docs/recipes/Cache.md
@@ -2,10 +2,11 @@
 [cache-api]: https://developer.mozilla.org/en-US/docs/Web/API/Cache
 
 # Caching
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `Recipes`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 With the [`caches` CacheStorage][cache-storage-api] and [`cache` Cache][cache-api], we can create and manage
 a service worker first caching solution.
@@ -92,4 +93,4 @@ is when you are sure you want to handle the `fetch` response.
 })();
 ```
 
-[☝️ Return To Top](#-caching)
+[☝️ Return To Top](#-caching)
diff --git a/docs/recipes/Patterns.md b/docs/recipes/Patterns.md
@@ -1,8 +1,9 @@
 # Patterns
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `Recipes`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 ## Scope based service worker scripts
 
@@ -88,4 +89,4 @@ An advantage of scope based service workers is having the client-side decide whe
 to register a service worker at a given scope, based on the needs of the client
 side component.
 
-[☝️ Return To Top](#-patterns)
+[☝️ Return To Top](#-patterns)
diff --git a/docs/recipes/README.md b/docs/recipes/README.md
@@ -1,4 +1,6 @@
+<!--ONE-DOCS-HIDE start-->
 [👈 Return to README](../../README.md)
+<!--ONE-DOCS-HIDE end-->
 
 # 👩‍🍳 Recipes
 
@@ -11,4 +13,4 @@
 * [With React](./WithReact.md)
 * [Testing A Service Worker](./Testing.md)
 
-[☝️ Return To Top](#-recipes)
+[☝️ Return To Top](#-recipes)
diff --git a/docs/recipes/Testing.md b/docs/recipes/Testing.md
@@ -10,10 +10,11 @@
 [fake-indexeddb]: https://github.com/dumbmatter/fakeIndexedDB
 
 # Testing
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `Recipes`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 ## 📖 Table of Contents
 

diff --git a/docs/recipes/WebPush.md b/docs/recipes/WebPush.md
@@ -1,10 +1,11 @@
 [web-push-nodejs]: https://github.com/web-push-libs/web-push
 
 # Web Push
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `Recipes`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 **Before starting, take note of the script names**
 - `/sw.js` will be the service worker script
@@ -395,4 +396,4 @@ express()
 
 ```
 
-[☝️ Return To Top](#-web-push)
+[☝️ Return To Top](#-web-push)
diff --git a/docs/recipes/WithReact.md b/docs/recipes/WithReact.md
@@ -1,8 +1,9 @@
 # React usage
-
+<!--ONE-DOCS-HIDE start-->
 [👈 Go to `README`](../../README.md)
 
 [👆 Back to `Recipes`](./README.md)
+<!--ONE-DOCS-HIDE end-->
 
 It can be beneficial to register a service worker as early as possible during app start.
 In this example, we use a functional component to register a service worker and set
@@ -39,4 +40,4 @@ export default function App() {
 }
 ```
 
-[☝️ Return To Top](#-react-usage)
+[☝️ Return To Top](#-react-usage)