https://github.com/mailchimp/content-style-guide
This is our company style guide. It helps us write clear and consistent content across teams and channels
https://github.com/mailchimp/content-style-guide
Last synced: about 1 month ago
JSON representation
This is our company style guide. It helps us write clear and consistent content across teams and channels
- Host: GitHub
- URL: https://github.com/mailchimp/content-style-guide
- Owner: mailchimp
- License: other
- Created: 2015-07-15T17:15:15.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-05-04T22:34:54.000Z (almost 3 years ago)
- Last Synced: 2025-01-18T10:45:59.782Z (3 months ago)
- Homepage: https://styleguide.mailchimp.com
- Size: 267 KB
- Stars: 522
- Watchers: 55
- Forks: 234
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - mailchimp/content-style-guide - This is our company style guide. It helps us write clear and consistent content across teams and channels (Others)
README
# Welcome to the Mailchimp Content Style Guide
This style guide is primarily for Mailchimp employees, but we hope it’s helpful to other organizations as well.
If you're looking for the Mailchimp Content Style Guide website, visit [styleguide.mailchimp.com](http://styleguide.mailchimp.com).
Whether or not you work at Mailchimp, we welcome your thoughts and suggestions. To learn more about sending us feedback or adapting this guide to create your own, see the Contributing file.
## Using the Guide
We've set up an [example Middleman project](https://github.com/mailchimp/middleman-with-md-submodule-example).
## Creating a New File
This guide is a collection of Markdown files. This is a plaintext format that easily converts to HTML. Read more about it [here](http://daringfireball.net/projects/markdown/). Be sure you name your files without spaces with either an `.md` or `.markdown` extension.
The files in this guide are prefixed with a double digit to set order. Make sure your file starts with a number that will place your new content in the desired position (eg: `04-`) and change the prefixes of the other files to reflect this change in order.
## Markdown
Markdown is handy because you can write your content without HTML tags. Here are some tips to help you control the layout of your text.
### Line Breaks
If you want a line to break to the next line but don’t want to start a new paragraph, end the line with two spaces. This will render a `
` tag.
### Widows
The best way to prevent widows is to type ` ` in the space between the last two words in a title or paragraph.
### Tables
Tables can be written in Markdown by following this general style:
```markdown
| header 1 | header 2 |
| -------- | -------- |
| cell 1 | cell 2 |
| cell 3 | cell 4 |
```
The spacing is not important for the table to be rendered properly, and the cells do not have to line up. However it does help with readability when creating and editing tables.
### HTML Tags in Text
When displaying HTML tags as text in content, be sure to wrap them in backticks, eg: \``
`\`.