Skip to content

Feat/add simple icons support#235

Open
deimosfr wants to merge 2 commits into
colinwilson:releasefrom
deimosfr:feat/add_simple_icons_support
Open

Feat/add simple icons support#235
deimosfr wants to merge 2 commits into
colinwilson:releasefrom
deimosfr:feat/add_simple_icons_support

Conversation

@deimosfr

@deimosfr deimosfr commented May 2, 2025

Copy link
Copy Markdown
Contributor

Changes

Adding simple icons to lotusdocs

Below you'll find a checklist. For each item on the list, check one option and delete the other.

Note 1: if you want to see a result with material and simple icons, you can look at: https://wiki.deimos.fr
Note 2: some parts could be factorized but as I don't know in which direction this project wants to evolves, I kept it simple

Dark mode

  • The UI has been tested both in dark and light mode
  • This PR does not change the UI

deimosfr added 2 commits April 9, 2025 02:43
Fix static images with classical markdown notation were not rendered
@netlify

netlify Bot commented May 2, 2025

Copy link
Copy Markdown

👷 Deploy request for hugo-lotusdocs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 30273f0

@homelab-alpha

Copy link
Copy Markdown
Contributor

If this pull request (PR) is merged, the Hugo front matter documentation will require updates to reflect the new icon handling features.

Adding Icons to Posts or Index files

Note

If the icontype field is not explicitly specified, Google Icons will be used by default.

To include Simple Icons in your Hugo project, add the following fields to the front matter of your content files (such as archetypes/default.md, post.md, or _index.md):

Example for a Post with Simple Icons

---
title: "Post with Simple Icons"
description: "Incorporate Simple Icons into your post.md"
url: ""
aliases: ""
icon: "git"
icontype: "simple"
---

Example for an Index Page with Simple Icons

---
title: "Index with Simple Icons"
description: "Incorporate Simple Icons into your _index.md file"
url: ""
icon: "git"
icontype: "simple"
weight: 100
---

If you prefer Google Icons, you can easily switch by modifying the front matter like this:

Example for a Post with Google Icons

To use Google Icons, adjust the front matter as shown below:

---
title: "Post with Google Icons"
description: "Incorporate Google Icons into your post.md"
url: ""
aliases: ""
icon: "Commit"
---

Example for an Index Page with Google Icons

---
title: "Index with Google Icons"
description: "Incorporate Google Icons into your _index.md file"
url: ""
icon: "Commit"
weight: 100
---

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants