Onword was designed to be easy, so if you’re on this page then I probably did something not quite right. Not to worry – help is just a tweet away. The fastest way to get help or report problems is by tweeting @onwordapp or @_dte.
If you need more than 140 characters, feel free to email me.
To make the most out of Onword, you should be writing your documents using Markdown. If you don’t know what Markdown is, here’s a quick explanation:
Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).
Simply put, Markdown allows you to write plain text and have it converted into HTML, the language of web pages.
Here's a quick guide to Markdown. To create a heading, simply type a hash/pound sign followed by a space and the heading itself, like so:
# This is a first level heading
You can go as far as six levels deep in headings, simply by adding more hash/pound signs:
# Heading Level 1 ## Heading Level 2 ### Heading Level 3 #### Heading Level 4
Pretty self-explanatory. Paragraphs are separated by line breaks:
# This is the heading Here is an introductory paragraph. As you can see, our document is really coming together quite nicely! Here is another paragraph. Statements which require emphasis may be *italicised* or made **bold.** Thus concludes this English lecture.
We now have all the tools we need for a basic document. Let's explore a few more things, shall we? Lists are a piece of cake:
- This is an - Unordered list - Consisting of - Bulleted list items * Asterisks can also be used * To create unordered lists 1. Numbered lists are as easy as one 2. Two 3. Three 1. Nested lists can be created by 1. Indenting with four spaces 2. Smiling gleefully at your Markdown wisdom 3. And finally, telling all your friends how wonderful Onword is 2. Right on!
Hyperlinks are a pretty vital part of most documents on the web, so just how do we insert a hyperlink?
You can insert a hyperlink to any [website](http://onword.co) with great ease. Just surround the linked text in square braces, followed by the URL in regular braces.
And last but not least, you can add code blocks to your documents (note that those are backticks and not single quotes):
You can add ```inline code``` or code blocks by indenting with four spaces: get '/' do "Hello, world!" end
If Markdown doesn't suit you, you can write in plain text or in good old HTML.