website/README.md

114 lines
3.9 KiB
Markdown
Raw Normal View History

2020-08-24 02:05:09 -05:00
![logo](static/img/icon.svg)
# Ficurinia
A prickly blog theme for Hugo
2021-01-03 07:18:07 -06:00
![](images/tn.png)
2020-08-24 02:05:09 -05:00
# [Demo](https://gabmus.org)
[Code for the demo website](https://gitlab.com/gabmus/gabmus.gitlab.io) (really my personal website)
# Customization
2021-01-02 07:08:21 -06:00
## Configuration
2020-08-24 02:05:09 -05:00
These are some parameters you can use in your `config.toml` to customize Ficurinia:
```toml
theme = "hugo-ficurinia"
title = "My nice blog"
copyright = "Some copyright notice"
paginate = 5 # number of articles per page in the index
summaryLength = 70 # number of words for article summaries
2020-08-24 02:05:09 -05:00
[params]
author = "Gabriele Musco"
2020-08-24 02:05:09 -05:00
logo = "/images/mylogo.png"
favicon = "/images/myfavicon.png"
showTags = true # show the Tags menu item; default true
showRss = true # show the link for the RSS feed; default true
imageInArticlePreview = false # show images in article preview; default false
2020-08-24 02:05:09 -05:00
navtype = "standard" # changes the style of the pagination, available styles are: "standard", "circle"
2021-01-04 06:27:07 -06:00
fontFamily = "JetBrains Mono" # changes the font, default "JetBrains Mono"
monospaceFontFamily = "JetBrains Mono" # changes the monospace font for code, default "JetBrains Mono"
contentWidth = "1000px" # maximum width of the site content, css syntax
2021-01-05 02:38:10 -06:00
discreteCards = false # enable discrete card style; default false
gridView = false # show post list as a grid. goes well with discreteCards
2021-01-05 02:38:10 -06:00
highlightBgColor = "#34363b"; # card and circle navigation background color for discrete card mode
# enable comments support with commento using the script from your server
commento = "https://example.com/js/commento.js"
2020-10-16 13:02:18 -05:00
# enable analytics using Plausible
plausibleScriptUrl = "https://something.com/..."
plausibleDomain = "gabmus.org"
2020-08-24 02:05:09 -05:00
# the links array shows links with icons (if explicitly supported)
# it's an array of arrays containing two strings: name and link
# the supported icons are:
# gitlab
# gnome
# youtube
# email
# twitter
# instagram
# facebook
# github
# linkedin
# telegram
# phone
# rss
links = [
["GitLab", "https://gitlab.com/gabmus"],
["GNOME", "https://gitlab.gnome.org/gabmus"],
["YouTube", "https://youtube.com/TechPillsNet"],
["Email", "mailto:gabmus@disroot.org"]
]
# you can customize all of the colors in this theme
# the values shown are the defaults
backgroundColor = "#242629"
foregroundColor = "white"
dimForegroundColor = "#bababa"
strokeColor = "#4f4f4f"
accentColor = "#db5793"
2021-01-19 03:08:51 -06:00
# redirect to baseURL if current URL host doesn't match
# useful if deploying in gitlab pages with custom domain and don't want
# the username.gitlab.io/website url to persist
forceRedirect = false
infiniteScrolling = false # activates infinite scrolling instead of regular pagination
# this section is necessary if you want infinite scrolling
# it allows to output the article list as paged JSON so that "pages" can be retrieved via javascript
[outputs]
home = ["HTML", "JSON"]
2020-08-24 02:05:09 -05:00
```
2021-01-02 07:08:21 -06:00
## Inject custom content
Ficurinia supports injecting custom content into the theme. There are several files you can create in `layouts/partials/inject` that will be included inside the theme in different places.
| Partial | Placement |
|---------|-----------|
| `layouts/partials/inject/body.html` | Before closing the `body` tag |
| `layouts/partials/inject/content-after.html` | After a post or page content |
| `layouts/partials/inject/content-before.html` | Before a post or page content |
| `layouts/partials/inject/footer.html` | At the beginning of the footer |
| `layouts/partials/inject/head.html` | Before closing the `head` tag |
2021-01-03 14:09:16 -06:00
| `layouts/partials/inject/header-after.html` | Before closing the header |
| `layouts/partials/inject/header-before.html` | At the beginning of the header |
2021-01-02 07:08:21 -06:00
2020-08-24 02:05:09 -05:00
# Does *Ficurinia* mean anything?
It's Sicilian for Indian fig, also known as prickly pear cactus.