https://github.com/exception0x0194/material-symbols-latex

Use Material Symbols by Google Fonts in LaTeX through simple commands.
https://github.com/exception0x0194/material-symbols-latex

icons latex material-design material-icons material-symbols

Last synced: 6 days ago
JSON representation

Use Material Symbols by Google Fonts in LaTeX through simple commands.

• Host: GitHub
• URL: https://github.com/exception0x0194/material-symbols-latex
• Owner: Exception0x0194
• Created: 2024-08-14T12:37:12.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-20T12:05:00.000Z (3 months ago)
• Last Synced: 2024-10-17T08:41:51.136Z (22 days ago)
• Topics: icons, latex, material-design, material-icons, material-symbols
• Language: TeX
• Homepage:
• Size: 8.85 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Material Symbols for LaTeX

![Showcase of symbols](docs/showcase.jpg)

**Check [introduction.pdf](/docs/introduction.pdf) for more documentations, usage examples, and full list of available symbols.**

This LaTeX package enables the easy integration of [Google's Material Symbols](https://fonts.google.com/icons) into LaTeX documents, supporting `XeLaTeX` and `LuaLaTeX`. It provides access to a wide range of icons in various styles, enhancing the visual appeal of documents.

## Prerequisites

- `XeLaTeX` or `LuaLaTeX`: This package is compatible with `XeLaTeX` and `LuaLaTeX` to utilize font features.

## Installation

1. Clone this repository or download the ZIP file.

2. Copy the package files into your LaTeX project directory or a location where LaTeX can find it.

3. Include the package in your LaTeX document preamble with `\usepackage{material-symbols}`.

## Usage

To use a symbol in your document, use the `\mSymbol{name}` command, where `name` is the kebab-case name of the symbol as defined in [Google Fonts](https://fonts.google.com/icons).

### Example

```latex

\documentclass{article}

\usepackage{material-symbols}

\begin{document}

Here is a Material Symbol: \mSymbol{sports-soccer}.

\end{document}

```

Refer to [source code of project's introduction.pdf](/example-main.tex) for more examples.

### Styles

To specify a style, use the optional argument:

- `\mSymbol[outlined]{icon-name}` for Outlined style (default).

- `\mSymbol[rounded]{icon-name}` for Rounded style.

- `\mSymbol[sharp]{icon-name}` for Sharp style.

- `\mSymbol[outlined-filled]{icon-name}` for Outlined Filled style.

- `\mSymbol[rounded-filled]{icon-name}` for Rounded Filled style.

- `\mSymbol[sharp-filled]{icon-name}` for Sharp Filled style.

## List of Icons

For a full list of available icons and their names, please refer to the included icon table in the [package documentation](docs/introduction.pdf) or visit [Google Fonts Site](https://fonts.google.com/icons).