From a72fd1365f0a5406ea8ff7d20a8f71afdbcc4b24 Mon Sep 17 00:00:00 2001
From: Oliver Kopp <kopp.dev@gmail.com>
Date: Wed, 15 Nov 2023 16:46:08 +0100
Subject: [PATCH] Add hint on "View on GitHub"

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index d49c671c..0ad46c5d 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,17 @@ show_downloads: ["true" or "false" (unquoted) to indicate whether to provide a d
 google_analytics: [Your Google Analytics tracking ID]
 ```
 
+### Show "View on GitHub" button
+
+Slate will show a button to navigate to the respective GitHub repsotiroy, if set in your site's `_config.yml`:
+
+```yml
+github:
+  is_project_page: true
+```
+
+Default is `false`.
+
 ### Stylesheet
 
 If you'd like to add your own custom styles: