diff --git a/README.md b/README.md
index d9b22c7..5613855 100644
--- a/README.md
+++ b/README.md
@@ -6,19 +6,16 @@ Simple blog theme powered by [Zola](getzola.org). See a live preview [here](http
Dark theme
-
- ![blog-dark](https://raw.githubusercontent.com/syedzayyan/shadharon/main/screenshot-dark.png)
+ ![blog-dark](https://raw.githubusercontent.com/syedzayyan/shadharon/main/screenshot.png)
Light theme
-
![light-dark](https://raw.githubusercontent.com/syedzayyan/shadharon/main/screenshot-light.png)
## Features
-- [X] Pagination
- [X] Themes (light, dark). Default theme is dark with a switcher in the navbar
- [X] Projects page
- [x] Social Links
@@ -34,15 +31,22 @@ git submodule add https://github.com/syedzayyan/shadharon themes/shadharon
```
2. Add `theme = "shadharon"` to your `config.toml`
+
3. Copy the example content
```
-cp themes/apollo/content content
+cp themes/shadharon/content content
```
+4. For customization refer to config.toml files, which has comments.
+
+5. For customizing the banner on the homepage the content/posts/_index.md needs modification. The desc variable under `extra`, specifically. You could delete this as well to remove banner. For an about page or any aditional page an .md file in the "content" directory will do.
## Options
These filenames are relative to the root of the site. In this example, the two CSS files would be in the `static` folder.
## References
-This theme is based on [apollo](https://github.com/not-matthias/apollo).
\ No newline at end of file
+This theme is takes inspiration from
+- [apollo](https://github.com/not-matthias/apollo).
+- [Tania's Website](https://tania.dev/)
+- [Anpu Zola Theme](https://github.com/zbrox/anpu-zola-theme)
\ No newline at end of file
diff --git a/config.toml b/config.toml
index a23d86e..086a88f 100644
--- a/config.toml
+++ b/config.toml
@@ -1,7 +1,8 @@
+#The nexessary stuff/decessary stuff
+
base_url = "https://syedzayyan.github.io/shadharon"
title = "Heisenberg"
description = "Walter is kind, caring and timid, but also demanding, calculating, and ruthless. His invented pseudonym, Heisenberg, becomes an alter ego – a fantasy for him to live out a love of power. Beneath both sides of his dual personality, he views the world in the rarefied scientific terms of chemistry."
-
generate_feed = true
compile_sass = true
minify_html = true
@@ -17,13 +18,18 @@ highlight_theme = "ayu-dark"
[extra]
toc = true
use_cdn = false
+
+#Full path after the base URL required. So if you were to place it in "static" it would be "/favicon.ico"
favicon = ""
+
+#This header image is used for SEO. For example if you were to share an image via Messenger/Instagram/Twitter a preview picture is also presented
headerImage = ""
+# The icon is display besides the menu text but is not necessary. It needs to be placed under "menu_icon" in the static "folder"
menu = [
{ name = "Projects", url = "/projects", weight = 1, icon = "projects.png" },
]
-
+#The icons available can be found in "social_icons" in the "static" folder
socials = [
{ name = "github", url = "https://github.com/syedzayyan/", icon = "github" },
]
\ No newline at end of file
diff --git a/screenshot-dark.png b/screenshot.png
similarity index 100%
rename from screenshot-dark.png
rename to screenshot.png