summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/README.md b/README.md
index 586a0a3..4ffa9d4 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,8 @@
- [x] Custom CSS and JS
- [x] Custom 404 Page
- [x] Custom Favicon
+- [x] Custom Social Icons
+
## Installation
@@ -37,7 +39,6 @@ To use it, copy the [config.toml](exampleSite/config.toml) in the root directory
## Content
-
### Archive Page
add `archive/_index.md` to your `content` folder. This file will be used as the archive page.
@@ -46,6 +47,28 @@ add `archive/_index.md` to your `content` folder. This file will be used as the
like the archive page, add `about/_index.md` to your `content` folder.
+
+## Social Icons
+
+The default data of social links is located in [social.toml](assets/data/social.toml)
+
+You can directly set your `id` to get a default social link icon
+
+```toml
+[params.social]
+mastodon = "@xxxxx"
+```
+Or You can set more options through a dict:
+
+```toml
+[params.social.mastodon]
+weight = 56
+icon = "fab fa-mastodon"
+format = "https://mastodon.social/%v"
+id = "johndoe"
+url = ""
+```
+
## License
[Apache](LICENSE)