Code Monkey home page Code Monkey logo

base-icon's Introduction

@tadashi/base-icon

Everything you need to build an icon library, powered by @steeze-ui/icons.

Creating a project

Run the command below to create a skeleton project.

# create a new project in the current directory
npx tiged lagden/base-icon#main my-icon-project
cd my-icon-project
npm install

Building

Once you've created a project, put the svg files into svg/raw directory.

⚠️ Warning

The file names must be respect the kebab-case convention.


After that, run the command:

npm run build:icons

The command will generate:

  • svg/optimized directory
  • themes/default directory
  • src/lib/index.ts file
  • src/lib/types.d.ts file

You can see the generated icons by running the command:

npm run dev

Publishing

Go into the package.json and give your package the desired name through the "name" propertie. Also consider adding a "license" field and point it to a LICENSE file which you can create from a template (one popular option is the MIT license).

To publish your library to npm:

npm publish

Usage

See an example how to use the icon library in your project.
https://svelte.dev/repl/fd948eca90d74e6c960503acd5972268

Donate ❤️

BTC: bc1q7famhuj5f25n6qvlm3sssnymk2qpxrfwpyq7g4

License

MIT © Thiago Lagden MIT © Justin Voitel

base-icon's People

Contributors

lagden avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.