Git Product home page Git Product logo

docs-tools's Introduction

Docz Tools

Some handy components for documenting Happeo UI Kit in MDX, written in React.

List of components

PackageMetadata

import pkg from "../package.json";
<PackageMetadata pkg={pkg} />

ColorExample

<ColorExample hex={"#29C4A9"} name="brand" />

BackgroundBox

Simple styled component to to be used for example with <ColorExample>.

  <BackgroundBox>
    <ColorExample hex={"#ffffff"} name="white" darkText={true} />
  </BackgroundBox>

ShadeGrid

<ShadeGrid colors={{
    navy: "#1A5D8D",
    active: "#009DFF",
    success: "#29C47F",
    warn: "#FABD24",
    alert: "#EC4B2F",
    violet: "#5E2590",
}} shadeFns={{
    darken20: (color) => darken(0.2, color),
    desaturate: (color) => desaturate(0.2, color)
}}/>

MarginExample

Use "Shorthand property names" to get the variable name as padding name.

const hugeMargin = "40px";
<MarginExample margin={{hugeMargin}} />

PaddingExample

Use "Shorthand property names" to get the variable name as padding name.

const hugePadding = "40px"
<PaddingExample padding={{hugePadding}} />

docs-tools's People

Contributors

ristinolla avatar loicmasson2 avatar

Watchers

James Cloos avatar Jeremie Dutruit avatar  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.