Cupcake Documentation

CD

Project Explanation:

As we all know "If it isn't documented it didn't happen!".
I needed to document and centralize efforts invloved with the Cupcake Design System.

We also needed a way to grow the library with larger patterns and page layouts. I built a jekyll documentation site that also embeds the angular library via Storybook.

This allows us to use markdown to write docs and then publish with jekyll. We can also expose the same yaml variables from our core design tokens to loop with jekyll - reducing duplication and keeping things in sync.

Company:
IHS Markit & Ipreo
Skills:

HTML, SCSS, Design, Jekyll, Angular

Tools:
Project Link:
View Cupcake Documentation


I used Jekyll to build the documentation page. View the code here
I use front matter data to determine if there is a corresponding angular component and then embed the storybook reference under a tab. View a content example

In Summary.

The docs page centralizes all of the work we do. UX Design / HTML / CSS / Angular it all lives here.

© 2020 Josh Easter - All Rights Reserved