Giter Club home page Giter Club logo

markdowntutorial.com's Introduction

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

markdowntutorial.com's People

Contributors

abdoalghanim avatar aimerneige avatar arnaud-d avatar artberger avatar avi-jain avatar danielrmz avatar dependabot[bot] avatar detinsley1s avatar dkp-consult avatar erebor avatar github-actions[bot] avatar gjtorikian avatar hexagonrecursion avatar katur avatar lfournial-adeo avatar lodu avatar mattcone avatar neomoon007 avatar nickmccurdy avatar nidbcn avatar plumf avatar shogo2022 avatar skerretoo avatar snurolss avatar toto6038 avatar victorhck avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

markdowntutorial.com's Issues

Cursor spacing way off

I just tried it using Safari on latest Mavericks (10.9), and the cursor is no where near where the logical cursor is. It makes doing the exercises nearly impossible!

Section 5.1

Your instructions say:

"Make the entire quotation a block quote by inserting a caret on each line" and "Notice that even blank lines must contain the caret character," however, your answer only has them at the beginning of each paragraph and not on the lines in-between. It incorrectly "passes" you if you format it like this:

> Once upon a time and a very good time it was there was a moocow coming down along the road and this moocow that was coming down along the road met a nicens little boy named baby tuckoo...

> His father told him that story: his father looked at him through a glass: he had a hairy face.

> He was baby tuckoo. The moocow came down the road where Betty Byrne lived: she sold lemon platt.

which doesn't have either the > on each line or on the blank lines between the paragraphs.

Second exercise in Lesson 6

The criteria for continuing on to the next exercise in the lesson is incorrect in the js/lesson_plans.coffee file (line 69). The provided text omits the periods, but the lesson plan expects a period after each item.

Response processing

When you go to the next step without even having passed the previous step, it's congratulations anyway. It would be nice to put in place an algorithm that allows you to check whether or not you have passed the test. It will also give a playful aspect.

Consider porting to Jekyll

Jekyll, a static website generator written in Ruby, now has assets support in development. It seems to me like this Sinatra app is simple enough that the site could be switched to Jekyll (which supports GitHub Pages and should make working on the site backend easier).

What do you think? I can try porting this using development versions of Jekyll, but GitHub Pages might not get this version of Jekyll with asset support for a few months (this can be solved by committing Jekyll's output to the repo, though).

Problem with 2nd part in lesson 2?

Scratch pad started with this

In the box below, make the first line a heading level four, and italicize the name of the book:

Colombian Symbolism in One Hundred Years of Solitude

Here's some words about the book _One Hundred Years..._.

Name of the book appears to be already italicized, so adding the heading level, but can't seem to proceed

####Colombian Symbolism in One Hundred Years of Solitude

Here's some words about the book _One Hundred Years..._.

Lists: plant names italics example

This could be a confusing example. The correct way to italicize Latin names is to italicize genus and species names only. Higher level taxa, eg. families, are not italicized. So the correct answer for this example should be:

  • Azalea (Ericaceae Rhododendron)
  • Chrysanthemum (Anthemideae Chrysanthemum)
  • Dahlia (Coreopsideae Dahlia)

Ordered List not recognizing correct Markdown syntax

I just took the tutorial but I stuck when I got to the Lists chapter.

This is how I changed the text in the text field:

1. Cut the cheese
2. Slice the tomatoes
3. Rub the tomatoes in flour

But the site didn't make any response, I had expected to either get the next task within the chapter or a "Chapter completed" feedback as in all other chapters.

Image too large in lesson 4

In lesson 4 of markdowntutorial.com the images in the examples are too large and overflow out of the output zone. My guess at a solution would be to reduce the resolution of the three images.

Browser: Chrome 74
OS: Windows 10 desktop

Autocomplete Removing Characters

On some occasions a sort of Autocomplete removes or changes characters.
The following instances have been observed:

Test Step Expected Result Observed Behavior
Add Capital letter after a special character, such as # or [ The letter is inserted and the character remains The letter is inserted and the special character is replaced by a blank space
Add a line break A line break is inserted and nothing else happens A line break is inserted and the preceding character is removed
Add a line break in a list A line break is inserted and nothing else happens A line break is inserted and formatting is autocompleted to continue the list (i.e. indentation and * or numbering)

These were observed on an Android in Google Chrome using Gboard. Gboard autocomplete and autocorrect are turned off.
The behavior could not be reproduces in different contexts, such as Google Keep, or this issue editor.

Info
Google Chrome 110.0.5481.64 (Official Build) (32-bit)
Revision 82293b013185775ae599e70e2a65e2070c2c4950-refs/branch-heads/5481_61@{#2}
OS Android 13; Pixel 4a Build/TQ1A.221205.011

Lists Error

There seems to be an error on the lists exercise.
Attached is the screenshot. Not sure if I'm doing something wrong.
markdown experts

Colombian vs. Columbian

Hi!

Firstly, thanks for putting this out there, and empowering everyone.

Noticed that you had One Hundred Years of Solitude, which is great! However, it's Colombian, not Columbian (o vs. u). Common mistake, but as a Colombian, I take note :).

Thanks again.

Links are picky

You can’t have trailing slashes, or omit www.. For some reason, you can omit http://, though.

Translate french

I try to translate markdowtutorial.com in french, but i'm not a developper. Could you take informations about the technical structure for translate tutorial ?
For moment i jus translate page : 1.html. Maybe they are other folders or pages to be translated. Just in 1.html, it's not possible to translate all practical module for exemple.
Thank You for all informations that would allow me to translate and propose a complete translation for markdowntutorial.

skip button or hint buttons

I'm a coding noob training myself on markdown so I can one day be a master October CMS editor.

I love this tutorial!

But, I'm stuck on the last exercise on lesson 6. I'll likely figure it soon but I was wondering if you would consider including skip on hint buttons for folks like me.

Thanks for the amazing work on this!

Dutch version

This tutorial is missing a Dutch 🇳🇱 version :-(
I'll start on that right now :-)

Explain that lists and bullets require empty line before

When using markdown in the real world, one common and frustrating issue when using bullets and lists is that a blank line is not left before the list - this causes them to fail to render correctly.

For lesson 6, it would be valuable to explain this as well as have an exercise to test this much needed markdown knowledge.

Example which doesn't render

Markdown:

Here are your bullets, sir:
- Lead
- Jacketed lead
- Hard Cast
- Blank

Rendered markdown:

image

Example which renders

Markdown:

Here are your bullets, sir:

- Lead
- Jacketed lead
- Hard Cast
- Blank

Rendered Markdown:

image

Lesson 6 List Issue

For the part where you add paragraphs as context below the ordered lists, I cannot seem to get past stage. I'm not sure if I'm doing something wrong or if this is a bug.
Here is a screenshot of what I have entered. It displays correctly on the preview side, but does not take me to the next stage.
screen shot 2014-06-10 at 5 05 14 pm

Link points to http://null in Lesson 3 'Links'

I have just experimented with linking to different sites using the text box on this page and noticed that sometimes the link evaluates to http://null. I guess it happens if you omit 'www' from the URL (e.g. http://google.com, which is actually valid and understood by the browser).

Please include a "HOME" button

Please include a "HOME" button

maybe put it somewhere near the github logo on the top left?

the reason to have a home button, it is nice to go to the main index page without needing to focus the cursor into the URL bar and deleting the necessary amount of characters.

Can I make a Korean version?

I think it's a really good site to learn about Mark Down.
Many Koreans will like it if Korean version is created.
May I proceed with the translation of the Korean version?

Section 6.0 and 6.1

Because of the way that they are initially formatted as a horizontal list in the example, if you just add the "_" and remove the "," and put them on separate lines, the program fails to move you on to the next section. You _must* remove the extra spaces after each entry for it to pass you on to the next section.

Site Down

Listed site appears to have been down for a few days. Returns 'Server DNS Address could not be found'.

Moving to the next task too quickly

Hello,

Disclaimer first: I am new to git - so do not know if creating an issue is the 'right' way to provide feedback.

I loved the tutorial and found it very helpful - thanks a bunch!

I had one feedback: when you move from one sub-task to another within the same page, as soon as you put in the correct 'answer' it jumps to the next task without providing any time to observe the output. If some delay is introduced or maybe a next-button at the sub-step level, that might be helpful.

Thanks,
Mario

Error in result validation

There's a bug I found in the third exercise of the lesson 3.
The one about linking to the bbc news site.
Seems like a simple validation error.

Add title to each step

I think that the addition of a step title would help users understand at which stage they are in the tutorial

Here's a quickly example for the step "Italics and Bolds":

image

Response processing

When you go to the next step without even having succeeded in the previous step, it's congratulations anyway. It would be nice to put in place an algorithm that makes it possible to check whether we have passed the test or not. It will also give a playful aspect.

Translations?

This is a great ressource for new markdown writers. However I would love to translate it. Is there a way of making it translatable? If not I will simply fork it and create a new branch for my language.

Lesson 5: clarify first test by adding quotions around book quote

Firstly, thank you for this great resource! We are using markdowntutorial.com as a tool to teach our editors how to use markdown.

We have seen a few editors have issues with the first part of Lesson 5: blockquote. For them, it is not clear that the second sentence is the book quotation. I think it would be easier to identify if one (or both) of the following changes were made:

  1. Add quotations around the book quotation.
  2. Add an extra line between "I read this interesting quote the other day:" and the book quotation.

For example:

I read this interesting quote the other day:

"Her image had passed into his soul for ever and no word had broken the holy silence of his ecstasy. Her eyes had called him and his soul had leaped at the call. To live, to err, to fall, to triumph, to recreate life out of life! A wild angel had appeared to him, the angel of mortal youth and beauty, an envoy from the fair courts of life, to throw open before him in an instant of ecstasy the gates of all the ways of error and glory. On and on and on and on!"

Sometimes typing a space creates a tab, sometimes four spaces

I'm seeing strange behavior when it comes to typing "space" characters. I think it has to do with the number of characters on the current line prior to the cursor. I wonder if this has something to do with intended auto-tabbing behavior in the editor.

From my testing:

  • When the cursor is after the nth character on a line, where n is a multiple of 4 (0, 4, 8, ...), including on a blank line, typing "space" create a "tab" (a very wide gap, but acts as one character for moving forwards, backwards, and deleting)
  • When the cursor is after any other number of characters on a line (1, 2, 3, 5, 6, 7, ...), typing "space" adds four spaces. You can move left and right one (space) character at a time, and delete one character at a time.

I didn't see any existing issues for this on here, but it makes entering text highly frustrating and difficult. I'm surprised no one else has encountered this. I'm using Chrome 33.0.1750.117 on Ubuntu 12.04.

jekyll serve error

When I type jekyll serve, I got this error

WARN: Unresolved specs during Gem::Specification.reset:
      redcarpet (~> 3.1)
WARN: Clearing out unresolved specs.
Please report a bug if this causes problems.
C:/Ruby193/lib/ruby/gems/1.9.1/gems/jekyll-2.5.3/bin/jekyll:21:in `block in <top
 (required)>`: cannot load such file -- jekyll/version (LoadError)
        from C:/Ruby193/lib/ruby/gems/1.9.1/gems/mercenary-0.3.5/lib/mercenary.r
b:18:in `program'
        from C:/Ruby193/lib/ruby/gems/1.9.1/gems/jekyll-2.5.3/bin/jekyll:20:in `
<top (required)>'
        from C:/Ruby193/bin/jekyll:23:in `load'
        from C:/Ruby193/bin/jekyll:23:in `<main>'

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.