Merge pull request #62 from julien-deramond/main-jd-gh-avatar-in-doc

HiDeoo · Jul 2, 2024 · 6fc029a · 6fc029a
2 parents 2b58ddb + a1b0f61
commit 6fc029a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -53,5 +53,8 @@ export default defineConfig({
       title: 'Starlight Blog',
     }),
   ],
+  image: {
+    domains: ['avatars.githubusercontent.com'],
+  },
   site: 'https://starlight-blog-docs.vercel.app',
 })
diff --git a/docs/src/content/docs/configuration.md b/docs/src/content/docs/configuration.md
@@ -122,3 +122,4 @@ A URL to link the author's name to.
 **Type:** `string`
 
 A URL or path to an image in the `public/` directory to display as the author's picture.
+When using remote images, check out the [“Authorizing remote images”](https://docs.astro.build/en/guides/images/#authorizing-remote-images) guide to enable image optimization.
diff --git a/docs/src/content/docs/guides/authors.md b/docs/src/content/docs/guides/authors.md
@@ -13,7 +13,7 @@ Authors can be defined in a blog post using the `authors` frontmatter property a
 authors:
   name: HiDeoo
   title: Starlight Aficionado
-  picture: https://avatars.githubusercontent.com/u/494699
+  picture: https://avatars.githubusercontent.com/u/494699?s=200
   url: https://hideoo.dev
 ---
 ```
@@ -26,10 +26,10 @@ Multiple authors can be defined using an array:
 authors:
   - name: HiDeoo
     title: Starlight Aficionado
-    picture: https://avatars.githubusercontent.com/u/494699
+    picture: https://avatars.githubusercontent.com/u/494699?s=200
     url: https://hideoo.dev
   - name: Ghost
-    picture: https://avatars.githubusercontent.com/u/10137
+    picture: https://avatars.githubusercontent.com/u/10137?s=200
     url: https://github.com/ghost
 ---
 ```
@@ -62,7 +62,7 @@ A blog post frontmatter can also reference a global author using the key of the
 authors:
   - hideoo # Will use the author defined in the configuration with the `hideoo` key.
   - name: Ghost
-    picture: https://avatars.githubusercontent.com/u/10137
+    picture: https://avatars.githubusercontent.com/u/10137?s=200
     url: https://github.com/ghost
 ---
 ```