https://github.com/gjtorikian/markdowntutorial.com

Lessons to help guide new writers into Markdown!
https://github.com/gjtorikian/markdowntutorial.com

Last synced: about 1 month ago
JSON representation

Lessons to help guide new writers into Markdown!

• Host: GitHub
• URL: https://github.com/gjtorikian/markdowntutorial.com
• Owner: gjtorikian
• License: mit
• Created: 2013-05-30T06:13:43.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2024-04-30T19:39:17.000Z (7 months ago)
• Last Synced: 2024-05-02T05:50:02.170Z (6 months ago)
• Language: HTML
• Homepage: http://www.markdowntutorial.com
• Size: 80.7 MB
• Stars: 538
• Watchers: 16
• Forks: 125
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# 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

* [Jekyll](http://jekyllrb.com) for templating the site and compiling assets

* [Ace](https://github.com/ajaxorg/ace) for the code editors

* [Marked](https://github.com/chjj/marked) for the Markdown conversion

* [Bootstrap](http://twitter.github.io/bootstrap/) for the design

* [Font Awesome](https://github.com/FortAwesome/Font-Awesome) for the awesome fonts