Difference between revisions of "Markdown"

From Sustainability Methods
(Created page with " # Markdown")
 
Line 1: Line 1:
  
 
# Markdown
 
# Markdown
 +
 +
## What is Markdown?
 +
Markdown is an easy-to-use markup language that is used with plain text to add formatting elements (headings, bulleted lists, URLs) to plain text without the use of a formal text editor or the use of HTML tags.
 +
 +
## Why Markdown?
 +
- Can be used for everything (websites, documents, notes, books, presentations, email messaged, and technical documentation).
 +
- Portability: Files containing Markdown-formatted text can be opened using virtually any application.
 +
- Platform independent: You can create Markdown-formatted text on any device running any operating system.
 +
- Future proof: You’ll always be able to read Markdown-formatted text using a text editing application.
 +
- It is everywhere: Websites like Reddit and GitHub support Markdown, and lots of desktop and web-based applications support it.
 +
 +
## How does Markdown work?
 +
1. Create a Markdown file using a text editor or a dedicated Markdown application. The file should have an .md or .markdown extension.
 +
2. Open the Markdown file in a Markdown application.
 +
3. Use the Markdown application to convert the Markdown file to an HTML document.
 +
4. View the HTML file in a web brower or use the markdown application to convert it to another file format, like PDF.
 +
 +
 +
## Pros && Cons
 +
- simplicity, being fast and easy to learn made it very popular
 +
- all features of HTML can be used in Markdown and it is more readable rather than HTML
 +
- Markdown is not able to map different element types to each other, so it is less useful as a semantic tool
 +
- Creation of table of contents, reusing content, mixing parts together and managing larger documents are not possible
 +
## Basics - more on [docs.github](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
 +
##### *Create Heading*:
 +
`# The largest heading`
 +
`## The second largest heading`
 +
`##### The smallest heading`
 +
# Like This Heading

Revision as of 15:09, 29 October 2022

  1. Markdown
    1. What is Markdown?

Markdown is an easy-to-use markup language that is used with plain text to add formatting elements (headings, bulleted lists, URLs) to plain text without the use of a formal text editor or the use of HTML tags.

    1. Why Markdown?

- Can be used for everything (websites, documents, notes, books, presentations, email messaged, and technical documentation). - Portability: Files containing Markdown-formatted text can be opened using virtually any application. - Platform independent: You can create Markdown-formatted text on any device running any operating system. - Future proof: You’ll always be able to read Markdown-formatted text using a text editing application. - It is everywhere: Websites like Reddit and GitHub support Markdown, and lots of desktop and web-based applications support it.

    1. How does Markdown work?

1. Create a Markdown file using a text editor or a dedicated Markdown application. The file should have an .md or .markdown extension. 2. Open the Markdown file in a Markdown application. 3. Use the Markdown application to convert the Markdown file to an HTML document. 4. View the HTML file in a web brower or use the markdown application to convert it to another file format, like PDF.


    1. Pros && Cons

- simplicity, being fast and easy to learn made it very popular - all features of HTML can be used in Markdown and it is more readable rather than HTML - Markdown is not able to map different element types to each other, so it is less useful as a semantic tool - Creation of table of contents, reusing content, mixing parts together and managing larger documents are not possible

    1. Basics - more on [docs.github](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
          1. *Create Heading*:

`# The largest heading` `## The second largest heading` `##### The smallest heading`

  1. Like This Heading