Skip to content
The comprehensive Markdown reference guide.
JavaScript HTML CSS Ruby
Branch: master
Clone or download
Latest commit a3ac61f Aug 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_basic-syntax Standardize on see also Aug 13, 2019
_extended-syntax Beef up escaping section Aug 3, 2019
_getting-started Fix OneNote link Aug 13, 2019
_includes Update dependencies and copyright date Mar 20, 2019
_layouts Bump bootstrap-toc to 1.0.1 Aug 1, 2019
api/v1 Add info about definition lists Oct 18, 2018
assets Update book Aug 15, 2019
.gitignore Remove metadata Jul 25, 2017
.ruby-version Bump ruby to 2.6.2 Mar 22, 2019
.travis.yml Bump ruby to 2.6.2 Mar 22, 2019
404.html Remove 404 page from sitemap Mar 25, 2017
Gemfile bump jekyll to 3.8.0 Apr 24, 2018
Gemfile.lock Update dependencies Aug 13, 2019
LICENSE.txt bump copyright year Feb 5, 2018
README.md add `bundle exec` to serve Dec 19, 2018
Rakefile
_config.yml Publish API v1 Oct 24, 2017
_headers Remove the Content-Security-Policy header Feb 24, 2017
about.md Add contact form and privacy policy Aug 24, 2018
basic-syntax.md Revise link title docs Aug 1, 2018
book.md Add image alt text Aug 21, 2018
cheat-sheet.md Add info about definition lists Oct 18, 2018
contact.md Update contact form fields Aug 24, 2018
extended-syntax.md Add info about definition lists Oct 18, 2018
favicon.ico
getting-started.md
index.html Fix validation errors Aug 21, 2018

README.md

Markdown Guide

Build Status

The Markdown Guide is a comprehensive Markdown reference designed for novice and intermediate users. It was born out of frustration with existing Markdown references that are incomplete, inadequate, or both.

Contributing

Contributions are welcome. Feel free to open a pull request with changes.

Running it Locally

It can be helpful to preview changes on your computer before opening a pull request. The Markdown Guide uses the Jekyll static site generator. After forking or cloning the repository, perform the following steps to generate the site and preview it:

Deployment

Pull requests merged to the master branch are automatically deployed to the production website.

License

The content of this project itself is licensed under the Creative Commons Attribution-ShareAlike 4.0 International license, and the underlying source code used to format and display that content is licensed under the MIT license.

You can’t perform that action at this time.