From c65e1d50a1fae717612dcab0c145857e743e6143 Mon Sep 17 00:00:00 2001
From: Brad Pitcher <bradpitcher@gmail.com>
Date: Sun, 28 Jan 2024 14:47:57 -0600
Subject: [PATCH] add edit this page link (#769)

---
 docs/_config.yml                              |  1 +
 docs/_layouts/default.html                    |  4 +--
 docs/_layouts/post.html                       |  4 +++
 docs/css/style.css                            | 36 +++++++++++++++++++
 docs/help.html                                |  2 +-
 .../help/_posts/2013-04-01-threading.markdown |  2 +-
 6 files changed, 45 insertions(+), 4 deletions(-)

diff --git a/docs/_config.yml b/docs/_config.yml
index 372fa11b9..b83a1e380 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -2,6 +2,7 @@ highlighter: rouge
 permalink: /:categories/:title/
 lsi: false
 markdown: KramdownPlus
+repo: https://github.com/nsubstitute/NSubstitute
 
 kramdown:
     input: GFM
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
index 251fb9260..0118f13af 100644
--- a/docs/_layouts/default.html
+++ b/docs/_layouts/default.html
@@ -17,7 +17,7 @@ <h1 class="copy-disabled" style="display: inline"> NSubstitute </h1> <br />
   <div id="nav">
     <a href="/help/getting-started">Get started</a> |
     <a href="/help.html">Docs and getting help</a> |
-    <a href="https://github.com/nsubstitute/NSubstitute">NSub on GitHub</a>  
+    <a href="{{ site.repo }}">NSub on GitHub</a>  
   </div>
 
   <div id="content">
@@ -26,7 +26,7 @@ <h1 class="copy-disabled" style="display: inline"> NSubstitute </h1> <br />
 
   <div id="footer">
   NSubstitute is open source software, licensed under the <a href="https://www.opensource.org/licenses/bsd-license.php">BSD License</a>.<br />
-The NSubstitute project is possible <a href="https://github.com/nsubstitute/NSubstitute/blob/master/acknowledgements.md">thanks to a number of other software projects</a>. We acknowledge their awesomeness.<br />
+The NSubstitute project is possible <a href="{{ site.repo }}/blob/master/acknowledgements.md">thanks to a number of other software projects</a>. We acknowledge their awesomeness.<br />
   NSubstitute logo donated by <a href="https://troyhunt.com">Troy Hunt</a>.
   </div>
 
diff --git a/docs/_layouts/post.html b/docs/_layouts/post.html
index 75919bc6c..efb7177f4 100644
--- a/docs/_layouts/post.html
+++ b/docs/_layouts/post.html
@@ -14,6 +14,10 @@
     <div id="post-content">
       <h1>{{ page.title }}</h1>
       {{ content }}
+      <a class="edit-link" href="{{ site.repo }}/tree/main/docs/{{ page.path }}">
+        <div class="pencil"></div>
+        <span class="edit-text">Edit this page</span>
+      </a>
       <div id="page-navigation">
         <div class="previous">
         {% if page.previous.url %}
diff --git a/docs/css/style.css b/docs/css/style.css
index 0d2c333e7..20b43d193 100644
--- a/docs/css/style.css
+++ b/docs/css/style.css
@@ -219,6 +219,42 @@ h3 {
     cursor: pointer;
 }
 
+.edit-link {
+    display: inline-block;
+    margin-top: 10px;
+}
+.edit-text {
+    padding-left: 18px;
+}
+.pencil {
+    width: 5px;
+    height: 12px;
+    background: #365f91;
+    margin-right: 12px;
+    position: relative;
+    left: 2px;
+    top: 15px;
+    transform: rotate(30deg);
+}
+.pencil::before {
+    content: "";
+    position: absolute;
+    width: 5px;
+    height: 5px;
+    background: #365f91;
+    top: -6px ;
+}
+.pencil::after {
+    content: "" ;
+    position: absolute;
+    width: 3.5px;
+    height: 3.5px;
+    background: #365f91;
+    left: 0.75px;
+    bottom: -2px;
+    transform: rotate(45deg);
+}
+
 /* Pygments vs style, as generated by:
  *  https://github.com/richleland/pygments-css/blob/master/vs.css
  */
diff --git a/docs/help.html b/docs/help.html
index 8b1f810b2..fa86b71ac 100644
--- a/docs/help.html
+++ b/docs/help.html
@@ -8,4 +8,4 @@
 
 <p>For more in depth information start with <a href="/help/creating-a-substitute">Creating a substitute</a>.</p>
 
-<p>If you can't find the answer you're looking for, or if you have feature requests or feedback on NSubstitute, please <a href="https://github.com/nsubstitute/NSubstitute/issues">raise an issue</a> on our project site. All questions are welcome via our project site, but for "how-to"-style questions you can also try <a href="https://stackoverflow.com/tags/nsubstitute">StackOverflow with the [nsubstitute] tag</a>, which often leads to very good answers from the larger programming community. StackOverflow is especially useful if your question also relates to other libraries that our team may not be as familiar with (e.g. NSubstitute with Entity Framework). You can also head on over to the <a href="https://groups.google.com/group/nsubstitute">NSubstitute discussion group</a> if you prefer.</p>
+<p>If you can't find the answer you're looking for, or if you have feature requests or feedback on NSubstitute, please <a href="{{ site.repo }}/issues">raise an issue</a> on our project site. All questions are welcome via our project site, but for "how-to"-style questions you can also try <a href="https://stackoverflow.com/tags/nsubstitute">StackOverflow with the [nsubstitute] tag</a>, which often leads to very good answers from the larger programming community. StackOverflow is especially useful if your question also relates to other libraries that our team may not be as familiar with (e.g. NSubstitute with Entity Framework). You can also head on over to the <a href="https://groups.google.com/group/nsubstitute">NSubstitute discussion group</a> if you prefer.</p>
diff --git a/docs/help/_posts/2013-04-01-threading.markdown b/docs/help/_posts/2013-04-01-threading.markdown
index 7963e2f58..1c4086749 100644
--- a/docs/help/_posts/2013-04-01-threading.markdown
+++ b/docs/help/_posts/2013-04-01-threading.markdown
@@ -5,6 +5,6 @@ layout: post
 
 It is fairly standard for production code to call a substitute from multiple threads, but we should avoid having our test code configure or assert on a substitute while it is also be used from other threads in production code. 
 
-Although this particular issue has been mitigated by work in [#452](https://github.com/nsubstitute/NSubstitute/pull/462), issue [#256](https://github.com/nsubstitute/NSubstitute/issues/256) shows the types of problems that can occur if we're not careful with threading.
+Although this particular issue has been mitigated by work in [#452]({{ site.repo }}/pull/462), issue [#256]({{ site.repo }}/issues/256) shows the types of problems that can occur if we're not careful with threading.
 
 To avoid this sort of problem, make sure your test has finished configuring its substitutes before exercising the production code, then make sure the production code has completed before your test asserts on `Received()` calls.
\ No newline at end of file