Documentation

Markdown Syntax Guide

Complete documentation for all markdown features supported in Fennie notes. Each example shows both the raw markdown syntax and how it renders.

Quick Copy Syntax

**bold**

*italic*

# Header

- List item

[Link](url)

`code`

$x^2$

> Quote

Introduction

This guide shows all the markdown features supported in Fennie notes. Each example shows both the raw markdown syntax and how it renders.

Basic Text Formatting

Bold and Italic

Use asterisks to emphasize text

Markdown Syntax

**Important concept:** Memory consolidation
*Key term:* Neurotransmitters
***Very important:*** This will be on the exam
~~Outdated theory~~ (no longer accepted)

Rendered Output

Important concept: Memory consolidation
Key term: Neurotransmitters
Very important: This will be on the exam
~~Outdated theory~~ (no longer accepted)

Try it yourself:

Headers

Use hashtags to create headers. More hashtags = smaller header.

Markdown Syntax

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

Rendered Output

Header 1

Header 2

Header 3

Header 4

Header 5

Header 6

Try it yourself:

Lists

Unordered Lists

Use dashes, asterisks, or plus signs for bullet points

Markdown Syntax

- First item
- Second item
- Third item
  - Nested item
  - Another nested item
- Fourth item

Rendered Output

First item
Second item
Third item
- Nested item
- Another nested item
Fourth item

Try it yourself:

Ordered Lists

Use numbers followed by periods

Markdown Syntax

1. First item
2. Second item
3. Third item
   1. Nested item
   2. Another nested item
4. Fourth item

Rendered Output

First item
Second item
Third item
1. Nested item
2. Another nested item
Fourth item

Try it yourself:

Task Lists

Use square brackets for checkboxes

Markdown Syntax

- [x] Completed task
- [ ] Uncompleted task
- [ ] Another task to do
  - [x] Completed subtask
  - [ ] Uncompleted subtask

Try it yourself:

Links and Images

Create clickable links and embed images

Markdown Syntax

[Link to Fennie](https://fennie.ai)
[Link with title](https://fennie.ai "Visit Fennie")
<https://fennie.ai>
![Image with title](https://placehold.co/100x100 "Image title")

Rendered Output

Link to Fennie
Link with title
https://fennie.ai
Image with title

Try it yourself:

Blockquotes

Use greater-than signs to create blockquotes

Markdown Syntax

> This is a blockquote
> It can span multiple lines
>
> And have multiple paragraphs

> You can also nest blockquotes
>> Like this
>>> And even deeper

Rendered Output

This is a blockquote
It can span multiple lines

And have multiple paragraphs

You can also nest blockquotes

Like this

And even deeper

Try it yourself:

Code

Inline Code

Use backticks to highlight code within sentences

Markdown Syntax

Use `inline code` within a sentence.

You can also use ``double backticks to include a `backtick` character``.

Rendered Output

Use inline code within a sentence.

You can also use double backticks to include a `backtick` character.

Try it yourself:

Code Blocks

Use triple backticks for multi-line code with syntax highlighting

Markdown Syntax

```javascript
function greet(name) {
  console.log(`Hello, ${name}!`);
}
greet('World');
```

```python
def greet(name):
    print(f"Hello, {name}!")
    
greet("World")
```

Rendered Output

javascript

python

Try it yourself:

Tables

Basic Table

Use pipes to separate columns and dashes to separate headers

Markdown Syntax

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |
| Cell 7   | Cell 8   | Cell 9   |

Rendered Output

Header 1	Header 2	Header 3
Cell 1	Cell 2	Cell 3
Cell 4	Cell 5	Cell 6
Cell 7	Cell 8	Cell 9

Try it yourself:

Aligned Tables

Use colons to align columns left, center, or right

Markdown Syntax

| Left Aligned | Center Aligned | Right Aligned |
|:-------------|:--------------:|--------------:|
| Left         | Center         | Right         |
| Text         | Text           | Text          |
| More         | More           | More          |

Rendered Output

Left Aligned	Center Aligned	Right Aligned
Left	Center	Right
Text	Text	Text
More	More	More

Try it yourself:

Math Equations

Inline Math

Use single dollar signs for inline math equations

Markdown Syntax

The quadratic formula is $x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$.

Einstein's famous equation: $E = mc^2$

Greek letters: $\alpha$, $\beta$, $\gamma$, $\pi$, $\sigma$

Rendered Output

The quadratic formula is $x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$ .

Einstein's famous equation: $E = mc^2$

Greek letters: $\alpha$ , $\beta$ , $\gamma$ , $\pi$ , $\sigma$

Try it yourself:

Block Math

Use double dollar signs for display math equations

Markdown Syntax

$$
\int_{a}^{b} f(x)dx = F(b) - F(a)
$$

$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$

$$
\begin{bmatrix}
a & b \\
c & d
\end{bmatrix}
$$

Rendered Output

\int_{a}^{b} f(x)dx = F(b) - F(a)

\sum_{i=1}^{n} i = \frac{n(n+1)}{2}

\begin{bmatrix} a & b \\ c & d \end{bmatrix}

Try it yourself:

Common Math Symbols

Frequently used mathematical notation

Markdown Syntax

- Fractions: $\frac{1}{2}$, $\frac{x+1}{x-1}$
- Powers and subscripts: $x^2$, $e^{-x}$, $a_n$
- Square root: $\sqrt{x}$, $\sqrt[3]{x}$
- Summation: $\sum_{i=1}^{n} i$
- Integration: $\int_{0}^{\infty} e^{-x} dx$
- Limits: $\lim_{x \to \infty} f(x)$

Rendered Output

Fractions: $\frac{1}{2}$ , $\frac{x+1}{x-1}$
Powers and subscripts: $x^2$ , $e^{-x}$ , $a_n$
Square root: $\sqrt{x}$ , $\sqrt[3]{x}$
Summation: $\sum_{i=1}^{n} i$
Integration: $\int_{0}^{\infty} e^{-x} dx$
Limits: $\lim_{x \to \infty} f(x)$

Try it yourself:

Horizontal Rules

Use three or more dashes, asterisks, or underscores

Markdown Syntax

Three or more hyphens:

---

Three or more asterisks:

***

Three or more underscores:

___

Rendered Output

Three or more hyphens:

Three or more asterisks:

Three or more underscores:

Try it yourself:

Diagrams with Mermaid

Flowchart

Create flowcharts and decision trees

Markdown Syntax

```mermaid
graph TD
    A[Start] --> B{Is it working?}
    B -->|Yes| C[Great!]
    B -->|No| D[Fix it]
    D --> B
    C --> E[End]
```

Rendered Output

Try it yourself:

Sequence Diagram

Show interactions between different entities

Markdown Syntax

```mermaid
sequenceDiagram
    participant User
    participant Fennie
    participant AI
    
    User->>Fennie: Upload document
    Fennie->>AI: Process content
    AI->>Fennie: Return analysis
    Fennie->>User: Display results
```

Rendered Output

Try it yourself:

Advanced Features

Footnotes

Add footnotes to your text

Markdown Syntax

Here's a sentence with a footnote[^1].

You can also use inline footnotes^[This is an inline footnote].

[^1]: This is the footnote text that appears at the bottom.

Rendered Output

Here's a sentence with a footnote¹.

You can also use inline footnotes^[This is an inline footnote].

Footnotes

This is the footnote text that appears at the bottom. ↩

Try it yourself:

HTML Elements

Use HTML tags for advanced formatting

Markdown Syntax

<details>
<summary>Click to expand</summary>

This content is hidden by default!
- You can put any markdown here
- Including lists
- And other elements

</details>

<kbd>Ctrl</kbd> + <kbd>C</kbd> to copy

<mark>Highlighted text</mark>

Rendered Output

Click to expand

This content is hidden by default!

You can put any markdown here
Including lists
And other elements

Ctrl + C to copy

Highlighted text

Try it yourself:

Tips for Effective Note-Taking

Best practices for organizing your notes

Markdown Syntax

1. **Use headers** to organize your content hierarchically
2. **Bold important terms** to make them stand out
3. **Use lists** for step-by-step procedures or key points
4. **Add code blocks** for technical content
5. **Include diagrams** to visualize complex concepts
6. **Use math notation** for formulas and equations
7. **Create tables** to compare information
8. **Add links** to reference external resources

---

*Ready to start taking better notes?* [Go back to your dashboard](/dashboard)

Rendered Output

Use headers to organize your content hierarchically
Bold important terms to make them stand out
Use lists for step-by-step procedures or key points
Add code blocks for technical content
Include diagrams to visualize complex concepts
Use math notation for formulas and equations
Create tables to compare information
Add links to reference external resources

Ready to start taking better notes? Go back to your dashboard

Try it yourself:

Frequently Asked Questions

What is Markdown?

Markdown is a lightweight markup language that allows you to format text using simple syntax. It's perfect for students who want to create well-formatted notes without the complexity of rich text editors.

Why should students use Markdown?

Markdown is ideal for students because it's fast to write, works everywhere, handles academic content like math equations well, and creates consistent formatting across all devices and platforms.

Can I use Markdown for academic papers?

Yes! Markdown supports citations, footnotes, mathematical equations, tables, and all the formatting you need for academic writing. Many academic platforms accept Markdown files.

How do I get started with Markdown?

Start with the basics: headers, bold/italic text, and lists. Practice with the interactive examples above, then gradually learn more advanced features like tables and math equations as you need them.