From 6e512c4b0babfd1d5d6cb10e3d8cbdc32ef2e6c5 Mon Sep 17 00:00:00 2001 From: Kaan Cimir <kaan.cimir@uni.lu> Date: Wed, 29 Nov 2023 12:51:29 +0100 Subject: [PATCH] update markdown card --- external/contribute/markdown/markdown.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/external/contribute/markdown/markdown.md b/external/contribute/markdown/markdown.md index bebe01d6..c2c2960f 100644 --- a/external/contribute/markdown/markdown.md +++ b/external/contribute/markdown/markdown.md @@ -10,7 +10,7 @@ redirect_from: --- # Markdown -Markdown is a lightweight markup language with plain text formatting syntax which became very popular in past decade and which nowadays serves as a standard in various digital communication channels. +[Markdown](https://daringfireball.net/projects/markdown/) is a lightweight markup language with plain text formatting syntax which became very popular in past decade and which nowadays serves as a standard in various digital communication channels. ## Main features of Markdown @@ -22,15 +22,16 @@ Markdown is a lightweight markup language with plain text formatting syntax whic * It is portable - since it is actually plain text, it can be opened by literally all text editors. * It is machine readable - as simple text, markdown documents can be tracked and version using a versioning system (Git, SVN) * It has small file size. -* It is easy to convert to other formats - existing editors and command line tools (e.g. [pandoc](https://pandoc.org/) allows for easy conversion between Markdown and other widely used formats like HTML, PDF, docx, LaTeX, etc. +* It is easy to convert to other formats - existing editors and command line tools (e.g. [Pandoc](https://pandoc.org/) allows for easy conversion between Markdown and other widely used formats like HTML, PDF, docx, LaTeX, etc. ## Quick reference * The following symbol <img src="img/visual-code_img_9.png" height="20"> behind the file name means that your changes/writing is not saved. Press CTRL+S to save your procedure * To preview your writing click on: + <img src="img/visual-code_img_10.png"> -## Tips to write in markdown: +## Tips to write in Markdown: | Markdown | Rendered Output | |:-----------------------------------|---------------------------| @@ -61,7 +62,7 @@ Markdown is a lightweight markup language with plain text formatting syntax whic |:-----------------------------------|---------------------------| |: Include links referring to a web `[page](https://www.markdownguide.org/)`. Avoid links in format `<link>` as it is not always parsed correctly. | Include links referring to a web [page](https://www.markdownguide.org/). Avoid links in format <link> as it is not always parsed correctly (like in this case). |:-----------------------------------|---------------------------| -|: Include local pictures using markdown | +|: Include local pictures using Markdown | |: ^^<pre></pre> | ^^  |: Or use HTML tag allowing you to alter the image properties (e.g. size) | |: ^^<pre>< img src="img/r3_logo.png" width="40" ></pre> | ^^<img src="img/r3_logo.png" width="40"> @@ -83,10 +84,10 @@ Plain syntax is usually enough. But special requirements lead to development of Another big advantage of Markdown is that it can contain HTML tags, which makes formatting very flexible. -## When to use markdown? +## When to use Markdown? * **Documentation** - Markdown is a perfect solution for description of a data package, project folder, workflow or code repository. Using Markdown ensures that the description will be accessible to everyone even after decades while still nicely structured. Guide for writing a good README is not covered by this HowTo page but you can find plenty of resources online, e.g.: - * [guide](https://data.research.cornell.edu/content/readme) from Cornell University, UK + * [Guide](https://data.research.cornell.edu/content/readme) from Cornell University, UK * [GitHub page](https://github.com/mhucka/readmine) for READMEs in a software repository * **Blogging and tutorials** - structured document with chunks of code, pictures and results of the analyses can be easily converted to HTML format and posted on personal/team websites. * **Notes and meeting minutes** - you can use following template for simple and nicely structured meeting notes: -- GitLab