Files
lucide/docs/index.md
Eric Fennis 6f7c94efa5 Add packages sections (#402)
* Add markdown support

* Fix a lot of issues

* Add core components

* Add codeblocks

* fix codeblocks

* Add More components

* add links

* Fix loading docs

* Fix docs

* Fix empty lines

* small Fix

* Add heading provider

* created menu

* remove borderline

* Add mobilemenu component

* add next env

* update code style

* generate heading element positions

* Add package pages

* add fetch packages

* Add lucide logo

* Add icons and adjust description

* improve some things

* fix types

* Fix logo types

* fix types

* Add logo's

* update packages docs

* resize icons

* small changes

* update packages links
2021-10-01 09:19:36 +02:00

2.7 KiB
Raw Permalink Blame History

title
title
Introduction

Introduction

What is Lucide?

Lucide is a community-run fork of Feather Icons, open for anyone to contribute icons.

It began after growing disaffection of the Feather Icons project moderation. With over 300+ open issues and over 100+ open PRs, the Feather Icons project has been abandoned. This unfortunately means that hundreds of developers and designers wasted their time contributing to Feather Icons with no chance of PRs being accepted.

Lucide is trying to expand the icon set as much as possible while staying faithful to the original simplistic design language. We do this as a community of devs and designers and hope that you'll join us!

Why choose Lucide over Feather Icons

  • Lucide already expended the icon set by 130+ in less then a year, so more icons to work with.
  • Well maintained code base.
  • Active community.

Getting Started

At its core, Lucide is a collection of SVG files. This means that you can use Lucide icons in all the same ways you can use SVGs (e.g. img, background-image, inline, object, embed, iframe). Here's a helpful article detailing the many ways SVGs can be used on the web: SVG on the Web Implementation Options

Using Lucide packages

Web

Implementation of the lucide icon library for web applications.

npm install lucide

#or

yarn add lucide

For more details, see the documentation.

React

Implementation of the lucide icon library for react applications.

yarn add lucide-react

# or

npm install lucide-react

For more details, see the documentation.

Vue 2

Implementation of the lucide icon library for vue applications.

yarn add lucide-vue

# or

npm install lucide-vue

For more details, see the documentation.

Vue 3

Implementation of the lucide icon library for vue applications.

yarn add lucide-vue-next

# or

npm install lucide-vue-next

For more details, see the documentation.

Angular

yarn add lucide-angular

# or

npm install lucide-angular

For more details, see the documentation.

Preact

Implementation of the lucide icon library for preact applications.

yarn add lucide-preact

# or

npm install lucide-preact

For more details, see the documentation.

Figma

The lucide figma plugin.

Visit Figma community page to install the plugin.

Figma Lucide Cover