docs-builder
Icons
You can include icons in your documentation using the {icon}`icon-name` syntax. For example, writing {icon}`check` will render a checkmark icon.
Here is a list of all available icons:
| Syntax | Icon |
|---|---|
{icon}`accessibility` |
|
{icon}`aggregate` |
|
{icon}`analyzeEvent` |
|
{icon}`annotation` |
|
{icon}`anomaly_chart` |
|
{icon}`anomaly_swim_lane` |
|
{icon}`apm_trace` |
|
{icon}`app_add_data` |
|
{icon}`app_advanced_settings` |
|
{icon}`app_agent` |
|
{icon}`app_apm` |
|
{icon}`app_app_search` |
|
{icon}`app_auditbeat` |
|
{icon}`app_canvas` |
|
{icon}`app_cases` |
|
{icon}`app_code` |
|
{icon}`app_console` |
|
{icon}`app_cross_cluster_replication` |
|
{icon}`app_dashboard` |
|
{icon}`app_devtools` |
|
{icon}`app_discover` |
|
{icon}`app_ems` |
|
{icon}`app_filebeat` |
|
{icon}`app_fleet` |
|
{icon}`app_gis` |
|
{icon}`app_graph` |
|
{icon}`app_grok` |
|
{icon}`app_heartbeat` |
|
{icon}`app_index_management` |
|
{icon}`app_index_pattern` |
|
{icon}`app_index_rollup` |
|
{icon}`app_lens` |
|
{icon}`app_logs` |
|
{icon}`app_management` |
|
{icon}`app_metricbeat` |
|
{icon}`app_metrics` |
|
{icon}`app_ml` |
|
{icon}`app_monitoring` |
|
{icon}`app_notebook` |
|
{icon}`app_packetbeat` |
|
{icon}`app_pipeline` |
|
{icon}`app_recently_viewed` |
|
{icon}`app_reporting` |
|
{icon}`app_saved_objects` |
|
{icon}`app_search_profiler` |
|
{icon}`app_security` |
|
{icon}`app_security_analytics` |
|
{icon}`app_spaces` |
|
{icon}`app_sql` |
|
{icon}`app_timelion` |
|
{icon}`app_upgrade_assistant` |
|
{icon}`app_uptime` |
|
{icon}`app_users_roles` |
|
{icon}`app_visualize` |
|
{icon}`app_vulnerability_management` |
|
{icon}`app_watches` |
|
{icon}`app_workplace_search` |
|
{icon}`apps` |
|
{icon}`arrowEnd` |
|
{icon}`arrowStart` |
|
{icon}`arrow_down` |
|
{icon}`arrow_left` |
|
{icon}`arrow_right` |
|
{icon}`arrow_up` |
|
{icon}`article` |
|
{icon}`asterisk` |
|
{icon}`at` |
|
{icon}`bell` |
|
{icon}`bellSlash` |
|
{icon}`beta` |
|
{icon}`bolt` |
|
{icon}`boxes_horizontal` |
|
{icon}`boxes_vertical` |
|
{icon}`branch` |
|
{icon}`branchUser` |
|
{icon}`broom` |
|
{icon}`brush` |
|
{icon}`bug` |
|
{icon}`bullseye` |
|
{icon}`calendar` |
|
{icon}`change_point_detection` |
|
{icon}`check` |
|
{icon}`checkCircle` |
|
{icon}`checkInCircleFilled` |
|
{icon}`cheer` |
|
{icon}`clickLeft` |
|
{icon}`clickRight` |
|
{icon}`clock` |
|
{icon}`clockCounter` |
|
{icon}`cloudDrizzle` |
|
{icon}`cloudStormy` |
|
{icon}`cloudSunny` |
|
{icon}`cluster` |
|
{icon}`code` |
|
{icon}`color` |
|
{icon}`comment` |
|
{icon}`compute` |
|
{icon}`console` |
|
{icon}`container` |
|
{icon}`continuityAbove` |
|
{icon}`continuityAboveBelow` |
|
{icon}`continuityBelow` |
|
{icon}`continuityWithin` |
|
{icon}`contrast` |
|
{icon}`contrastHigh` |
|
{icon}`controls` |
|
{icon}`copy` |
|
{icon}`copy_clipboard` |
|
{icon}`cross` |
|
{icon}`cross_in_circle` |
|
{icon}`crosshairs` |
|
{icon}`currency` |
|
{icon}`cut` |
|
{icon}`database` |
|
{icon}`desktop` |
|
{icon}`diff` |
|
{icon}`document` |
|
{icon}`documentEdit` |
|
{icon}`documentation` |
|
{icon}`documents` |
|
{icon}`dot` |
|
{icon}`dotInCircle` |
|
{icon}`doubleArrowLeft` |
|
{icon}`doubleArrowRight` |
|
{icon}`download` |
|
{icon}`editorDistributeHorizontal` |
|
{icon}`editorDistributeVertical` |
|
{icon}`editorItemAlignBottom` |
|
{icon}`editorItemAlignCenter` |
|
{icon}`editorItemAlignLeft` |
|
{icon}`editorItemAlignMiddle` |
|
{icon}`editorItemAlignRight` |
|
{icon}`editorItemAlignTop` |
|
{icon}`editorPositionBottomLeft` |
|
{icon}`editorPositionBottomRight` |
|
{icon}`editorPositionTopLeft` |
|
{icon}`editorPositionTopRight` |
|
{icon}`editor_align_center` |
|
{icon}`editor_align_left` |
|
{icon}`editor_align_right` |
|
{icon}`editor_bold` |
|
{icon}`editor_checklist` |
|
{icon}`editor_heading` |
|
{icon}`editor_italic` |
|
{icon}`editor_link` |
|
{icon}`editor_ordered_list` |
|
{icon}`editor_redo` |
|
{icon}`editor_strike` |
|
{icon}`editor_table` |
|
{icon}`editor_underline` |
|
{icon}`editor_undo` |
|
{icon}`editor_unordered_list` |
|
{icon}`email` |
|
{icon}`empty` |
|
{icon}`endpoint` |
|
{icon}`eql` |
|
{icon}`eraser` |
|
{icon}`error` |
|
{icon}`errorFilled` |
|
{icon}`esqlVis` |
|
{icon}`exit` |
|
{icon}`expand` |
|
{icon}`expandMini` |
|
{icon}`export` |
|
{icon}`eye` |
|
{icon}`eye_closed` |
|
{icon}`face_happy` |
|
{icon}`face_neutral` |
|
{icon}`face_sad` |
|
{icon}`field_statistics` |
|
{icon}`filter` |
|
{icon}`filterExclude` |
|
{icon}`filterIgnore` |
|
{icon}`filterInCircle` |
|
{icon}`filterInclude` |
|
{icon}`flag` |
|
{icon}`flask` |
|
{icon}`fold` |
|
{icon}`folder_check` |
|
{icon}`folder_closed` |
|
{icon}`folder_exclamation` |
|
{icon}`folder_open` |
|
{icon}`frameNext` |
|
{icon}`framePrevious` |
|
{icon}`fullScreenExit` |
|
{icon}`full_screen` |
|
{icon}`function` |
|
{icon}`gear` |
|
{icon}`globe` |
|
{icon}`grab` |
|
{icon}`grabOmnidirectional` |
|
{icon}`grab_horizontal` |
|
{icon}`gradient` |
|
{icon}`grid` |
|
{icon}`heart` |
|
{icon}`heatmap` |
|
{icon}`help` |
|
{icon}`home` |
|
{icon}`image` |
|
{icon}`import` |
|
{icon}`index` |
|
{icon}`indexTemporary` |
|
{icon}`index_close` |
|
{icon}`index_edit` |
|
{icon}`index_flush` |
|
{icon}`index_mapping` |
|
{icon}`index_open` |
|
{icon}`index_runtime` |
|
{icon}`index_settings` |
|
{icon}`infinity` |
|
{icon}`info` |
|
{icon}`inputOutput` |
|
{icon}`inspect` |
|
{icon}`invert` |
|
{icon}`ip` |
|
{icon}`key` |
|
{icon}`keyboard` |
|
{icon}`kql_field` |
|
{icon}`kql_function` |
|
{icon}`kql_operand` |
|
{icon}`kql_selector` |
|
{icon}`kql_value` |
|
{icon}`kubernetesNode` |
|
{icon}`kubernetesPod` |
|
{icon}`launch` |
|
{icon}`layers` |
|
{icon}`lettering` |
|
{icon}`lineDashed` |
|
{icon}`lineDotted` |
|
{icon}`lineSolid` |
|
{icon}`link` |
|
{icon}`list` |
|
{icon}`list_add` |
|
{icon}`lock` |
|
{icon}`lockOpen` |
|
{icon}`log_pattern_analysis` |
|
{icon}`log_rate_analysis` |
|
{icon}`logo_aerospike` |
|
{icon}`logo_apache` |
|
{icon}`logo_app_search` |
|
{icon}`logo_aws` |
|
{icon}`logo_aws_mono` |
|
{icon}`logo_azure` |
|
{icon}`logo_azure_mono` |
|
{icon}`logo_beats` |
|
{icon}`logo_business_analytics` |
|
{icon}`logo_ceph` |
|
{icon}`logo_cloud` |
|
{icon}`logo_cloud_ece` |
|
{icon}`logo_code` |
|
{icon}`logo_codesandbox` |
|
{icon}`logo_couchbase` |
|
{icon}`logo_docker` |
|
{icon}`logo_dropwizard` |
|
{icon}`logo_elastic` |
|
{icon}`logo_elastic_stack` |
|
{icon}`logo_elasticsearch` |
|
{icon}`logo_enterprise_search` |
|
{icon}`logo_etcd` |
|
{icon}`logo_gcp` |
|
{icon}`logo_gcp_mono` |
|
{icon}`logo_github` |
|
{icon}`logo_gmail` |
|
{icon}`logo_golang` |
|
{icon}`logo_google_g` |
|
{icon}`logo_haproxy` |
|
{icon}`logo_ibm` |
|
{icon}`logo_ibm_mono` |
|
{icon}`logo_kafka` |
|
{icon}`logo_kibana` |
|
{icon}`logo_kubernetes` |
|
{icon}`logo_logging` |
|
{icon}`logo_logstash` |
|
{icon}`logo_maps` |
|
{icon}`logo_memcached` |
|
{icon}`logo_metrics` |
|
{icon}`logo_mongodb` |
|
{icon}`logo_mysql` |
|
{icon}`logo_nginx` |
|
{icon}`logo_observability` |
|
{icon}`logo_osquery` |
|
{icon}`logo_php` |
|
{icon}`logo_postgres` |
|
{icon}`logo_prometheus` |
|
{icon}`logo_rabbitmq` |
|
{icon}`logo_redis` |
|
{icon}`logo_security` |
|
{icon}`logo_site_search` |
|
{icon}`logo_sketch` |
|
{icon}`logo_slack` |
|
{icon}`logo_uptime` |
|
{icon}`logo_vulnerability_management` |
|
{icon}`logo_webhook` |
|
{icon}`logo_windows` |
|
{icon}`logo_workplace_search` |
|
{icon}`logstash_filter` |
|
{icon}`logstash_if` |
|
{icon}`logstash_input` |
|
{icon}`logstash_output` |
|
{icon}`logstash_queue` |
|
{icon}`magnet` |
|
{icon}`magnifyWithExclamation` |
|
{icon}`magnifyWithMinus` |
|
{icon}`magnifyWithPlus` |
|
{icon}`map_marker` |
|
{icon}`memory` |
|
{icon}`menu` |
|
{icon}`menuDown` |
|
{icon}`menuLeft` |
|
{icon}`menuRight` |
|
{icon}`menuUp` |
|
{icon}`merge` |
|
{icon}`minimize` |
|
{icon}`minus` |
|
{icon}`minus_in_circle` |
|
{icon}`minus_in_circle_filled` |
|
{icon}`minus_in_square` |
|
{icon}`ml_classification_job` |
|
{icon}`ml_create_advanced_job` |
|
{icon}`ml_create_generic_job` |
|
{icon}`ml_create_geo_job` |
|
{icon}`ml_create_multi_metric_job` |
|
{icon}`ml_create_population_job` |
|
{icon}`ml_create_single_metric_job` |
|
{icon}`ml_data_visualizer` |
|
{icon}`ml_outlier_detection_job` |
|
{icon}`ml_regression_job` |
|
{icon}`mobile` |
|
{icon}`moon` |
|
{icon}`move` |
|
{icon}`namespace` |
|
{icon}`nested` |
|
{icon}`new_chat` |
|
{icon}`node` |
|
{icon}`number` |
|
{icon}`offline` |
|
{icon}`online` |
|
{icon}`package` |
|
{icon}`pageSelect` |
|
{icon}`pagesSelect` |
|
{icon}`paint` |
|
{icon}`palette` |
|
{icon}`paper_clip` |
|
{icon}`partial` |
|
{icon}`pause` |
|
{icon}`payment` |
|
{icon}`pencil` |
|
{icon}`percent` |
|
{icon}`pin` |
|
{icon}`pin_filled` |
|
{icon}`pipeBreaks` |
|
{icon}`pipeNoBreaks` |
|
{icon}`pivot` |
|
{icon}`play` |
|
{icon}`playFilled` |
|
{icon}`plugs` |
|
{icon}`plus` |
|
{icon}`plus_in_circle` |
|
{icon}`plus_in_circle_filled` |
|
{icon}`plus_in_square` |
|
{icon}`popout` |
|
{icon}`push` |
|
{icon}`question` |
|
{icon}`quote` |
|
{icon}`readOnly` |
|
{icon}`refresh` |
|
{icon}`reporter` |
|
{icon}`return_key` |
|
{icon}`save` |
|
{icon}`scale` |
|
{icon}`search` |
|
{icon}`section` |
|
{icon}`securitySignal` |
|
{icon}`securitySignalDetected` |
|
{icon}`securitySignalResolved` |
|
{icon}`sessionViewer` |
|
{icon}`shard` |
|
{icon}`share` |
|
{icon}`single_metric_viewer` |
|
{icon}`snowflake` |
|
{icon}`sortAscending` |
|
{icon}`sortDescending` |
|
{icon}`sortLeft` |
|
{icon}`sortRight` |
|
{icon}`sort_down` |
|
{icon}`sort_up` |
|
{icon}`sortable` |
|
{icon}`spaces` |
|
{icon}`sparkles` |
|
{icon}`starPlusEmpty` |
|
{icon}`starPlusFilled` |
|
{icon}`star_empty` |
|
{icon}`star_empty_space` |
|
{icon}`star_filled` |
|
{icon}`star_filled_space` |
|
{icon}`star_minus_empty` |
|
{icon}`star_minus_filled` |
|
{icon}`stats` |
|
{icon}`stop` |
|
{icon}`stop_filled` |
|
{icon}`stop_slash` |
|
{icon}`storage` |
|
{icon}`string` |
|
{icon}`submodule` |
|
{icon}`sun` |
|
{icon}`swatch_input` |
|
{icon}`symlink` |
|
{icon}`tableOfContents` |
|
{icon}`table_density_compact` |
|
{icon}`table_density_expanded` |
|
{icon}`table_density_normal` |
|
{icon}`tag` |
|
{icon}`tear` |
|
{icon}`temperature` |
|
{icon}`timeRefresh` |
|
{icon}`timeline` |
|
{icon}`timelineWithArrow` |
|
{icon}`timeslider` |
|
{icon}`training` |
|
{icon}`transitionLeftIn` |
|
{icon}`transitionLeftOut` |
|
{icon}`transitionTopIn` |
|
{icon}`transitionTopOut` |
|
{icon}`trash` |
|
{icon}`unfold` |
|
{icon}`unlink` |
|
{icon}`user` |
|
{icon}`users` |
|
{icon}`vector` |
|
{icon}`videoPlayer` |
|
{icon}`vis_area` |
|
{icon}`vis_area_stacked` |
|
{icon}`vis_bar_horizontal` |
|
{icon}`vis_bar_horizontal_stacked` |
|
{icon}`vis_bar_vertical` |
|
{icon}`vis_bar_vertical_stacked` |
|
{icon}`vis_gauge` |
|
{icon}`vis_goal` |
|
{icon}`vis_line` |
|
{icon}`vis_map_coordinate` |
|
{icon}`vis_map_region` |
|
{icon}`vis_metric` |
|
{icon}`vis_pie` |
|
{icon}`vis_table` |
|
{icon}`vis_tag_cloud` |
|
{icon}`vis_text` |
|
{icon}`vis_timelion` |
|
{icon}`vis_visual_builder` |
|
{icon}`warning` |
|
{icon}`warningFilled` |
|
{icon}`web` |
|
{icon}`wordWrap` |
|
{icon}`wordWrapDisabled` |
|
{icon}`wrench` |
You can use icons in various Markdown elements.
You can include icons in headings:
#### Test the {icon}`gear` Settings
#### User Profile {icon}`user`
Icons can be used in both ordered and unordered lists.
Unordered List:
- Task one completed
- Task two completed
- Task three pending
Ordered List:
- First item
- Second item
- Third item
**Unordered List:**
* {icon}`check` Task one completed
* {icon}`check` Task two completed
* {icon}`cross` Task three pending
**Ordered List:**
1. {icon}`check` First item
2. {icon}`check` Second item
3. {icon}`cross` Third item
Icons can be used within table cells.
| Status | Description |
|---|---|
| Success | |
| Warning | |
| Error |
| Status | Description |
|:--------------:|:------------|
| {icon}`checkCircle` | Success |
| {icon}`warning` | Warning |
| {icon}`error` | Error |
Icons can be placed at the beginning of a paragraph.
You can also use icons directly in your text for emphasis, like this magic moment.
{icon}`sparkles` Icons can be placed at the beginning of a paragraph.
You can also use icons directly in your text for emphasis, like this {icon}`sparkles` magic {icon}`sparkles` moment.