hugo-theme-fha/README.md

84 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

2024-09-01 14:45:18 +00:00
# Theme hugo-theme-fha
2024-09-01 14:27:23 +00:00
## Features
### Search
Lightweight search functionality based on index file.
2024-09-01 14:45:18 +00:00
Requires
```toml
[outputs]
home = ["HTML", "RSS", "JSON"]
```
2024-09-01 14:27:23 +00:00
### Mermaid
Support for Mermaid schemas.
2024-09-01 14:45:18 +00:00
### Photos (soon)
2024-09-01 14:27:23 +00:00
Support photos albums based on Folders.
2024-10-14 19:54:59 +00:00
### Dark / Light mode
Possibility to enable Dark or Light mode.
It will auto detect the current user setting and choose the right mode.
Colors can be adapted using the variables.css file.
2024-09-01 14:27:23 +00:00
### Syntax Hightlighting
Required configuration to copy paste code :
2024-09-01 14:45:18 +00:00
```toml
2024-09-01 14:27:23 +00:00
[markup.highlight]
lineNos=true
lineNumbersInTable=true
noClasses = false
2024-09-01 14:45:18 +00:00
```
2024-09-01 14:27:23 +00:00
### Curriculum Vitae
Copy /layouts/section/cv.html to you local /layouts/section folder and edited the content.
Save your own picture under /static/img/avatar.jpeg
2024-09-01 14:32:27 +00:00
Add an entry in the about Menu:
2024-09-01 14:45:18 +00:00
```toml
[[menu.nav]]
name = 'About'
pageRef = '/about'
weight = 100
[[menu.nav]]
identifier = "pAbout"
name = "About"
url = "/about"
parent = "About"
weight = 10
[[menu.nav]]
identifier = "pCv"
name = "CV"
url = "/cv"
parent = "About"
weight = 20
```
It is possible to add cv in other languages
* Add the content is section (ex:cvfr.html).
* Add an entry in the nav menu.
2024-09-01 14:32:27 +00:00
## BlockQuotes Render Hook
Block quotes are now customizable in the markdown files.
The format is the following :
``` md
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
```
Those are customizable in `assets/theme.css`.
Currently, the supported Tags are : CAUTION, Important, NOTE, TIP, WARNING, NATURE, CAMPING, METEO, MONEY, DANGER, WIFI.
New Tags can be added by customizing 'render-blockquote-alert.html'.
2024-09-01 14:27:23 +00:00
## Installation
## Configuration
### Favicons
Get Icons from [Flaticon](https://www.flaticon.com/).
Generate Favicons with [Freepik](https://www.freepik.com/).
Uncompress the icons in your /static folder.
## References
* [Bootstrap 5.2.3](https://getbootstrap.com/docs/5.2/getting-started/download/)
* [JQuery](https://jquery.com/download/)
* [Mermaid](https://cdn.jsdelivr.net/npm/mermaid@11.0.2/dist/)