lgs / inkline

Inkline is a modern UI/UX framework designed for creating flawless responsive websites.

Inkline

Inkline is a modern UI/UX framework designed for creating flawless responsive websites. Inkline is written and maintained by @alexgrozav.

Homepage · Documentation · Issue Tracker

Table of contents

• Installation
• Usage
• CDN
• Bugs and feature requests
• Contributing
• Community
• Project Completion
• Previous releases
• Versioning
• Creators
• Copyright and license

Installation

Read the Getting started page for information on the framework contents, templates, examples, and more.

• Install with npm:

npm install --save @inkline/inkline

• Install with yarn:

yarn add @inkline/inkline

• Install with composer:

composer require inkline/inkline

Usage

First, we'll import the core styles, after which we import and register the script files. If you already have your Webpack configuration ready for Vue, importing the framework is as simple as:

import Vue from 'vue';
import '@inkline/inkline/dist/inkline.css';
import Inkline from '@inkline/inkline';

Vue.use(Inkline);

Next, start using the many components that Inkline has to offer.

CDN

If you're not using using package managers and build systems and you want to add Inkline to your project, you can import the compiled files from CDN:

<link href="https://cdn.jsdelivr.net/npm/@inkline/inkline/dist/inkline.css" rel="stylesheet">
<script src="https://cdn.jsdelivr.net/npm/@inkline/inkline/dist/inkline.js"></script>

You can also try it out live on JSFiddle.

Bugs and feature requests

Have a bug or a feature request? Please first search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Community

Get updates on Inkline's development and chat with the project maintainers and community members.

• Follow @inklineUX on Twitter.
• Developers should use the keyword inkline on packages which modify or add to the functionality of Inkline when distributing through npm or similar delivery mechanisms for maximum discoverability.

Releases

Previous releases and their documentation are also available for download.

Versioning

For increased transparency and backward compatibility, Inkline is maintained under the Semantic Versioning guidelines.

Creator

Alex Grozav

• https://twitter.com/alexgrozav
• https://facebook.com/alexgrozav
• https://github.com/alexgrozav

Copyright and license

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