Markdown By Example
Markdown By Example
Minimum price
Suggested price
Markdown By Example

Last updated on 2012-11-24

About the Book

Markdown By Example - The book for Markdown-everything.

From text files over presentations to blogs, it can all be done using mostly Markdown. And it is easy, too!

This book introduces the reader to the Markdown syntax, teaches a few tricks on output styling and explains the various tools and frameworks that support Markdown.

All this is done using an imaginary monitoring tool called "GoodTool", which - by the end of the book - has a README file, a website, a blog, a wiki and much more. It is the common theme helping the reader understand the different use cases.

Finally, the book ends in a chapter explaining the "Making Of Markdown By Example" - yes, this book is not only about Markdown, it was also written in Markdown!

The first edition of this book has been completed! Buy it now and receive all future editions free-of-charge!

Second edition plans:

  • Add instructions for Windows for all tools compatible
  • Add more images
  • Create interactive iPad companion book (created with iBooks Author, will be free)

If you have any feedback concerning the second edition plans, please do not hesitate to contact the author!

  • Share this book

About the Author

Tim Steinbach
Tim Steinbach

Tim Steinbach is a software developer from Germany, who has moved to Ontario, Canada.

Having been part of small and large software projects, it became evident that communication and documentation are key for working in a team and future product maintenance. This is why it is crucial to introduce and promote the easiest (for reader and writer) ways of documenting!

Tim's blog rm -rf / is a place for unusual hints and tricks. Also, check out his website NeQuissimus Online.

Table of Contents

  • Preparations
  • 1 - What is Markdown?
  • 2 - Why Markdown?
  • 3 - Tools
  • 4 - Installation (OSX)
  • 5 - Installation (Linux)
  • 6 - Book resources
  • Learning Markdown
  • 7 - Simple text
  • 8 - Cheat sheet
  • Markdown applications
  • 9 - Markdown with HTML and CSS
  • 10 - Websites
  • 11 - Blogs
  • 12 - Presentations with ShowOff
  • 13 - Presentations with other frameworks
  • 14 - Documentation
  • 15 - Wordpress
  • 16 - Alternative output
  • 17 - Wikis
  • 18 - Markdown extensions
  • 19 - Converters
  • 20 - Books
  • Appendix
  • Software versions used
  • Links

The Leanpub 45-day 100% Happiness Guarantee

Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.

See full terms

Free Updates. Free App. DRM Free.

If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).

Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets), MOBI (for Kindle) and in the free Leanpub App (for Mac, Windows, iOS and Android). The formats that a book includes are shown at the top right corner of this page.

Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.

Learn more about Leanpub's ebook formats and where to read them

Write and Publish on Leanpub

Authors, publishers and universities use Leanpub to publish amazing in-progress and completed books and courses, just like this one. You can use Leanpub to write, publish and sell your book or course as well! Leanpub is a powerful platform for serious authors, combining a simple, elegant writing and publishing workflow with a store focused on selling in-progress ebooks. Leanpub is a magical typewriter for authors: just write in plain text, and to publish your ebook, just click a button. It really is that easy.

Learn more about writing on Leanpub