Skip to content

vitebo/github-vanilla

Repository files navigation

Github Vanilla

Commitizen friendly Licence MIT Continuous Integration NPM version

a component of information from a github user

view the demo for more details

Disclaimer

this is just a repository for studying web components without frameworks.

please do not expect support from the maintainer but feel free to fork or open a PR.

Usage

just import the package to use it

import '@vitebo/github-vanilla/dist/app.min';

then you have the component available

  <card-profile username="vitebo"></card-profile>

The card will render the information according to the username property

check the demo file for more details

Themes

it is possible to define the theme of your card through the css custom properties

card-profile {
  --color-primary: #01a4e9;
  --color-background-primary: #dbf4ff;
}

check the demo style form more details

there are other style variants that you can replace by following the tokens file

Versioning

To keep better organization of releases we follow the Semantic Versioning 2.0.0 guidelines.

Contributing

Find on our roadmap the next steps of the project ;)
Want to contribute? Follow these recommendations.

License

MIT License © vitebo