Markdown Guide
Markdown is a lightweight markup language with plain-text-formatting syntax, created in 2004 by John Gruber and Aaron Swartz. Markdown is often used for formatting readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor from Markdown.
This article is a guide to get you started with writing markdown files.
Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).
Markdown to date plays a crucial role from documenting readme files to running up blog pages. Markdown files always have an extension of .md.
In this article we are going to look at markdown styling guide with examples.
Headings
Headings in markdown are very similar to HTML tags. In markdown we will replace the h1 with the hashtag # precede with the name.
Please remember to provide space with the hashtag and the heading name specified as follows. ## heading two.
Headings can be written as follows in markdown.
H2 is represented by (##)
H3 is represented by (###)
H4 is represented by (####)
H5 is represented by (#####) H6 is represented by (######)
Paragraphs, breaks, and horizontal lines
Paragraphs can be implemented by using plain text. To get breaks within paragraphs we need to leave a blank space.
To break to other line, we use the
tag.
Horizontal lines can as well be implemented in markdown by using the three dashes or underscores on a separate line — -.
Emphasis: bold and italic
To implement emphasis in markdown we will wrap the world inside double asterisk sign **.
Result
. bold .
To provide italic words we wrap the word to be in italics in single asterisk sign *.
Result
We can include referral links in markdown files as follows.
[text link here](link here)
Mailto links are quite similar to links, to include mailto links we enclose it in angle brackets.
Lists
Markdown supports lists. It enables both the ordered and unordered lists.
Ordered lists
Ordered lists in markdown are specified with numbered markers:
Unordered lists
Unordered lists can be specified with a plus (+) or a minus sign (-). Asterisk (*) sign will also work.
Example
Images
We can implement the use of images as shown in the example below.
Example below:
Result
Code blocks
Blocks of code in markdown are wrapped using three back ticks (```) signs for the opening and same for closing tags in the code block.
Example
``` mounted: function() { this.$http.get(‘ facebook-login/api/get_customers.php’) .then(response => { return response.data; }) .then(data => { store.commit(‘addCustomer’, { id: ‘2’, name: ‘User 2’}) }); } ```
Result
Block quotes
Block quotes can be implemented by preceding the text with the greater than sign (>). Any text written after the greater than sign will be converted into block quotes.
Result
Fun fact: “Three things in human life are important. The first is to be kind. The second is to be kind. The third is to be kind.”
Conclusion
This article will provide you with a guide to get you started with writing markdown files.
Just to recap that we have learned how to include the below into markdown:
- Headings
- Images
- Block quotes
- Code blocks
- List — ordered and unordered lists
- Links
- Paragraphs
- Emphasis (bold and italics)
I have started out a YouTube Channel check it here
Check me out on twitter
Until next time PEACE ✌️
Originally published at https://amjohnphilip.hashnode.dev.
