Git Product home page Git Product logo

simple-styleguide's Introduction

Simple styleguide

You will need your server to serve styleguide.html someplace in your site. Setting up a route for /styleguide/ is ideal. You may want to consider if you want your styleguide to be publicly accessible or not, and apply permissions as appropriate.

To set up the styleguide, edit styleguide.html to include links to your own site's CSS assets. The javascript dependencies that the styleguide depends on (other than its own styleguide.js) are included via CDN - you can swap these links out if you would prefer to host locally.

You may want to add some additional markup so that the styleguide can be embedded more gracefully in your site, e.g. by adding your normal site navigation before the styleguide HTML starts.

Finally, start adding your own section block in styleguide.html to document the HTML markup for commonly used components in your site. As the file uses your own stylesheets, the markup should automatically inherit the correct styling, and update itself as your styles evolve.

simple-styleguide's People

Contributors

jenofdoom avatar

Watchers

 avatar  avatar  avatar

Forkers

mapasteper

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.