Skip to content
This repository has been archived by the owner on Nov 10, 2023. It is now read-only.

inkline/vue-cli-plugin-inkline

Repository files navigation

Deprecated

To use Inkline with Vue.js CLI, please refer to the Installation Documentation.


Inkline logo

Inkline - Vue.js CLI Plugin

Vue.js CLI Plugin for Inkline, the intuitive UI Components library that gives you the foundation for building high quality, accessible, and customizable Vue.js Design Systems.

Inkline is written and maintained by @alexgrozav.

Homepage · Documentation · Storybook · Playground · Issue Tracker

Install for Vue.js 3

If you haven't yet installed Vue.js CLI, first follow the installation instructions here.

If you haven't created a project yet, generate a project using Vue CLI:

vue create my-app
cd my-app

Before installing the Inkline plugin, make sure to commit or stash your changes in case you need to revert.

Add Inkline:

vue add @inkline/vue-cli-plugin-inkline

Install for Vue 2

Inkline for Vue 2 will stick to the 2.x versions.

For Vue2:

vue add @inkline/vue-cli-plugin-inkline --vue2

Configuration

Optionally, you can configure your Inkline Vue CLI Plugin using the following installation options.

First of all, Inkline uses Sass, so you will need to install it as a dependency:

yarn add --dev node-sass sass-loader
# If you still use NPM
npm install -D node-sass sass-loader

Tree Shaking and SCSS

To install a tree-shaking and SCSS ready Inkline setup:

vue add @inkline/vue-cli-plugin-inkline --vue2 --customizable

Creator

Alex Grozav

If you use Inkline in your daily work and feel that it has made your life easier, please consider sponsoring me on Github Sponsors. 💖

Copyright and license

Code copyright 2017-2022 Inkline Authors. Code released under the MIT License.