/yulquen-jekyll

A responsive framework for wireframing more fancily automatically.

Do What The F*ck You Want To Public LicenseWTFPL

Yulquen

An HTML and CSS framework for prototyping interactions

Yulquen is a hack of Skeleton, a responsive CSS framework, to fit some common ways that interaction designers and other sundry UX folk prototype websites and applications. It provides some functionality for annotations and forms, with all of the styling CSS removable for handoff or more custom tweaks.

Presuppositions

  • You have passing fluency in writing HTML and CSS. Yulquen deliberately doesn't contain JavaScript, so you can use whatever library you want.
  • You are okay either with Skeleton being your production framework, or with rewriting the HTML and CSS later. Yulquen is meant to remove the pain of rewriting the same layout and behavior in code, so the latter seems a bit disingenuous.
  • You are okay with the whole thing being a static site, with no templating functionality included.

How to Use

Yulquen contains three CSS files:

  • wireframe.css: All of your CSS should go here. If you want to preserve CSS in your handoff, make another stylesheet and put your CSS there instead.
  • base.css: All of Skeleton’s styling, typography, and CSS reset. Provides a good start.
  • skeleton.css: The responsive hoo-hah that makes your grid and provides reflow for mobile layouts.

Jekyll tweaks

This is a hack of Yulquen for supporting Jekyll, a static site library in Ruby. This assumes you have a modicum of working knowledge of how Jekyll works. You should probably also know how to get Ruby running on a system (especially your own!) and how to install Jekyll as a gem on it.

In this existing system, only one template exists for you to fill with various page content. You might want to hack it to reflect many different page states, such as whether a user has logged in to a web application.

Yulquen's templates have a few variables particular to it:

  • location: Should correspond to a similar notation on your site map.
  • hidetemplate: If set to true, all annotations on the main template (denoted as .template.annotation) will be suppressed. You should use this for all pages where you don't want to re-explain all of the annotations in a page's header and footer.
  • anno: This is where your annotations go. They need to be indented with spaces (not tabs!) for Jekyll to parse multiple lines correctly. Sadly, Markdown doesn't appear to support the name="" attribute, or it'd be written in that. One day.

During handoff:

  • Delete base.css and wireframe.css.
  • Remove all instances of sup.annotation and div.annotations.
  • Enjoy your new reality of barebones minimalism.

In conclusion

This is ridiculously alpha, and comes with no support. You should probably know what you're doing when it comes to reading front end code. I have no idea what I am doing, so feel free to make a pull request and make this better.

Read more at Yulquen's official site. Share your uses of Yulquen and I'll put together a gallery sometime.

Future tweaks

  • Better looking forms
  • Right-aligned, responsive side labels
  • Site map page
  • Data model page

License

Yulquen is licensed under WTFPL version 2, except for Skeleton's CSS files, which are slightly modified and licensed under the MIT license, and you should probably respect that.