Thank you for reading! I showed you everything there is to offer about using Markdown. Most of the time that will work well, but sometimes you can experience some differences that you are not used to when working with standard HTML. You can also use raw HTML in your Markdown file. The only rule is that you must include at least three chars of the symbol. You can use asterisks, hyphens or underlines (*, -, _) to create a horizontal line. You can give ID to a heading to jump straight to that part of the file from wherever you are. Want to describe something at the end of the file? Use footnote! Keeping track of the tasks that are done and those that need to be done. Of course, it will still work, but hey → we should always arrange small things in the right way. You can also create a “messy“ table by excluding outer “ |“ symbols and not making your code well structured. Use “ |“ symbol to separate columns and “ :“ symbol to align row content. It’s also possible to create definition lists (term - definition), something you may not use often, but there is a possibility. Try not to create lists deeper than two levels. You can also mix both lists and create sublists. All by using backticks.Īs you can do in HTML, Markdown allows the creation of both ordered and unordered lists. You can also define the programming language you were using in your snippet. You can create both inline and full-block code snippets. You can create both inline and block links. Similar to images, links can also be inserted directly or by creating a reference. You can also create a reference to the image and assign it that way. If you are using GitHub, the best way is to simply drag & drop the image from your computer directly to README file. Want to emphasize the importance of the text? Say no more. You can make your text bold, italic, strikethrough, highlighted, subscript, or superscript. The number of “ #“ symbols, followed by text, indicates the importance of the heading. Here you can find the GitHub link of the repo where I wrote detailed docs specifically for GitHub Markdown.īy writing the regular text, you are basically writing a paragraph. Perhaps in the future, they might include it. Please note that GitHub Markdown still needs to support some of the features below. □ I have also created PDF version of the Cheatsheet. There are a lot of elements you can write in Markdown, so let’s dive into it. The second reason is that you are most likely to attract new connections and improve your networking by having an attractive profile README. That is exactly why it’s necessary to handle some basics well. Documentation for GitHub is written using Markdown. You probably know that every repository on GitHub has its own README file that explains the very purpose of the repository. Markdown is a lightweight markup language that you can use to format plain text documents. OK, tell me again, what is Markdown and where will I use it anyway? By the end of the article, you will know everything there is to know in order to be able to use Markdown on a daily basis. But after a short time, I got used to it and realized it was really cool. Wait, so what is Markdown anyway? It looks like plain text and kinda feels like HTML, but it’s neither of those things?ĭon’t worry, I was a bit confused the first time I had to use Markdown. You must have found yourself in a situation where you needed to write something using Markdown.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |