Markdown for GitHub Pages
In this tutorial, you’ll learn how to contribute to a GitHub Pages project with some basic Markdown formatting tools. These tools will help you create well-s...
Markdown for GitHub Pages
Project narrative
This project teaches developers how to write developer documentation with Markdown syntax. It also teaches them to write YAML front matter, which Jekyll requires to render pages. The intended audience can use this guide to:
- Create new developer documentation in Markdown
- Convert existing Microsoft Word documents to Markdown.
I chose this project to help developers write better documentation. I work with many developers who are either too busy or don’t know how to write in Markdown. While proper Markdown may not improve content, it does create cleaner documents. This guide for basic Markdown syntax will help busy developers add headings, tables, and images to their documentation.
Front matter
Front matter tells Jekyll how to render Markdown pages on your site. It defines the page’s title, layout, address, and other metadata. If a page doesn’t have...
Basics
Basic Markdown syntax adds structure, clarity, and emphasis to a document.
Images
Images add concise explanations of complex topics to your technical documentation . They break up the text and give the reader another medium through which t...
Tables
Tables display information in a clear and logical format. They let readers scan your document for the information they need.
Wrap up
A summary of what you learned and how to build on it.