Skip to main

Herman

Automated style guides

by OddBird since

Design systems streamline development, communication, and consistency – but often rely on dedicated teams and extended budgets. We wanted a tool that helps create and maintain living style guides & pattern libraries in an agile process, and on a budget. Herman helps you keep your development process simple – and your UX consistent – as you scale over time.

Chat about Herman »

Give Your Design System a Home

Copy permalink to "Give Your Design System a Home"

Documentation should be the default option – the path of least resistance for developers. Herman combines documentation of design tokens and system guidelines, with code patterns, components, and rendered visual examples – all driven by Sass and CSS. By automating as much of the documentation as possible, you can help ensure that everything stays up-to-date for long-term maintainability.

Help improve communication across stakeholders, with consistency in UX, performance, and accessibility – while reducing technical debt and minimizing long-term maintenance. Herman is designed to grow with you, and keep everything in one place.

Herman’s Current Features

  • Supports all SassDoc annotations and configuration settings
  • Integrated with Sass/CSS for better automation
  • Visualize design tokens like fonts, colors, sizes, ratios, and icons
  • Display Sass mixins and Nunjucks macros with expected input and rendered examples
  • Include additional prose, pages, and links to third-party docs
  • Encourage self-documenting patterns, without locking yourself in
  • Optionally integrate with OddBird’s Sass Accoutrement libraries
[画像:Color Palettes][画像:Icons][画像:Ratio Previews][画像:Size Previews][画像:Typefaces][画像:Example Code Blocks]
Document colors, icons, ratios, sizes, fonts, and components

Integrate with Accoutrement

Utilities

Various Sass utilities to help manage strings, maps, and lists. As more functions are added to the Sass core, we hope to be able to remove some or all of these over time.

Tokens

Custom syntax for managing design tokens and arbitrary patterns in a format that encourages maintenance and automation.

Ratios

Define and access ratios using the Accoutrement token syntax. Several common ratios are provided.

Animate

Manage timing, easing, transitions, and animations – with built-in shortcuts for common patterns.

Color

Manage your color palettes in one place, and access them from anywhere with optional accessibility guidance from the WCAG.

Layout

Layout utilities including named media-queries, breakpoint map management, and organized named z-index layers.

Scale

Manage a system of consistent sizes to use across your project for typography, spacing, layout, and more. Generate sizes based on modular-scale ratios, and access sizes in any unit you need.

Type

Manage your webfonts, import them all with a single command, and access font-stacks on-the-fly, with utilities for generated content and accessibility.

Open Source Sponsors

Current Sponsors

A huge thank you to the individuals and organizations sponsoring OddBird’s open source work!

Blue-Footed Boobies

Open Collective Avatar for benface

Common Loons

Open Collective Avatar for Alice Boxhall Open Collective Avatar for Schepp Open Collective Avatar for Thijs Open Collective Avatar for Anonymous Open Collective Avatar for Nicolas Chevobbe Open Collective Avatar for Roman Komarov Open Collective Avatar for Luke Warlow Open Collective Avatar for Paul van Buuren Open Collective Avatar for William Killerud Open Collective Avatar for Nikita Dubko Open Collective Avatar for Mat Marquis Open Collective Avatar for Johannes Open Collective Avatar for Eric Portis Open Collective Avatar for Outline GbR Open Collective Avatar for Sophie Open Collective Avatar for Ashur Cabrera Open Collective Avatar for Tiara Rodney Open Collective Avatar for Pelle Wessman Open Collective Avatar for Jens Grochtdreis Open Collective Avatar for Lynn Fisher Open Collective Avatar for Pascal Duez Open Collective Avatar for Tyson Gach Open Collective Avatar for The Outfit, Inc. Open Collective Avatar for Mayank Open Collective Avatar for thanks.dev Open Collective Avatar for Syntax

Sponsor OddBird’s OSS Work

We love contributing back to the languages & tools that developers rely on, from CSS & Sass to browser polyfills and Python. Help us keep that work sustainable and focused on developer needs!

Donate to our collective

Herman Posts

  1. Sample organized color swatches with hex and hsl values
    Talk post type

    Agile Design Systems

    with meaningful code and automation

    by Miriam Suzanne

    Past
    • – Washington, DC

      Agile Alliance

    • – Denver, CO

      Agile Denver

    see all Talks & Workshops
  2. Article post type

    VueConf US

    Agile design systems in Vue

    by Miriam Suzanne on

    I’ve been excited about Vue.js since Sarah Drasner first showed me the basics. Since then, we’ve started using it for client work at OddBird, and I’m constantly impressed by the power and simplicity – so it was a real honor being invited to speak at the first VueConf US in...

    see all Article posts
  3. Sample organized color swatches with hex and hsl values
    Article post type

    Herman Style Guides

    An agile approach to design systems on a budget

    by Miriam Suzanne on

    Design systems streamline development, communication, and consistency – but often rely on dedicated teams and extended budgets. We wanted a tool to create and maintain living style guides & pattern libraries in an agile process, and on a budget. Herman helps keep our development flow simple, and our UX consistent...

    see all Article posts
  4. the text color(kevin bacon) on a pink background
    Talk post type

    Code Patterns for Pattern Making

    by Miriam Suzanne

    Past
    • – Denver, CO

      Refresh Denver

    • – Denver, CO

      Front Range Front End

    see all Talks & Workshops
  5. Blueprint for NYC signage
    Article post type

    Code Patterns & Style Guides

    by Miriam Suzanne on

    Living Style Guide documentation on the web is a difficult problem, gaining a lot of attention in the last few years. Let’s take an in-depth look at one way to store patterns directly in Sass, and generate documentation automatically.

    see all Article posts
  6. Style written on sketchbook page
    Article post type

    Generating Code Documentation for Polyglot Projects

    by David Glick on

    Code documentation is ideally written as close to the actual code as possible, but compiled into a comprehensive set of documentation that includes code from all languages in use. Here’s how we intend to do that.

    see all Article posts

Level Up Your CSS

Get free cutting-edge demos in your inbox! Grid & layouts with Miriam Suzanne, anchor positioning with James Stuckey Weber, and more! Peruse archive

AltStyle によって変換されたページ (->オリジナル) /