Skip to content

How to write an article

Ole Begemann edited this page Feb 3, 2015 · 5 revisions

This is just a random (and randomly ordered) collection of guidelines on how to write an article:

  • Start with an outline, and expand on that.
  • Write in Markdown.
  • Upload your images somewhere (e.g. with CloudApp), we'll make sure to pull them into our website assets folder once we publish the articles.
  • If you want to link to another article in the same issue, use /issue-XX/FILENAME.html as the link target. If you are unsure, write something like TODO: add link to other article as your link target.
  • Follow the same Markdown metadata structure as the other articles, e.g. like this article.
  • Work with pull requests (see Robb's example for a great example) (Note: this is the private articles repo, if you're not contributing you can't see this, sorry).
  • Read the Style Guide.
  • If applicable, create a sample project, and put it in its own repo. We'll then fork it with the objc.io github account.

Markdown Tips

  • The highest heading level in your article should be <h2> (## in Markdown). You don't need to include the title of the article itself, it will be added by our template later.
  • If you use identifier names in your body text (such as class and method names), wrap them in backticks: `NSObject` becomes NSObject.

Markdown Extensions

In addition to the standard Markdown syntax, our Markdown parser supports fenced code blocks, footnotes and tables:

Footnotes

This is a sentence that should have a footnote.[^1] This is the next sentence.

[^1]: This is the footnote text.

This is the next paragraph.

Fenced Code Blocks

Three backticks specify a fenced code block. You can (and should) specify the language:

```swift
let a = 5
println("a is \(a)")
```

becomes:

let a = 5
println("a is \(a)")

Tables

| header 1 | header 2 |
| -------- | -------- |
| cell 1   | cell 2   |
| cell 3   | cell 4   |

becomes:

header 1 header 2
cell 1    cell 2   
cell 3    cell 4   
Clone this wiki locally