Neko

Enhancing Visuals with Icons and Emojis

Neko Team

Enhancing Visuals with Icons and Emojis

Text can be dry, but documentation doesn't have to be. Neko integrates Flaticon UIcons and standard Emojis to bring life to your pages.

Using Icons

Neko supports UIcons using a simple shortcode syntax. You can use any icon from the Flaticon UIcons Regular Rounded set.

Syntax

:icon-home: Home
:icon-settings: Settings
:icon-user: Profile

Example

This is a button with an icon:

[!button :icon-download: Download Now]

Using Emojis

Neko supports standard GitHub-flavored emojis.

Syntax

:smile: :heart: :rocket: :tada:

Emoji Table

You can even use a table of emojis for reference:

:smile: | :heart: | :rocket:
--- | --- | ---
Happy | Love | Launch

Why use Icons?

  • Recognition: Icons help users quickly identify sections or actions.
  • Visual Break: They break up walls of text, making content easier to scan.
  • Consistency: Using a consistent icon set improves the professional look of your docs.

Start adding icons to your headings, buttons, and alerts today!