jekyll-styleguide

0.0.1 • Public • Published

Jekyll Styleguide

Installation

# Install Jekyll and Bundler gems through RubyGems 
~ $ gem install jekyll
 
# Build the styleguide on the preview server 
~ $ jekyll serve

Usage

Fill the properties inside _config.yml:

# Styleguide specific 
styleguide-css: ""  # (opt) your styleguide stylesheet url 
styleguide-js: ""   # (opt) your styleguide javascript url 

or place your styleguide stylesheet inside the /dist folder (names should be the same):

dist
├── css
│   └── styleguide.css
└── js
    └── styleguide.js

FAQ

I don't like the styleguide/ path in my browser url, can I change it to dog/?

Change your _config.yml collection to:

collections:
  styleguide:
    output: true
    permalink: dog/:path/

I want more than two-level secondary menu, is it possible ?

Not yet sadly.

TODO

  • Change example tag to support resize handles
  • Add search feature
  • Make left menu collapse somehow
  • Make TOC styles
  • Add copy plugin
  • Add footer

Credits

Package Sidebar

Install

npm i jekyll-styleguide

Weekly Downloads

1

Version

0.0.1

License

MIT

Last publish

Collaborators

  • clenemt