Skip to content

Task: Add Trongate Icons Documentation #95

Description

@trongate

Task: Add Trongate Icons Documentation

Trongate v2, the current version of the framework, comes with its own icon set called Trongate Icons.

The icons are located at:

public/trongate-icons

To use Trongate Icons, the following stylesheet must be included:

public/css/trongate-icons.css

Icon usage follows conventions similar to Font Awesome. For example:

<i class="tg tg-home"></i>

Your task

Create a new page of documentation for Trongate Icons and add it to the existing Trongate CSS documentation.

The Trongate CSS documentation is currently available here:

https://trongate.io/documentation/trongate_css

The new page should be integrated into the existing documentation structure in a logical location. Please follow the existing documentation's conventions for page structure, headings, navigation, code examples and presentation.

Documentation requirements

The page should explain:

  • What Trongate Icons are.
  • Where the icon files are located.
  • How to include the required trongate-icons.css stylesheet.
  • The basic syntax for displaying an icon.
  • How the tg and icon-specific classes are used.
  • How to find and identify the available icons.
  • Several practical examples demonstrating different icons.
  • Examples of icons being used alongside text where appropriate.
  • Any useful information that a developer needs in order to use the icon set correctly.

For example, include a basic usage example such as:

<i class="tg tg-home"></i>

Please inspect the actual icon files in public/trongate-icons and use real icons that exist in the framework for the examples. Do not invent icon names.

The finished page should be clear and useful to someone who has never used Trongate Icons before.

Important

This is a documentation task, not an opportunity to modify the icon set or its underlying CSS.

Do not make unnecessary changes to the framework. The objective is simply to produce a polished documentation page and integrate it into the existing Trongate CSS documentation.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions