Skip to content

TheCrazyMax/markdowntutorial.com

 
 

Repository files navigation

Markdown Tutorial

I couldn't find any useful Markdown lessons for writers on the internets. So I made one.

Feedback and suggestions are greatly welcome!

Markdown Flavor

As you might know, everyone and their sister has their own Markdown flavor and preference. Since this is intended to be a tutorial for new users of Markdown, I decided to just focus on the original specifics, leaving out tables, definition lists, and other "addons." Curious writers that have mastered the basics can explore new syntaxes by themselves.

In addition, I've omitted a lot of duplicity in the original Markdown syntax. For example, these lessons don't mention that - and + are also valid list syntaxes, or that * counts as italics (just as __ counts as bold). While these omissions are intentional, they're also preferential; I don't really like + for lists or __ as bold.

Running Locally

After cloning the project, you need to run:

# grabs the dependencies
bundle install
# builds and serves the site
jekyll serve

Et voila!

Tech Stack

About

Lessons to help guide new writers into Markdown

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 41.8%
  • JavaScript 38.0%
  • CoffeeScript 17.2%
  • Ruby 1.4%
  • CSS 1.3%
  • Shell 0.3%