Giter Club home page Giter Club logo

style-guide-guide's Introduction

Style Guide Guide

Style Guide Guide is a boilerplate for creating a custom style guide for your organization's design system. It provides just enough IA and hooks to get you going. As a bonus, I've provided links to helpful resources and inspiration to help you as you create your own custom style guide.

See the demo here

How it works

Style Guide Guide is built using Jekyll, a static site generator which works quite well for managing the content of a style guide.

The tool can consume and display components from anywhere, but in my own workflow we import patterns from Pattern Lab into Style Guide Guide for display. For more info, check out this blog post (coming soon for now).

Getting Started

  1. Download or clone the files from the repository on Github.
  2. In the command line, navigate to the root of the project and run the jekyll serve command. This will build the static site and watch for changes.
  3. Visit http://127.0.0.1:4000/ in your browser to see the style guide.

From here, obviously the point is to customize the style guide for your needs and populate it with your content and components.

Importing components and assets from Pattern Lab

Coming soon!

Feedback and Questions

If you have questions or issues with Style Guide Guide, please feel free to open an issue. If your organization is creating a design system and style guide and would like some help taking it to the next level, feel free to get in touch!

style-guide-guide's People

Contributors

alisonjoseph avatar bandit avatar bradfrost avatar curtisj44 avatar frostyweather avatar katiemfritz avatar martskin avatar patrickhlauke avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

style-guide-guide's Issues

Grid Nav links not working

For some reason, all the c-grid-nav links aren't working.

screen shot 2016-06-20 at 11 16 59 am

I checked in Chrome, Firefox, and Safari, and none of these links take you through to the appropriate page. The links look like they're all pointing to the right place, so I'm wondering if maybe there's a formatting issue or something?

Restructure Sass Partials

The SCSS structure should look like this

/css
  /scss
    /abstracts
    /base
    /utilities
    /layout
    /components
    /scope
  • Abstracts include variables, mixins, and other Sass-specific stuff.
  • Base are base styles like headings, paragraphs, etc
  • Utilities will be utility/helper classes like clearfix and stuff
  • Layout are layout styles
  • Components are all the module-specific styles
  • Scope is this.

We probably won't need scope or utilities for this site, but this is how I'm envisioning structuring Sass partials now.

More thorough documentation

Tried the tool and was having some issues understanding how to make updates. Is there a plan to add more "how-to" documentation in the near future?

If I'm understanding things correctly looking at the blocks-hero module, I have to update the rendered version as well as the markup-only files. This seems a bit difficult to maintain 2 versions. Another similar tool called Astrum has some very nice features and runs through the terminal. Check it out here:

https://github.com/NoDivide/astrum

Thanks and much appreciated!

Using Liquid within an anchor tag?

I am editing button.md and component-detail.html. In the button.md file I am creating a new variable called yammer.

fine-print:
- version: 0.3
  update: April 27, 2017
  owner: Jane Doe
  yammer:  http://github.com

In the component-detail.html file I am trying to use the yammer variable in an anchor tag like this:

<ul>
  <li>Yammer: {{ print.yammer }}</li>
</ul>
<a href="{{ print.yammer }}" class="c-btn">Discuss this on Yammer</a>

When the page renders, Yammer's value does appear in the unordered list, but does not appear within the anchor tag. Any ideas how to get this to work?

Set up IA

We'll want to set up the basic pages of the

  • / - homepage
  • /brand/ - brand homepage
  • /brand/logo - logo page
  • /brand/colors - colors
  • /brand/typography - typography
  • /brand/tagline -
  • /principles/ - principles landing
  • /voice-and-tone/ - voice and tone landing
  • /voice-and-tone/detail - voice and tone detail page (see http://voiceandtone.com/ for example)
  • /patterns/ - landing page for patterns. Note that this page will be a placeholder for other tools
  • /code/ - landing for code guidelines. This will house the answers to the questions here: https://github.com/bradfrost/frontend-guidelines-questionnaire/blob/master/README.md
  • /code/detail - detail for specific code language/section
  • /about/ - about the style guide, who to contact, etc

Adding Editorconfig?

I just came around reading #26, especially that part with spaces vs. tabs.

I was wondering, whether you would want to add a .editorconfig to make editors pick the chosen convention up :)

Patternlab interaction

Hi, I know that this things take a lot of time and effort, if you can complete the "Importing components and assets from Pattern Lab" section it'd help me a lot ๐Ÿ˜„

Thanks a lot and if let me know if I can help in anyway

Primary nav: when on child page, parent menu should be open

In the primary nav, we'll want the primary nav item to stay open if the user is on a child page for that section. For instance, if the user is on the browser support guideline page, the guidelines section in the primary nav should be open. If the user is on the data table page, components and data tables should be open.

Internacionalizaition

Is possible to add a i18n to this? How? I could help, but need details of implementation, like which "plugin" we will use, how text is rendered today, etc

Components overview page

I created a landing template that works well for guidelines and styles, but it doesn't really work the same way for the components landing page. I think this should be a simple if/else fix in the landing template. Something like if page.group == "components" then loop through the component subpage categories.

Syntax highlighting rendering

Hi!

I'm trying to get syntax highlighting to work with rouge, but for some reason the rendering is a bit off. The rendered classes for highlight seem really different than what rouge is documenting on their page (in this case, class="token tag instead of class="ng for example). I tried adding highlighter: rouge in config but that doesn't change anything.
Is there a config somewhere that i'm missing?

sidebar toggle

feature request for a sidebar toggle option to show/hide the SG component list

Active states for navigation

The primary navigation should be in the open state if you're on a detail page. For example, if you're on Code > HTML, the Code nav dropdown should be open and the HTML link should be highlighted.

A11y feature request: strong focus style to help keyboard users navigate

While the default focus ring isn't ideal (and can get lost on some backgrounds) the subtly of the current focus style can be difficult for keyboard users to spot when tabbing through.

Judging by the comments on this article [ https://www.paciellogroup.com/blog/2012/04/how-to-remove-css-outlines-in-an-accessible-manner/ ] it seems to be a complicated business getting it right for keyboard and mouse users.

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.