Skip to main content
Version: v2.10.0

Markdown Cell Support

Overview​

Yeedu notebooks now support Markdown cells, allowing you to add formatted text, documentation, and explanations alongside your code. Mix code and rich documentation in a single notebook.

Creating Markdown Cells​

Add Markdown Cell​

  1. Open a notebook
  2. Click + Cell button
  3. Select Markdown cell type
  4. Start typing markdown content

Change Cell Type​

To convert existing cell:

  1. Click cell dropdown (top-right of cell)
  2. Select Convert to Markdown
  3. Content may be lost if code
  4. Confirm conversion

Markdown Formatting​

Headings​

# Heading 1
## Heading 2
### Heading 3

Text Formatting​

**Bold text**
*Italic text*
***Bold italic***
~~Strikethrough~~
`Inline code`

Lists​

Unordered List:

- Item 1
- Item 2
  - Nested item

Ordered List:

1. First item
2. Second item
3. Third item

Code Blocks​

```python
def hello():
    print("Hello, World!")

Language-specific syntax highlighting:
- ```python
- ```sql
- ```scala
- ```bash
- ```json

### Links and Images

**Links**:
```markdown
[Link text](https://example.com)
[Relative link](../path/to/file.md)

Images:

![Alt text](image_url)
![Local image](/path/to/image.png)

Tables​

| Column 1 | Column 2 | Column 3 |
|----------|----------|----------|
| Value 1  | Value 2  | Value 3  |
| Value 4  | Value 5  | Value 6  |

Blockquotes​

> This is a blockquote
> with multiple lines
>> Nested blockquote

Horizontal Line​

---
***
___

Using Markdown for Documentation​

Document Your Analysis​

## Data Analysis Report

### Dataset Overview
This analysis examines customer behavior
in Q4 2024.

### Key Findings
- 15% growth in sales
- 20% increase in repeat customers

Add Instructions​

### Running This Notebook

1. Set the date range in the first cell
2. Execute all cells sequentially
3. Review visualizations in the output

Reference External Resources​

## See Also
- [Documentation](https://docs.example.com)
- [Related Notebook](./other-notebook)

Advanced Markdown Features​

HTML Embedding (if enabled)​

<div style="background-color: #f0f0f0; padding: 10px;">
  Custom HTML content
</div>

LaTeX Math (if enabled)​

Inline math: $x^2 + y^2 = r^2$

Block math:
$$
\sum_{i=1}^{n} x_i = \frac{n(n+1)}{2}
$$

Keyboard Input​

Press `Ctrl + Enter` to execute a cell

Mixing Code and Markdown​

Workflow Example​

  1. Markdown Cell: Explain analysis goal
  2. Code Cell: Load data
  3. Markdown Cell: Describe preprocessing steps
  4. Code Cell: Data transformation
  5. Markdown Cell: Interpretation
  6. Code Cell: Visualizations

Complete Example​

[Markdown] # Customer Segmentation Analysis
[Code]     # Load customer data
[Markdown] ## Data Overview
[Code]     # Display statistics
[Markdown] ## Segmentation Approach
[Code]     # Run clustering algorithm
[Markdown] ## Results and Insights
[Code]     # Visualize clusters

Markdown Cell Settings​

Cell Options​

Click cell dropdown for options:

  • Hide Output: Hide markdown rendering (show source)
  • Convert to Code: Change to code cell
  • Move Up/Down: Reorder cells
  • Delete: Remove cell

Cell Metadata​

Add metadata for organization:

  • Tags for searchability
  • Cell description
  • Author information

Best Practices​

Documentation Standards​

✓ Do:

  • Use clear headings for sections
  • Add context before code
  • Explain complex algorithms
  • Document important assumptions
  • Include examples

✗ Don't:

  • Over-comment with obvious remarks
  • Use markdown for code (use code cells)
  • Create huge markdown blocks (break into sections)
  • Ignore grammar and spelling

Keeping Readable​

  • Use consistent heading levels
  • Limit line length for readability
  • Add blank lines between sections
  • Use tables for structured data
  • Break long paragraphs into bullets

Collaboration​

  • Write for team understanding
  • Document decisions and rationale
  • Include references and sources
  • Add timestamps for time-sensitive info
  • Comment on experiment results

Exporting with Markdown​

Export Notebook​

When exporting notebook:

  • Markdown cells included in export
  • Formatting preserved in HTML/PDF
  • Code syntax highlighted
  • Tables and images included

Create Documentation​

Use notebooks as documentation:

  1. Mix markdown explanations with code
  2. Export to HTML or PDF
  3. Share as documentation
  4. Version control for docs

Troubleshooting​

Markdown Not Rendering​

  1. Verify cell type is "Markdown"
  2. Try clicking outside cell and back
  3. Refresh notebook
  4. Check markdown syntax

Special Characters Issue​

  • Use proper markdown escaping
  • \ escapes special characters
  • Example: \[ for literal bracket

Images Not Displaying​

  • Check image URL is accessible
  • Verify absolute path for local images
  • Check file permissions
  • Try absolute URL instead

See Also​

  • [Create Notebook](./Create notebook.md)
  • [Editor Pane](./Editor Pane.md)
  • [Notebook Types](./Notebook types.md)
  • [Results Pane](./Results Pane.md)