summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFrancesco <tomaselli.fr@gmail.com>2024-04-23 16:38:35 +0200
committerFrancesco <tomaselli.fr@gmail.com>2024-04-23 16:38:35 +0200
commit4d5d0708aa283cda073a0e244f721af275f153ce (patch)
tree2e8111f31b7ca883221f84a10854d26f08f34d61 /README.md
parent1ca2dbd5c8bb4cc10a023ab56d077dff9a95c101 (diff)
Theme Update
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files changed, 37 insertions, 11 deletions
diff --git a/README.md b/README.md
index bfa63b6..df40bae 100644
--- a/README.md
+++ b/README.md
@@ -22,21 +22,46 @@ git submodule add git@github.com:tomfran/typo.git themes/typo
Otherwise you can clone the repo and copy it manually to yout theme folder.
-## Peculiarities
+## Features
-**Latex and code overflow on mobile**
+### Header autonumbering
-...
+You can add auto-numbering to the pages by setting the following parameter in
+the header of your md files. The numbering is currently supported to level 3 subheadings.
-**Dark and Light mode tags for images**
+```
+autonumber: true
+```
+
+### Appearance preferences
+
+In your `hugo.toml` file you can specify the preferred theme:
+
+```
+theme = "light | dark | auto"
+```
-...
+### Dark and light mode images
+
+You can tags to decide if images are displayed in dark or light mode, as Github id doing for readmes.
+
+Let's say you have two different versions
+of an image, setting #dark or #light do the trick.
+
+```md
+![skiplist](skiplist-light.png#light)
+![skiplist](skiplist-dark.png#dark)
+```
+
+You can of course remove the final tag
+to alway show the same image on light and
+dark mode.
## Configuration example
**post.md**
-```md
+```
---
title: "Search Engine in Rust"
date: "2024-02-01"
@@ -46,7 +71,7 @@ readTime: true
autonumber: true
---
-...
+Your content...
```
**hugo.toml**
@@ -57,7 +82,7 @@ languageCode = 'en-us'
title = 'Francesco Tomaselli'
theme = 'Typo'
-# Disable tags
+# Disable tags, actually, they are rendered as a list, but the idea is to disable them.
disableKinds = ['taxonomy']
# Google analytics code
@@ -67,7 +92,7 @@ googleAnalytics = "G-xxxxxxxxxx"
# Math mode
math = true
-# Intro on main page, content in markdown
+# Intro on main page, content in markdown, if you omit title or content the other can be displayed
homeIntro = true
homeIntroTitle = 'Hi!'
homeIntroContent = """
@@ -75,11 +100,11 @@ I am an Italian Software Engineer with a strong foundation in computer science a
I am interested in a range of topics, including algorithms, distributed systems, databases, and information retrieval.
"""
-# Collection to display on home
+# Collection to display on home page, do not set if tou don't want them
homeCollectionTitle = 'Posts'
homeCollection = 'posts'
-# Pagination size across all website
+# Pagination size across all website, this is the same for homepage and single list page
paginationSize = 100
# Social icons
@@ -110,6 +135,7 @@ url = "/resume"
# Syntax highligth on code blocks, all styles:
# https://xyproto.github.io/splash/docs/all.html
+# I sugges algol
[markup]
[markup.highlight]
style = 'algol'