We would 💗 your contribution.
We think of pull requests as a conversation starter.
Please feel free to contact us:
#design-support channel@designers teambugcrowd/designWe push through changes as pull requests on GitHub and track the project internally.
Writing Sass? Check out Our Sass guidelines for helpful advice and our shared principles.
See § Tone & Language.
These docs are written in Markdown, a simple markup language with a plain text formatting syntax.
It’s easy to write and read, plus it converts readily into HTML (and other formats too).
We use kramdown which has some nifty features, not limited to:
---’ becomes (—)'oh la-la!'’ becomes (‘oh la-la!’)"oh la-la!"’ becomes (“oh la-la!”)...’ becomes (‘…’)<dl>, <dt>, & <dd>).Check out the kramdown syntax documentation for a full overview.
Use color to make code syntax more easy to read.
You can add syntax highlighting to fenced code blocks:
``` ruby
def what?
42
end
```yields:
def what?
42
end
We use rouge for this functionality.
There’s a custom Liquid filter available for Haml.
It lives in _plugins/haml_filter.rb.
_assets/stylesheets/design-system/
templates/ folder. It must have the same name/slug as your partial, eg:
_assets/stylesheets
├── main.scss
├── design-system
│ ├── components
│ │ ├── _my-feature.scss
│ │ └── templates
│ │ ├── my-feature--variant.haml
│ │ └── my-feature.haml
│ └── foundations
If the feature has a variant add a markup file for using the BEM -- variant notation.
_components
├── index.md
└── my-feature.md
---
title: Notification
summary: >
Use my feature to do X, Y, Z for contexts A and B, but never for C.
bem_variants:
- warning
- error
- success
---