STYLE

Style Guide

Use remark-lint. There's a nice plugin for Atom. Have a look at the default style rules and our own .remarkrc for non-default configuration options. These rules are selected for readability of source code compatibility with GitHub wiki features.

Links

Due to gollum references, reference links may appear "empty" to the linter. These warnings have been disabled, so take extra care to check for empty links before publishing your work.

HTML

Please refrain from using HTML inside markdown files, as a rule. Sometimes, using HTML is the only way to accomplish something, like including an image with a custom width attribute.

Glossary

Glossary entries should use second-level headings instead of definition lists. While definition lists remain unsupported in commonmark, you should prefer second-level headings since they are referable as anchors.

For example the following might be referable as [[fork | Glossary#fork]]:

## fork

Your own copy of a repository that you otherwise do not own. Often used in open-
source software development to make contributions through a [pull
request](#pull-request).

Gotchas

All articles must end in a markdown extension in order to be linked. For example, when trying to link to the LICENSE ([[LICENSE]]), a file named LICENSE.md will work, whereas one named LICENSE.txt will not.