feat: support markdown for copyright text (#25)

* feat: support markdown for copyright text * docs: add info about supporting markdown in copyright
imfing · Sep 1, 2023 · 5b71912 · 5b71912
1 parent 34c6f6c
commit 5b71912
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/exampleSite/content/docs/guide/configuration.md b/exampleSite/content/docs/guide/configuration.md
@@ -129,8 +129,11 @@ params:
 
 ### Copyright
 
-To edit the copyright text, create file `en.yaml` in the `i18n/` directory with content:
+To modify the copyright text displayed in your website's footer, you'll need to create a file named `i18n/en.yaml`.
+In this file, specify your new copyright text as shown below:
 
 ```yaml {filename="i18n/en.yaml"}
 copyright: "© 2023 YOUR TEXT HERE"
 ```
+
+For your reference, an example [`i18n/en.yaml`](https://github.com/imfing/hextra/blob/main/i18n/en.yaml) file can be found in the GitHub repository. Additionally, you could use Markdown format in the copyright text.
diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html
@@ -16,7 +16,7 @@
   >
     <div class="flex w-full flex-col items-center sm:items-start">
       {{- if (.Site.Params.footer.displayPoweredBy | default true) }}<div class="font-semibold">{{ template "theme-credit" . }}</div>{{ end }}
-      {{- if .Site.Params.footer.displayCopyright }}<p class="mt-6 text-xs">{{ $copyright }}</p>{{ end }}
+      {{- if .Site.Params.footer.displayCopyright }}<p class="mt-6 text-xs">{{ $copyright | markdownify }}</p>{{ end }}
     </div>
   </div>
 </footer>