@system76/asset-components v2.5.0
This repository contains code for handling System76 image assets including url helpers, Fastly Image Optimization API helpers, and useful Vue components.
Using
npm install --save @system76/asset-componentsWe recommend you install the components onto your Vue instance for global component usage.
import Vue from 'vue'
import { install } from '@system76/asset-components'
install(Vue, { domain: 'https://fastly-cdn.example.com' })Look at the published Storybook for examples on how to use this library.
Development
1) Download the repository
2) Run npm ci
3) Run npm run build
4) Run npm start
5) Start hacking
Documenting
We use styleguide to document our components. Please write your own stories
and documentation in markdown format like the other .mdx files. Along with
storybook, we also use styleguidist for documentation in the component file.
This gets outputted in the form of nice prop tables in storybook. Here are some
resources on how to get started:
Deployment
To trigger a release,
push a commit to the master branch in the
Angular Commit Message Conventions
format.