GithubHelp home page GithubHelp logo

pwfoo / petal Goto Github PK

View Code? Open in Web Editor NEW

This project forked from shakrmedia/petal

0.0 2.0 0.0 1.75 MB

A modern, light CSS UI framework by Shakr

Home Page: https://shakrmedia.github.io/petal

License: MIT License

JavaScript 10.00% CSS 38.52% HTML 51.48%

petal's Introduction

Petal CircleCI

Petal is a modern, light CSS UI framework developed at Shakr.

Petal aims to provide an ample set of consistently designed UI components you can easily utilize in your web projects.

Petal is fully coded on LESS from scratch.

Setting up Petal in your project

Download the latest release, copy the dist folder to your project folder. (You may want to rename it to something else.)

Insert the link to stylesheet in the <head> of your html:

<link rel="stylesheet" type="text/css" href="dist/petal.min.css">

Now you can use all the Petal classes and styles in your project's HTML file.

(If you need a pre-built, hosted CDN link, use the rawgit URL as explained in the documentation.)

Alternatively, if you want to install through npm, run

npm install petal.less

in your console.

Please refer to the documentation for other advanced ways to use Petal in your project.

Developing Petal

Build Petal

Petal uses Grunt for compiling LESS files to a single petal.css file. Run grunt petal to compile Petal for a single time. Run grunt dev to go into development mode where files in the Petal directory will be watched, building automatically when you make changes to any of the source files. (This will also build the documentation.)

Build Docs

Petal's documentation is built using Assemble. Run grunt (default task) to build Petal and documentation pages for a single time, grunt dev for continuous watching and automatic building. The documentation will be built into docs folder.

The dev task will also run a local webserver based on the docs folder. While running the dev task, you can access the built documentation at localhost:9000. The pages will also livereload when you save any of the watched files.

Changelog

Please view Releases for the changelog.

Attribution

Author

License

Released under the MIT License. See LICENSE for details.

petal's People

Contributors

zvuc avatar premist avatar log2-hwan avatar dependabot[bot] avatar gaeulbyul avatar

Watchers

James Cloos 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.