add 'Edit Page' feature to doc pages

47degrees · Oct 5, 2018 · d55dddc · d55dddc
1 parent 9c06a5a
commit d55dddc
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 4 deletions.
diff --git a/docs/src/main/tut/docs/settings.md b/docs/src/main/tut/docs/settings.md
@@ -327,3 +327,9 @@ micrositeConfigYaml := ConfigYml(
 ```
 micrositeFooterText := Some("<b>Bob</b> the <i>Builder</i>")
 ```
+
+- `micrositeEditButtonText`: This setting allows the optional inclusion and configuration of an edit button on pages with the docs layout. By default, it is set to `None` and not visible. If the setting is set to `Some` with given text, that text will appear on the button at the bottom of the page. The button links to the edit view of the page in it's repository. **This string is passed in unsanitized to the templating engine.**
+
+```
+micrositeEditButtonText := Some("Improve this page")
+```
diff --git a/src/main/resources/_sass/_docs.scss b/src/main/resources/_sass/_docs.scss
@@ -198,6 +198,10 @@
     }
 }
 
+.edit-button {
+    padding: 0 30px 10px;
+}
+
 @media (min-width: 768px) {
     #wrapper {
         padding-left: 250px;

diff --git a/src/main/scala/microsites/MicrositeKeys.scala b/src/main/scala/microsites/MicrositeKeys.scala
@@ -152,6 +152,10 @@ trait MicrositeKeys {
     "Optional. Customize the second line in the footer."
   )
 
+  val micrositeEditButtonText: SettingKey[Option[String]] = settingKey[Option[String]](
+    "Optional. Add a button with given string in DocsLayout pages that links to the file in the repository."
+  )
+
   val publishMicrositeCommandKey: String = "publishMicrositeCommand"
 }
 
@@ -201,7 +205,8 @@ trait MicrositeAutoImportSettings extends MicrositeKeys {
           shareOnSocial = micrositeShareOnSocial.value
         ),
         templateTexts = MicrositeTemplateTexts(
-          footer = micrositeFooterText.value
+          footer = micrositeFooterText.value,
+          editButton = micrositeEditButtonText.value
         ),
         configYaml = configWithAllCustomVariables,
         fileLocations = MicrositeFileLocations(

diff --git a/src/main/scala/microsites/MicrositesPlugin.scala b/src/main/scala/microsites/MicrositesPlugin.scala
@@ -108,6 +108,7 @@ object MicrositesPlugin extends AutoPlugin {
     micrositeGitterChannel := true,
     micrositeGitterChannelUrl := s"${micrositeGithubOwner.value}/${micrositeGithubRepo.value}",
     micrositeFooterText := Some(layouts.Layout.footer.toString),
+    micrositeEditButtonText := None,
     micrositeGithubLinks := true,
     includeFilter in makeSite := "*.html" | "*.css" | "*.png" | "*.jpg" | "*.jpeg" | "*.gif" | "*.js" | "*.swf" | "*.md" | "*.webm" | "*.ico" | "CNAME" | "*.yml" | "*.svg" | "*.json",
     includeFilter in Jekyll := (includeFilter in makeSite).value,

diff --git a/src/main/scala/microsites/layouts/DocsLayout.scala b/src/main/scala/microsites/layouts/DocsLayout.scala
@@ -92,7 +92,8 @@ class DocsLayout(config: MicrositeSettings) extends Layout(config) {
         ),
         div(id := "content", data("github-owner") := config.gitSettings.githubOwner, data("github-repo") := config.gitSettings.githubRepo,
           div(cls := "content-wrapper",
-            section("{{ content }}")
+            section("{{ content }}"),
+            editButton
           )
         )
       )
@@ -155,4 +156,21 @@ class DocsLayout(config: MicrositeSettings) extends Layout(config) {
       (if (config.micrositeKazariSettings.micrositeKazariEnabled)
          List(script(src := "{{ site.baseurl }}/js/kazari.js"))
        else List.empty[TypedTag[String]])
+
+  def editButton: Seq[TypedTag[String]] =
+    config.templateTexts.editButton match {
+      case Some(text) =>
+        Seq(
+          div(
+            cls := "edit-button",
+            a(
+              href := config.gitSiteUrl,
+              href := "/edit/master/modules/docs/src/main/tut/{{ page.path }}",
+              cls := "btn-sm btn-info",
+              text
+            )
+          )
+        )
+      case None => Nil
+    }
 }
diff --git a/src/main/scala/microsites/microsites.scala b/src/main/scala/microsites/microsites.scala
@@ -79,7 +79,7 @@ case class MicrositeVisualSettings(
     favicons: Seq[MicrositeFavicon],
     shareOnSocial: Boolean)
 
-case class MicrositeTemplateTexts(footer: Option[String])
+case class MicrositeTemplateTexts(footer: Option[String], editButton: Option[String])
 
 case class MicrositeSettings(
     identity: MicrositeIdentitySettings,

diff --git a/src/test/scala/microsites/util/Arbitraries.scala b/src/test/scala/microsites/util/Arbitraries.scala
@@ -148,6 +148,7 @@ trait Arbitraries {
       micrositeKazariDependencies            ← dependenciesListArbitrary.arbitrary
       micrositeKazariResolvers               ← Arbitrary.arbitrary[Seq[String]]
       micrositeFooterText                    ← Arbitrary.arbitrary[Option[String]]
+      micrositeEditButtonText                ← Arbitrary.arbitrary[Option[String]]
     } yield
       MicrositeSettings(
         MicrositeIdentitySettings(
@@ -165,7 +166,10 @@ trait Arbitraries {
           palette,
           favicon,
           shareOnSocial),
-        MicrositeTemplateTexts(micrositeFooterText),
+        MicrositeTemplateTexts(
+          micrositeFooterText,
+          micrositeEditButtonText
+        ),
         micrositeConfigYaml,
         MicrositeFileLocations(
           micrositeImgDirectory,