Markdown in Jupyter Notebook-tutorial

Kopteksten

Kopteksten beginnen met ‘#’, dus een hekje gevolgd door een spatie. Er zijn zes niveaus: de grootste kop gebruikt één hekje en de kleinste gebruikt zes hekjes.

# (Header 1, titel)

## (Header 2, hoofdsecties)

### (Header 3, subkoppen)

#### (Header 4)

##### (Header 5)

###### (Header 6)``

Als alternatief kunnen kopteksten ook met Markup-tags beginnen, dus van h1 tot en met h6, met de volgende syntaxes.

<h1>Header 1,title<h1>
<h2>Header 2,major headings<h2>
<h3>Header 3,subheadings<h3>
<h4>Header 4<h4>
<h5>Header 5<h5>
<h6>Header 6<h6>

Beide bovenstaande syntaxes renderen de kopteksten van h1 tot en met h6 nadat je op ‘Run’ in de toolbar hebt geklikt.

Citaties (Blockquotes)

Citaties kunnen een groot stuk tekst bevatten en zijn doorgaans ingesprongen. Je kunt ze maken met het Markdown-symbool ‘>’ of met <blockquote>text for blockquote</blockquote>

• >This is good
• <blockquote>This is good</blockquote>

Beide bovenstaande syntaxes renderen de tekst in ingesprongen vorm nadat je op ‘Run’ in de toolbar hebt geklikt.

Code-sectie

De code-sectie is het deel waarin je code van verschillende programmeertalen aangeeft. Inlinecode begint met ‘ `inline code goes here` ’, dus backticks eromheen, terwijl een blok code begint met drie backticks ‘ ``` block line code goes here ``` ’. De Markup-tag voor een code-sectie is bovendien ‘ <code>code goes here<code> ’.

Het voorbeeld van inlinecode staat hieronder:
`x =5`

Je ziet na het klikken op "Run" dat de inlinecode met markering wordt weergegeven.

Voorbeelden van code-secties staan hieronder:

• Met Markdown
```Python

str = "This is block level code"

print(str)

```
• Met Markup-tags
<code>Python

str = "This is a block level code"

print(str)

</code>

Met Markdown kun je syntax highlighting krijgen als de programmeertaal direct na de drie backticks ‘```’ wordt genoemd. Zie hieronder:

Met Markdown zonder taalspecificatie krijg je geen syntax highlighting, maar de code wordt wel gemarkeerd:

Wiskundig symbool

Het wiskundige symbool in Markdown staat tussen ‘\$ wiskundige expressie hier \$’, dus omsloten door een dollarteken. In Markup kun je deze link volgen voor meer details: Mathematical Operators. Hieronder zie je een voorbeeld van het gebruik van wiskundige symbolen.

\$\sqrt{k}$

Het bovenstaande voorbeeld zal de wiskundige expressie vet weergeven.

Regeleinde

De regeleindetag begint met de tag <br> zonder sluitingstag. Deze breekt de regel en de resterende inhoud begint op een nieuwe regel, zoals in het onderstaande voorbeeld.

The line breaks after using <br> br tags and it is awesome.

Na het klikken op ‘Run’ in de toolbar zie je het regeleinde na gebruik van de <br>-tag. De resterende tekst begint op een nieuwe regel.

Vette en cursieve tekst

Je kunt <b>-tags, ‘**’ (dubbele asterisk) of ‘__’ (dubbele underscore) gebruiken om vetgedrukte tekst te krijgen, met de volgende syntax.

• <b>This is bold text </b>

• ** This is bold text

• __ This is bold text

Alle bovenstaande syntaxes renderen vetgedrukte tekst nadat je op ‘Run’ in de toolbar hebt geklikt.

Je kunt <i>-tags, ‘*’ (enkele asterisk) of ‘_’ (enkele underscore) gebruiken om cursieve tekst te krijgen met de volgende syntax.

• <i>This is italic text </i>

• * This is italic text

• _ This is italic text

Alle bovenstaande syntaxes renderen cursieve tekst nadat je op ‘Run’ in de toolbar hebt geklikt.

Horizontale lijn

Je kunt een horizontale lijn maken met Markdown ‘---’ (drie koppeltekens) of met de Markup-tag <hr>

Beide bovenstaande syntaxes renderen een horizontale lijn van de ene naar de andere kant nadat je op "Run" hebt geklikt.

Genummerde lijst

De genummerde lijst maak je met de <ol>-tag en sluit je af met de </ol>-tag, met de gewenste items tussen <li>- en </li>-tags. De tag ‘ol’ is de afkorting van ordered list en ‘li’ is de afkorting van list item. Hieronder zie je een voorbeeld van een genummerde boodschappenlijst.

<ol>
<li>Fish</li>
<li>Eggs</li>
<li>Cheese</li>
</ol>

Als alternatief kun je ook beginnen met ‘1. ’, dus het gewenste nummer gevolgd door een spatie, zoals hieronder.

1. Fish
2. Eggs
3. Cheese

Beide bovenstaande syntaxes renderen de genummerde lijst nadat je op ‘Run’ in de toolbar hebt geklikt.

Ongeordende lijst

De ongeordende lijst is een opsommingstekens-lijst die je maakt met de <ul>-tag en afsluit met de </ul>-tag, zie het voorbeeld hieronder:

<ul>
<li>Fish</li>
<li>Eggs</li>
<li>Cheese</li>
</ul>

Als alternatief kan de ongeordende lijst beginnen met het ‘-’-symbool met een spatie, wat een zwarte cirkel oplevert, of met het ‘*’-symbool met een spatie, wat een zwart vierkant oplevert.

-   Fish
-   Eggs
-   Cheese

Het bovenstaande voorbeeld laat een lijst met opsommingstekens zien met het ‘-’-symbool gevolgd door een spatie bij de items, wat de zwarte cirkel geeft.

Beide bovenstaande syntaxes renderen hetzelfde resultaat waarbij de items in de lijst als zwarte cirkels verschijnen, nadat je op ‘Run’ in de toolbar hebt geklikt.

Interne en externe link

Interne link in Markdown begint met de <a>-tag met een unieke id die is gedefinieerd door het attribuut ‘id’ en kan in het notebook worden gelinkt zoals in het onderstaande voorbeeld:

<a id = "division_ID"text goes here></a>

De hierboven gedefinieerde id kan vervolgens worden gelinkt aan een sectie in het notebook met de volgende code, waarmee de link klikbaar wordt.

[Section title](#division_ID)

Het voorbeeld hiervan zie je hieronder, waar de gedefinieerde id is gelinkt aan de sectie en er na het klikken op "Run" in de toolbar een klikbare link ontstaat.

Externe link in Markdown begint met <a> en eindigt met <a>-tag; <a> staat voor anchor en definieert de link, en heeft het attribuut ‘href’ (hyper reference) dat het bestemmingsadres van de link of URL bevat. De tekst tussen de tags is zichtbaar en klikbaar om het bestemmingsadres te openen, zoals hieronder.

<a> href="https://www.google.com" >Link to Google</a>

Als alternatief kan het ook beginnen met __[text link](URL for the site)__ waarbij dubbele underscores aan beide kanten staan, de tekstlink tussen rechte haken en de URL tussen haakjes.

Link to Google

Beide bovenstaande syntaxes renderen hetzelfde resultaat, waarbij de klikbare en onderstreepte tekst naar een nieuwe pagina kan leiden nadat je op ‘Run’ in de toolbar hebt geklikt.

Tabel

De tabel bevat informatie in rijen en kolommen en wordt opgebouwd met ‘|’ (verticale pijp) om kolommen te scheiden en ‘-’ (koppelteken) om de header te maken, waarbij een lege lijn, d.w.z. een combinatie van verticale pijpen en streepjes, het tabelformaat rendert.

Je kunt de cellen ook globaal uitlijnen met de kolommen; het notebook zal de inhoud in de gegeven cel automatisch schalen.

|Name|Address|Salary| |-----|-------|------| |Hanna|Brisbane|4000| |Adam|Sydney|5000|

Als alternatief kun je Markdown gebruiken om tabellen te bouwen, waarbij < table > een tabel definieert met de breedte in procenten. <tr> zet een tabelrij, die vet en gecentreerde tekst voor de tabelkop geeft, beschreven door <th> bovenaan de tabel, en de andere items in de tabel worden gezet met <td> (table data).

<table style="width:20%">
<tr>
<th><Name></th>
<th><Address></th>
<th><Salary></th>
</tr>

<tr>
<td><Hanna></td>
<td><Brisbane></td>
<td><4000></td>
</tr>

<tr>
<td><Adam></td>
<td><Sydney></td>
<td><5000></td>
</tr>
</table>

Beide bovenstaande syntaxes renderen hetzelfde resultaat nadat je op ‘Run’ in de toolbar hebt geklikt.

Afbeeldingen

Je kunt een afbeelding invoegen via de toolbar door ‘Insert Image’ te kiezen in het menu Edit en de gewenste afbeelding te selecteren, zoals hieronder.

De afbeelding kan de Markdown-tag <img> bevatten met source, d.w.z. src als attribuut met de link naar de afbeelding, met optionele eigenschappen zoals width en height. Het voorbeeld staat hieronder.

<img> <src="https://i.imgur.com/WWrydEh.png" width ="500" height=500 >

Beide bovenstaande methoden renderen dezelfde afbeelding nadat je op ‘Run’ in de toolbar hebt geklikt.

Conclusie

In deze tutorial heb je geleerd over verschillende markuptags, die zijn gedefinieerd door een opmaakt taal, en ook over de syntax die hoort bij Markdown-cellen specifiek voor de Jupyter Notebook, die naast code wordt gebruikt om de inhoud effectiever te beschrijven.

Wil je meer leren over Markdown? Kijk dan eens naar de Markdown Guide.