Learning Objectives
◇ Understand what Markdown is and its role in creating structured documents.
◇ Become familiar with Markdown editors and preview tools for real-time document rendering.
◇ Learn basic Markdown syntax for formatting text, headings, paragraphs, lists, and tables.
Markdown is a lightweight markup language that uses a simple text formatting syntax and is often used to convert text to HTML. It's particularly useful for writing reports that contain a mix of text, code and figures, making it a great tool for bioinformatics reports. The simplicity and flexibility of Markdown allows it to be used in different editors, including both online and offline options. For example, RStudio supports Markdown and can be used to render documents in a variety of formats.
To get started, explore the examples below and experiment with the basic syntax. Whether you're writing titles, plain text, code snippets or embedding images, Markdown's intuitive structure makes it easy to learn. If you're more advanced, you can consult a Markdown reference guide or cheat sheet for additional formatting options. You can also try exporting your .md
file to HTML or PDF to see how it renders.
Here are some simple Markdown examples to get you started:
Headings:
# Heading 1
## Heading 2
### Heading 3
Bold and Italic Text:
**Bold text**
*Italic text*
Lists:
- Item 1
- Item 2
- Item 3
1. First item
2. Second item
3. Third item
Code Block:
```
<code>
```
Link:
[Name](URL)
[Visit Markdown Guide](https://www.markdownguide.org)
Image:
