Skip to content
The comprehensive Markdown reference guide.
HTML CSS Ruby
Branch: master
Clone or download

Latest commit

Latest commit e46ede2 May 31, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_basic-syntax Add section for link best practices Mar 4, 2020
_extended-syntax Add emoji section Feb 22, 2020
_getting-started Change word Feb 9, 2020
_includes Make some small tweaks Feb 8, 2020
_layouts Revise book page Feb 8, 2020
_tools Updated Notable domain address May 30, 2020
api/v1 Switch tick mark to backtick Nov 8, 2019
assets Add page for Byword May 3, 2020
.gitignore Update .gitignore Aug 20, 2019
.ruby-version bump ruby to 2.7.0 Jan 2, 2020
.travis.yml Bump ruby to 2.6.2 Mar 22, 2019
404.html Remove 404 page from sitemap Mar 25, 2017
Gemfile Use emoji instead of gem Aug 31, 2019
Gemfile.lock Update dependencies May 9, 2020
LICENSE.txt bump copyright year Apr 17, 2020
README.md Update README Apr 23, 2020
Rakefile Update ghost link for html-proofer Mar 12, 2020
_config.yml Fix links Dec 25, 2019
about.md Standardize formatting of name Feb 22, 2020
basic-syntax.md Add section for link best practices Mar 4, 2020
book.md update book.md Feb 19, 2020
cheat-sheet.md Update title of cheat sheet Oct 25, 2019
contact.md Update contact form fields Aug 24, 2018
extended-syntax.md Add emoji section Feb 22, 2020
favicon.ico first commit Jan 31, 2017
getting-started.md Add link to Reddit tool page Feb 9, 2020
index.html Standardize formatting of name Feb 22, 2020
netlify.toml Revise book page Feb 8, 2020
tools.md Add page for Byword May 3, 2020

README.md

Markdown Guide

Build Status

The Markdown Guide is a comprehensive Markdown reference designed for both novices and experts. 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:

Adding tools

See this page for information about adding applications to the Markdown tools directory.

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.