6 Markdown
Markdown is a lightweight markup language with plain-text formatting syntax that is designed to be converted to HTML. It’s widely used due to its simplicity and versatility, making it ideal for documentation, reports, and noting down research.
In data science, Markdown finds extensive use not only for documenting projects but also for preparing dynamic reports that seamlessly integrate narrative text with the results of data analyses, often facilitated through tools like Jupyter Notebooks.
6.1 Setup
To get started, first, create a new Jupyter Notebook. If you’re not sure how to do this, you can refer to this guide on navigating Jupyter Notebook. Name your notebook hello-markdown.ipynb
and save it in the code
folder:
- Navigate to “File > Save As…” and enter the notebook name.
- Add a new cell by clicking the “+” button.
- Change the cell type to “Markdown” using the dropdown menu at the toolbar.
You can write your markdown in a cell designated for code and then convert it to a Markdown cell via the dropdown menu. Execute the cell using Shift+Enter
to render the Markdown text. Remember to save your progress frequently.
6.2 Basic Markdown Syntax
6.2.1 Headers
Headers structure the document and create a hierarchy of sections.
# Main Header (H1)
## Subheader (H2)
### Smaller Subheader (H3)
6.2.2 Lists
Lists organize information in a clear, concise manner.
Ordered Lists:
1. First item 2. Second item
Unordered Lists:
- Bullet A - Bullet B
6.2.3 Emphasis
Emphasize text to highlight key points.
*Italic*
**Bold**
_Italic with underscores_ __Bold with underscores__
6.2.4 Blockquotes
Use blockquotes to cite sources or important information.
> "This is a blockquote."
6.2.5 Tables
Tables are crucial for organizing data efficiently.
| Column 1 | Column 2 |
|----------|----------| | Row 1 | Value 1 |
6.2.6 Links and Images
Links and images enrich the document and provide additional context.
Links:
[Python Docs](https://docs.python.org/)
Images:
![Alt Text](image_url_or_path)
6.2.7 Mathematical Expressions
LaTeX integration allows for the representation of complex mathematical formulas.
Inline Equation:
$E = mc^2$
- Block Equation:
$$
\frac{a}{b} + \sqrt{x} $$
6.2.8 Horizontal Lines
Use horizontal lines to separate sections visually.
---
6.2.9 Code Blocks
Showcase code snippets with syntax highlighting.
```python
def greet(name):
return f"Hello, {name}!"
```
6.3 Further Learning
Explore these resources to further your understanding and mastery of Markdown: