Merge pull request netlify#26 from netlify/context-site-example

add example for context.site

Author: Skn0tt

Diff for: netlify.toml

@@ -81,6 +81,10 @@
   path = "/error"
   function = "error"
 
+[[edge_functions]]
+  path = "/context-site"
+  function = "context-site"
+
 # Serve pages explaining each example 
 [[edge_functions]]
   path = "/example/*"

Diff for: netlify/edge-functions/[page].js

@@ -25,6 +25,7 @@ import pageLocalizedContent from "../../pages/localized-content/index.js";
 import pageProxyRequests from "../../pages/proxy-requests/index.js";
 import pageEnvironment from "../../pages/environment/index.js";
 import pageUncaughtExceptions from "../../pages/uncaught-exceptions/index.js";
+import pageContextSite from "../../pages/context-site/index.js";
 
 // The keys here correspond to the path in the request to `/example/PATH`
 const pages = {
@@ -48,6 +49,7 @@ const pages = {
   "proxy-requests": pageProxyRequests,
   environment: pageEnvironment,
   "uncaught-exceptions": pageUncaughtExceptions,
+  "context-site": pageContextSite,
 };
 
 export default async (Request, Context) => {

Diff for: netlify/edge-functions/context-site.ts

@@ -0,0 +1,5 @@
+import type { Context } from "netlify:edge";
+
+export default async (request: Request, context: Context) => {
+  return new Response(`Hello from ${context.site.name}!`);
+};

Diff for: pages/context-site/README.md

@@ -0,0 +1,30 @@
+![Netlify examples](https://user-images.githubusercontent.com/5865/159468750-df1c2783-39b2-40da-9c0f-971f72a7ea3f.png)
+
+# Access Site Information from Edge Functions
+
+Netlify Edge Functions give access to site information via `context.site`.
+
+## Code example
+
+Edge Functions are files held in the `netlify/edge-functions` directory.
+
+```ts
+import type { Context } from "netlify:edge";
+
+export default async (request: Request, context: Context) => {
+  return new Response(`Hello from ${context.site.name}!`);
+};
+```
+
+- [Explore the code for this Edge Function](../../netlify/edge-functions/context-site.ts)
+
+## View this example on the web
+
+- https://edge-functions-examples.netlify.app/example/context-site
+
+## Deploy to Netlify
+
+You can deploy this and all the other examples in this repo as a site of your own to explore and experiment with, by
+clicking this button.
+
+[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/netlify/edge-functions-examples&utm_campaign=devex&utm_source=edge-functions-examples&utm_medium=web&utm_content=Deploy%20Edge%20Functions%20Examples%20to%20Netlify)

Diff for: pages/context-site/index.js

@@ -0,0 +1,29 @@
+import repoLink from "../../components/repo-link.js";
+
+export default {
+  title: "Access Site Information from Edge Functions",
+  metaDescription: "Access Site Information from an Edge Function",
+  page: function () {
+    return `
+    <section>
+      <h1>Access Site Information from Edge Functions</h1>
+      <p>Netlify Edge Functions give access to site information via <code>context.site</code>.</p>
+      <pre><code>import type { Context } from "netlify:edge";
+
+export default async (request: Request, context: Context) => {
+  return new Response(\`Hello from \${context.site.name}!\`);
+};</code></pre>
+
+      <h2>See this in action</h2>
+      <ul>
+        <li><a href="/context-site">See response from code snippet</a></li>
+        <li>${repoLink("context-site.ts")}</li>
+      </ul>
+      <h2>Related</h2>
+      <ul>
+        <li><a href="/example/environment">Environment variables</a></li>
+      </ul>
+    </section>
+  `;
+  },
+};

Diff for: pages/cookies-delete/README.md

@@ -30,7 +30,7 @@ export default async (request: Request, context: Context) => {
 
 ## View this example on the web
 
-- https://edge-functions-examples.netlify.app/example/cookies
+- https://edge-functions-examples.netlify.app/example/cookies-delete
 
 ## Deploy to Netlify
 

Diff for: pages/cookies-read/README.md

@@ -30,7 +30,7 @@ export default async (request: Request, context: Context) => {
 
 ## View this example on the web
 
-- https://edge-functions-examples.netlify.app/example/cookies
+- https://edge-functions-examples.netlify.app/example/cookies-read
 
 ## Deploy to Netlify
 

Diff for: pages/cookies-set/README.md

@@ -30,7 +30,7 @@ export default async (request: Request, context: Context) => {
 
 ## View this example on the web
 
-- https://edge-functions-examples.netlify.app/example/cookies
+- https://edge-functions-examples.netlify.app/example/cookies-set
 
 ## Deploy to Netlify
 

Diff for: pages/home/index.js

@@ -68,6 +68,7 @@ export default {
         <li class="home__sectionListItem"><a class="home__sectionListItemLink" href="/example/log">Write to the logs</a></li>
         <li class="home__sectionListItem"><a class="home__sectionListItemLink" href="/example/environment">Use environment variables</a></li>
         <li class="home__sectionListItem"><a class="home__sectionListItemLink" href="/example/uncaught-exceptions">Read logs for uncaught exceptions</a></li>
+        <li class="home__sectionListItem"><a class="home__sectionListItemLink" href="/example/context-site">Access site information</a></li>
       </ul>
     </section>
   `;