Switch branches/tags
Clone or download
stevenosloan Merge pull request #25 from mailchimp/CMS-1483-update_name_case
Update case of “MailChimp” to “Mailchimp”
Latest commit b7cf672 Oct 2, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
00-index.html.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
01-writing-principles.html.md Update 01-writing-principles.html.md Sep 27, 2018
02-voice-and-tone.html.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
03-writing-about-people.html.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
04-grammar-and-mechanics.html.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
06-web-elements.html.md fix(web-elements): typo on heading order Feb 2, 2017
07-writing-blog-posts.html.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
08-writing-technical-content.html.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
09-writing-legal-content.html.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
10-writing-email-newsletters.html.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
11-writing-for-social-media.html.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
12-writing-for-accessibility.html.md Fixes typo on accessibility page Feb 26, 2016
13-writing-for-translation.html.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
14-creating-structured-content.html.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
15-copyright-and-trademarks.html.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
16-word-list.html.md remove eCommerce360 from wordlist Jul 19, 2016
17-further-reading.html.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
18-tldr.html.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
CONTRIBUTING.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018
LICENSE.md Create LICENSE.md Aug 12, 2015
readme.md [CMS-1483] update case of “MailChimp” to “Mailchimp” Oct 2, 2018

readme.md

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.

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 written a blog post and set up an example Middleman project.

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. 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 <br> tag.

Widows

The best way to prevent widows is to type &nbsp; 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:

| 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: `<h3>`.