Merge pull request #15 from RickCogley/patch-1

Update README.md
lumeland · Oct 13, 2024 · 06a4b2c · 06a4b2c
2 parents 43d81b0 + 07c2b9a
commit 06a4b2c
Showing 1 changed file with 43 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -42,3 +42,46 @@ your own data.
 To use this theme as a base template for a more customized blog, clone this repo
 and edit the [_config.ts](./_config.ts) file. The source files are in the
 [src](./src/) folder. And you can remove the `/demo` folder.
+
+## Available options
+
+Set options in your `/src/_data.yml`, such as, add extra links to the bottom of the sidebar menu:
+
+```
+menu_links: 
+  - text: <strong>MyCo</strong>
+    href: https://example.com
+    icon: building-office
+  - text: GitHub repository
+    href: https://github.com/me/therepo
+    icon: github-logo
+```
+
+Add additional script or css calls to your `<head>`, such as Fathom Analytics:
+
+```
+extra_head: |
+  <!-- Fathom Analytics -->
+    <script src="https://cdn.usefathom.com/script.js" data-site="A1B2C3D4" defer></script>
+  <!-- / Fathom -->
+```
+
+In your markdown content files, [use Github-style "callout" codes](https://github.com/orgs/community/discussions/16925) to call attention to asides in your text. 
+
+```
+> [!NOTE]  
+> Highlights information that users should take into account, even when skimming.
+
+> [!TIP]
+> Optional information to help a user be more successful.
+
+> [!IMPORTANT]  
+> Crucial information necessary for users to succeed.
+
+> [!WARNING]  
+> Critical content demanding immediate user attention due to potential risks.
+
+> [!CAUTION]
+> Negative potential consequences of an action.
+```
+