ephemer / guide

Articles about Meteor best practices

Meteor Guide

• See the example app we're working to embody the principles from the guide at meteor/todos
• Check out the outlines and discussions
• Check out the live site

Contributing

If you're interested in helping out, the best thing to do is to look at the GitHub issues which represent the guide articles. If any topics interest you, read the outlines and major decision points linked from the issue, and post comments or PRs offering suggestions!

Writing tips

Things to be aware of:

Always use specific IDs on headers so that we can change them later:

// bad
## Using schemas with collections

// good
<h2 id="schemas-with-collections">Using schemas with collections</h2>

Always put a blank line after each header

Otherwise, the following paragraph isn't parsed correctly.

// bad
<h2 id="schemas-with-collections">Using schemas with collections</h2>
This is some text

// good
<h2 id="schemas-with-collections">Using schemas with collections</h2>

This is some text

Escape handlebars syntax inside inline code snippets

Note: you don't need to escape things in fenced/multiline code snippets, only in inline ones.

// will break
Render multiple items in your template with `{{#each}}`

// good
Render multiple items in your template with `{% raw %}{{#each}}{% endraw %}`