Git Product home page Git Product logo

kss-offscreen-twig's Introduction

Builder for kss-node with offscreen menu using Twig

Requires KSS-node 3.0.x

This is a builder for kss-node living styleguide. It feature a toggle-able sidebar menu so you can choose to see the styleguide at full browser width. It also has a search function to easily find your component.

You can see the demo here.

How to apply this builder

  1. Install kss-node. Type npm install kss or npm install -g kss for global CLI.
  2. Install this template npm install kss-offscreen-twig@alpha
  3. Run kss-node command with --builder option, like below.
kss-node <sourcedir> --builder path/to/kss-offscreen-twig

This is a pre-release version of kss-offscreen-twig

Changelog:

  • No reliance on jQuery. Existing js rewritten in vanilla JS.
  • Removal of prettify, scrollspy, and fullscreen js.
  • Removal of Markup section (Developers must view source, or view twig files).
  • Mockups/Templates do not display examples.
  • All components can open in a new window, without any KSS chrome (hideAll).
  • Offscreen CSS transitions removed.
  • Component modifiers display as seperate examples, with less prominent KSS chrome.
  • Component modifier CSS classes are no longer visible.
  • Header no longer sticks.
  • Specify showMarkup, highlightSyntax, markupClass from config.
  • Fix position of menu toggle button.
  • Add sidebar backdrop for small screens when clicked closes menu.

kss-offscreen-twig's People

Contributors

dependabot[bot] avatar flxa avatar jptaranto avatar kimpepper avatar rikki-iki avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

rikki-iki

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.