docs: add icons to sidebar and titles

CyanVoxel · CyanVoxel · commit 7a44ef156d8d · 2025-08-15T20:33:32.000-07:00
diff --git a/docs/develop.md b/docs/develop.md
@@ -1,4 +1,8 @@
-# Developing
+---
+icon: material/code-braces
+---
+
+# :material-code-braces: Developing
 
 If you wish to develop for TagStudio, you'll need to create a development environment by installing the required dependencies. You have a number of options depending on your level of experience and familiarity with existing Python toolchains.
 
diff --git a/docs/help/ffmpeg.md b/docs/help/ffmpeg.md
@@ -1,4 +1,8 @@
-# FFmpeg
+---
+icon: material/movie-open-cog
+---
+
+# :material-movie-open-cog: FFmpeg
 
 FFmpeg is required for thumbnail previews and playback features on audio and video files. FFmpeg is a free Open Source project dedicated to the handling of multimedia (video, audio, etc) files. For more information, see their official website at [ffmpeg.org](https://www.ffmpeg.org/).
 
diff --git a/docs/install.md b/docs/install.md
@@ -1,4 +1,8 @@
-# Installation
+---
+icon: material/download
+---
+
+# :material-download: Installation
 
 TagStudio provides [releases](https://github.com/TagStudioDev/TagStudio/releases) as well as full access to its [source code](https://github.com/TagStudioDev/TagStudio) under the [GPLv3](https://github.com/TagStudioDev/TagStudio/blob/main/LICENSE) license.
 
diff --git a/docs/library/entry.md b/docs/library/entry.md
@@ -1,6 +1,10 @@
-# File Entries
+---
+icon: material/file
+---
 
-File entries are the individual representations of your files inside a TagStudio [library](./index.md). Each one corresponds one-to-one to a file on disk, and tracks all of the additional [tags](tag.md) and metadata that you attach to it inside TagStudio.
+# :material-file: Entries
+
+Entries are the individual representations of your files inside a TagStudio [library](./index.md). Each one corresponds one-to-one to a file on disk, and tracks all of the additional [tags](tag.md) and metadata that you attach to it inside TagStudio.
 
 ## Storage
 
@@ -10,7 +14,7 @@ File entry data is stored within the `ts_library.sqlite` file inside each librar
 
 File entries appear as thumbnails inside the grid display. The preview panel shows a more detailed preview of the file, along with extra file stats and all attached TagStudio tags and fields.
 
-## Unlinked File Entries
+## Unlinked Entries
 
 If the file that an entry is referencing has been moved, renamed, or deleted on disk, then TagStudio will display its unlinked status with a red chain-link icon instead of its thumbnail image. Certain uncached stats such as the file size and image dimensions will also be unavailable to see in the preview panel.
 
diff --git a/docs/library/entry_groups.md b/docs/library/entry_groups.md
@@ -1,8 +1,9 @@
 ---
 tags:
-  - Upcoming Feature
+    - Upcoming Feature
+icon: material/group
 ---
 
-# Entry Groups
+# :material-group: Entry Groups
 
 Entries can be grouped via tags marked as "groups" which when applied to different entries will signal TagStudio to treat those entries as a single group inside of searches and browsing.
diff --git a/docs/library/field.md b/docs/library/field.md
@@ -1,4 +1,8 @@
-# Fields
+---
+icon: material/text-box
+---
+
+# :material-text-box: Fields
 
 Fields are additional types of metadata that you can attach to [file entries](./entry.md). Like [tags](./tag.md), fields are not stored inside files themselves nor in sidecar files, but rather inside the respective TagStudio [library](./index.md) save file.
 
diff --git a/docs/library/library_search.md b/docs/library/library_search.md
@@ -1,4 +1,8 @@
-# Library Search
+---
+icon: material/magnify
+---
+
+# :material-magnify: Search
 
 TagStudio provides various methods to search your library, ranging from TagStudio data such as tags to inherent file data such as paths or media types.
 
@@ -74,7 +78,7 @@ TagStudio uses a "[smartcase](https://neovim.io/doc/user/options.html#'smartcase
 
 #### Glob Syntax
 
-Optionally, you may use [glob](https://en.wikipedia.org/wiki/Glob_(programming)) syntax to search filepaths.
+Optionally, you may use [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>) syntax to search filepaths.
 
 #### Examples
 
diff --git a/docs/library/tag.md b/docs/library/tag.md
@@ -1,4 +1,8 @@
-# Tags
+---
+icon: material/tag-text
+---
+
+# :material-tag-text: Tags
 
 Tags are discrete objects that represent some attribute. This could be a person, place, object, concept, and more. Unlike most tagging systems, TagStudio tags are not solely represented by a line of text or a hashtag. Tags in TagStudio consist of several properties and relationships that give extra customization, searching power, and ease of tagging that cannot be achieved by string-based tags alone. TagStudio tags are designed to be as simple or as complex as you'd like, giving options to users of all skill levels and use cases.
 
diff --git a/docs/library/tag_categories.md b/docs/library/tag_categories.md
@@ -1,8 +1,8 @@
 ---
-tags:
+icon: material/shape-plus
 ---
 
-# Tag Categories
+# :material-shape-plus: Tag Categories
 
 The "Is Category" property of tags determines if a tag should be treated as a category itself when being organized inside the preview panel. Tags marked as categories will show themselves and all tags inheriting from it (including recursively) underneath a field-like section with the tag's name. This means that duplicates of tags can appear on entries if the tag inherits from multiple parent categories, however this is by design and reflects the nature of multiple inheritance. Any tags not inheriting from a category tag will simply show under a default "Tag" section.
 
diff --git a/docs/library/tag_color.md b/docs/library/tag_color.md
@@ -1,4 +1,8 @@
-# Tag Colors
+---
+icon: material/palette
+---
+
+# :material-palette: Tag Colors
 
 TagStudio features a variety of built-in tag colors, alongside the ability for users to create their own custom tag color palettes.
 
diff --git a/docs/library/tag_overrides.md b/docs/library/tag_overrides.md
@@ -1,9 +1,10 @@
 ---
 tags:
     - Upcoming Feature
+icon: material/tag-hidden
 ---
 
-# Tag Overrides
+# :material-tag-hidden: Tag Overrides
 
 Tag overrides are the ability to add or remove [parent tags](./tag.md#parent-tags) from a [tag](./tag.md) on a per-[entry](./entry.md) basis.
 
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -82,7 +82,7 @@ h2,
 }
 
 .twemoji {
-    margin-top: 0.05rem;
+    margin-top: 0.14rem;
 }
 
 /* Matches the palette used by mkdocs-material */
diff --git a/docs/updates/changelog.md b/docs/updates/changelog.md
@@ -1,4 +1,6 @@
 ---
 title: Changelog
+icon: material/list-status
 ---
---8<-- "CHANGELOG.md"
+
+--8<-- "CHANGELOG.md"
diff --git a/docs/updates/roadmap.md b/docs/updates/roadmap.md
@@ -1,3 +1,7 @@
+---
+icon: material/map-check
+---
+
 # :material-map-check: Roadmap
 
 This page outlines the current and planned features required for TagStudio to be considered "feature complete" (v10.0.0). Features and changes are broken up by group in order to better assess the overall state of those features. [Priority levels](#priority-levels) and [version estimates](#version-estimates) are provided in order to give a rough idea of what's planned and when it may release.
diff --git a/docs/updates/schema_changes.md b/docs/updates/schema_changes.md
@@ -1,4 +1,8 @@
-# Save Format Changes
+---
+icon: material/database-edit
+---
+
+# :material-database-edit: Save Format Changes
 
 This page outlines the various changes made to the TagStudio save file format over time, sometimes referred to as the "database" or "database file".
 
diff --git a/docs/usage.md b/docs/usage.md
@@ -1,4 +1,8 @@
-# Usage
+---
+icon: material/mouse
+---
+
+# :material-mouse: Usage
 
 ## Creating/Opening a Library
 
diff --git a/docs/utilities/macro.md b/docs/utilities/macro.md
@@ -1,4 +1,8 @@
-# Tools & Macros
+---
+icon: material/script-text
+---
+
+# :material-script-text: Tools & Macros
 
 Tools and macros are features that serve to create a more fluid [library](../library/index.md)-managing process, or provide some extra functionality. Please note that some are still in active development and will be fleshed out in future updates.
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -36,10 +36,10 @@ nav:
       - help/ffmpeg.md
   - Library:
       - library/index.md
+      - library/library_search.md
       - library/entry.md
       - library/entry_groups.md
       - library/field.md
-      - library/library_search.md
       - library/tag.md
       - library/tag_categories.md
       - library/tag_color.md
