{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "# Markdown Cells" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Text can be added to Jupyter Notebooks using Markdown cells. Markdown is a popular markup language that is a superset of HTML. Its specification can be found here:\n", "\n", "" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Markdown basics" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Press `Enter` or double click to edit a Markdown cell. Press `Shift-Enter` to render a Markdown cell." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "You can make text *italic* or **bold**." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "You can build nested itemized or enumerated lists:\n", "\n", "* One\n", " - Sublist\n", " - This\n", " - Sublist\n", " - That\n", " - The other thing\n", "* Two\n", " - Sublist\n", "* Three\n", " - Sublist\n", "\n", "Now another list:\n", "\n", "1. Here we go\n", " 1. Sublist\n", " 1. Sublist\n", "1. There we go\n", "1. Now this" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### Exercise" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Create a Markdown cell and try the following constructs:\n", "\n", "* Bold and italic text\n", "* Itemized and enumerated lists" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## More elements" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "You can add horizontal rules:\n", "\n", "---" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Here is a blockquote:\n", "\n", "> Beautiful is better than ugly.\n", "> Explicit is better than implicit.\n", "> Simple is better than complex.\n", "> Complex is better than complicated.\n", "> Flat is better than nested.\n", "> Sparse is better than dense.\n", "> Readability counts.\n", "> Special cases aren't special enough to break the rules.\n", "> Although practicality beats purity.\n", "> Errors should never pass silently.\n", "> Unless explicitly silenced.\n", "> In the face of ambiguity, refuse the temptation to guess.\n", "> There should be one-- and preferably only one --obvious way to do it.\n", "> Although that way may not be obvious at first unless you're Dutch.\n", "> Now is better than never.\n", "> Although never is often better than *right* now.\n", "> If the implementation is hard to explain, it's a bad idea.\n", "> If the implementation is easy to explain, it may be a good idea.\n", "> Namespaces are one honking great idea -- let's do more of those!" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "And shorthand for links:\n", "\n", "[Jupyter's website](http://jupyter.org)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Headings" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "If you want, you can add headings using Markdown's syntax:\n", "\n", "# Heading 1\n", "# Heading 2\n", "## Heading 2.1\n", "## Heading 2.2" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Embedded code" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "You can embed code meant for illustration instead of execution in Python:\n", "\n", " def f(x):\n", " \"\"\"a docstring\"\"\"\n", " return x**2\n", "\n", "or other languages:\n", "\n", " if (i=0; i\n", "\n", "Header 1\n", "Header 2\n", "\n", "\n", "row 1, cell 1\n", "row 1, cell 2\n", "\n", "\n", "row 2, cell 1\n", "row 2, cell 2\n", "\n", "" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Github Flavored Markdown" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "The Notebook webapp support Github flavored markdown meaning that you can use triple backticks for code blocks \n", "
\n",
    "```python\n",
    "print(\"Hello World\")\n",
    "```\n",
    "\n",
    "```javascript\n",
    "console.log(\"Hello World\")\n",
    "```\n",
    "
\n", "\n", "Gives \n", "```python\n", "print(\"Hello World\")\n", "```\n", "\n", "```javascript\n", "console.log(\"Hello World\")\n", "```\n", "\n", "And a table like this : \n", "\n", "
\n",
    "| This | is   |\n",
    "|------|------|\n",
    "|   a  | table| \n",
    "
\n", "\n", "A nice Html Table\n", "\n", "| This | is |\n", "|------|------|\n", "| a | table| " ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Local files" ] }, { "cell_type": "code", "execution_count": 2, "metadata": { "collapsed": false }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "animation.m4v\n", "python-logo.svg\n" ] } ], "source": [ "!ls *svg *m4v" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "If you have local files in your Notebook directory, you can refer to these files in Markdown cells via relative URLs that are prefixed with `files/`:\n", "\n", " files/[subdirectory/]\n", "\n", "Note that it is **not** `/files`.\n", "\n", "For example, in the `figs` subdirectory, we have the Python logo:\n", "\n", "![img](files/python-logo.svg)\n", "\n", "and a video with the HTML5 video tag:\n", "\n", "