The nteract Content Style Guide
Switch branches/tags
Clone or download
Pull request Compare This branch is 22 commits ahead of mailchimp:master.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_images
.nojekyll
CONTRIBUTING.md
LICENSE.md
_sidebar.md
creating-structured-content.md Update creating-structured-content.md Dec 1, 2018
further-reading.md
grammar-and-mechanics.md
index.html
now.json
readme.md
templates.md
tldr.md
using-our-logo.md
voice-and-tone.md Update voice-and-tone.md Dec 1, 2018
web-elements.md
word-list.md
writing-about-people.md
writing-blog-posts.md
writing-email-newsletters.md Update writing-email-newsletters.md Dec 1, 2018
writing-for-accessibility.md
writing-for-social-media.md
writing-for-translation.md
writing-principles.md
writing-technical-content.md

readme.md

Welcome to the nteract Content Style Guide

This content guide is based on the open-source content style guide provided by Mailchimp. This guide will help nteract maintainers, contributors, and maintainers craft effective narratives when writing about nteract, or anything else for that matter.

Using this content guide

You can use this guide to help you write clearly and consistently across blog posts, emails, code comments, and more.

This guide goes beyond basic grammar and style points. It’s not traditional in format or content. We break a number of grammar rules for clarity, practicality, or preference.

We’ve divided the guide by topic based on the types of content we publish, so you can reference it as needed or browse in order. The entire guide is searchable, so you can go straight to the item you’re looking for.

Contributing to this guide

This guide is open source. If you'd like to make a change, you can read our contribution documentation.