![]() GitHub Flavored Markdown isn't limited to just the basics. Ghostwriter − This is a distraction-free Markdown editor that features a clean, straightforward interface.Īdvanced Features of GitHub Flavored Markdown It features a live preview function, and there are also numerous extensions available for added functionality. Visual Studio Code − VS Code has built-in support for Markdown. It supports Markdown out of the box and can render your Markdown file in a split screen. Typora − This is a versatile and stylish Markdown editor that supports the live preview of Markdown.Ītom − Atom is a text editor developed by GitHub. Other good alternatives to consider include − We've mentioned "ReText" and "Mark Text" as options for viewing your Markdown files. Thanks for the contribution, Automatic URL Linking − If you want to mention a URL without it being automatically converted into a link, you can use backticks − `` User Mentions − GFM allows you to mention a user directly, similar to many social platforms, using the symbol followed by the username. Referencing Issues and Pull Requests − Another feature of GFM is the ability to reference issues or pull requests directly using the '#' symbol followed by the issue or pull request number. Nested Lists − In GFM, you can nest one list under another by indenting the nested list with four spaces. GitHub maintains a full list of the emoji shortcodes they support here. ~~This text will be strikethrough~~Įmoji − GFM supports the use of shortcodes for emoji in the form :EMOJICODE. This can be achieved by wrapping the text with double tildes ~~. Strikethrough − GFM has added syntax to strike through text, which is not available in plain Markdown. It saves the time of wrapping URLs in () to create a link. While we have already discussed the basic features and a few additional elements introduced by GFM, let's delve into some more useful features that make documentation and writing on GitHub a breeze.Īutomatic linking for URLs − GFM treats URLs as links automatically, which is not the case in regular Markdown. Grip will render the Markdown file and you can view it by opening your web browser to localhost:6419. Then, to view a file, navigate to the directory containing the file and run − grip yourfile.md It can be installed using pip − pip install grip You can also use the grip utility to view your Markdown files in a web browser. To install ReText, for example, you can use the command: For local viewing, you can use applications like "ReText" or "Mark Text". To view your Markdown files on a Linux system, you'll need a Markdown viewer or use an online viewer. Syntax Highlighting − With GFM, you can specify the language for code blocks to enable syntax highlighting. ![]() Tables − GFM allows the creation of simple tables − | Column 1 | Column 2 | These are lists with checkboxes that can be ticked off. **Task Lists**: GFM introduces the concept of task lists. While the above examples are common to all Markdown, GFM adds a few useful extras:ġ. This is a code block # GitHub Flavored Markdown (GFM) Extras For inline code, use a single backtick, for blocks of code use three backticks − `This is inline code` Images − To insert an image, use an exclamation point (!), followed by alt text in square brackets and the URL or path of the image in parentheses: !(/images/logo.png)Ĭode − To insert code, use backticks (`). Links − To create a hyperlink, use square brackets for the link text and parentheses for the URL − () Lists − You can create ordered and unordered lists using numbers or the '*' character respectively − 1. The syntax is quite straightforward − *This text will be italic* For example − # Header 1Įmphasis − For emphasis, you can make text bold or italic. The number of '#' characters used corresponds to the level of the header, from 1 (highest) to 6 (lowest). Headers − You can create a header by using the '#' character followed by a space and the header text. In this article, we're going to delve into how to work with GitHub Flavored Markdown on a Linux system, with practical examples and their output. GitHub Flavored Markdown (GFM) is a variant of Markdown used by GitHub, incorporating additional features that help developers to document their work. In essence, it simplifies the process of structuring and formatting text. Markdown is a popular lightweight markup language that allows users to write using an easy−to−read and easy−to−write plain text format, which can then be converted into HTML or other formats.
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |