Writing in Markdown

Markdown is a light-weight mark-up language that makes it easy to format text for conversion to html. All of our articles for Kite Answers will be written in Markdown. Markdown can be used to indicate headers, lists, links, section breaks -- and much more.

Resources

To learn more about Markdown, we recommend the following websites:

• To learn Markdown syntax: Markdown Cheatsheet
• To learn more about Markdown and how it works: Getting Started
• To learn how to use PyCharm to write issues: Pycharm and Git

Guidelines

As with text and with code samples, we have guidelines for using Markdown in a Kite Answer.

Links

A Markdown link looks like this:

[anchor text](URL)

The anchor text is the what the reader will see. Do not use words like here or click this for anchor text. Instead, make the anchor text meaningful in context.

To learn more about list comprehension, go here.

To learn more, read about the official Python documentation on list comprehensions.

Escaped characters

You can use HTML escape characters in Markdown.

Most notably,   gives you a non-breaking space character. This can be useful to add a space in an odd location like after another space or at the beginning of a line of text.