xbdev - software development
Sunday July 21, 2024
Home | Contact | Support | Markdown Language... Elegant and .. ..

Markdown Language...

Elegant and .. ..


Markdown Language

Markdown is a lightweight markup language that is widely used for formatting plain text documents. It provides a simple and intuitive way to add formatting elements to text without the complexity of traditional markup languages like HTML. Markdown uses a plain text syntax with easy-to-remember symbols to indicate formatting, making it accessible to both technical and non-technical users.

Learn markdown (benefits):
• 1. Easy to learn and use
• 2. Accessibility
• 3. Portable
• 4. Version control
• 5. Consistency
• 6. Free open standard
• 7. Supported everywhere
• 8. Easy to convert to other formats (e.g., html, latex, ..)

One of the key advantages of Markdown is its readability. The syntax is designed to be visually unobtrusive, allowing users to focus on the content rather than the formatting. This makes it an excellent choice for writing documentation, README files, and other types of content where clarity and simplicity are crucial.

Another reason for the popularity of Markdown is its versatility. It can be easily converted to other formats like HTML, PDF, and even slideshows, making it a flexible choice for content creation. Many platforms and tools, including popular ones like GitHub, Stack Overflow, and Jupyter Notebooks, support Markdown, fostering its adoption across various domains.

In comparison to other formats like HTML or LaTeX, Markdown's learning curve is relatively shallow, allowing users to quickly grasp the basics and start creating formatted content. Its lightweight nature makes it an efficient choice for quick note-taking or drafting, as it minimizes the distraction of complex syntax.

While Markdown may not be suitable for every use case, its simplicity, readability, and widespread support make it a compelling choice for a wide range of applications, particularly where quick and effective content creation is essential.

There are lots of different versions of markdown - but stick with the basic sytnax and you can't go wrong. As you master markdown, you'll learn there are 'extended' vesion with special extras, for emojis, animations, charts etc (see websites such as 'hackmd.io').


Headings let you define titles and sections - to create a heading in markdown, you start the line with one or more 'hash' (#) symbols followed by a space and the header title (e.g., ## My Sexy Header).

Best Practices

Experts on mardown can't always agree - while it might work on some markdown editors, you want to try and follow a good set of practices (general compatability).

A rule of thumb, try and always put a 'single' space between the 'hash' (#) and the heading name.

Some people might say, that 0, 1 or more spaces between the 'hash' (#) and the heading name still works - but you can be sure it will always work if you stick with the one space rule.




Best Practices

Don't indent paragraphs with spaces or tabs.

Line Breaks

To create a line break (<br>), end a line with two or more spaces, and then type return.



Best Practices

Some markdown versions have recommended using a 'backslash' (\) at the end of a line - however, just stick with the general newline (i.e., press reeturn and insert the '\n'.

Emphasis Words



Bold and Italic







Blockquotes and Multiple Paragraphs

You can map a blockquote over multiple paragraphs by inserting a 'greater-than' arrow symbol for each line ('>')



Nested Blockquotes



Blockquotes and Other Elements

You can contain other markdown formatting inside the blockquote (e.g., bold, italic, code blocks, links).

Best Practices

For compatability, put a blank line before and after blockquotes.

Useful Resources

Some useful resources that will help you when working with markdown (e.g., converting between different formats).

• Markdown to LaTeX [LINK]
• Markdown to HTML (RegEx) [LINK]

Advert (Support Website)

Copyright (c) 2002-2024 xbdev.net - All rights reserved.
Designated articles, tutorials and software are the property of their respective owners.