Skip to content

Instantly share code, notes, and snippets.

@juhasch
Created July 7, 2014 05:43
Show Gist options
  • Save juhasch/28e941a0ea6b1b6e47b8 to your computer and use it in GitHub Desktop.
Save juhasch/28e941a0ea6b1b6e47b8 to your computer and use it in GitHub Desktop.
Example Notebook for Code in Markdown Cell
{
"metadata": {
"name": "",
"signature": "sha256:3f216d8ac560f66c1a009e0f03595c7c2fc7d117803419f82d21cecb330525eb"
},
"nbformat": 3,
"nbformat_minor": 0,
"worksheets": [
{
"cells": [
{
"cell_type": "heading",
"level": 1,
"metadata": {},
"source": [
"Python Code in Markdown Cells"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Python variables can be referenced in markdown cells by embedding them in double curly braces: \\{\\{...\\}\\}"
]
},
{
"cell_type": "heading",
"level": 3,
"metadata": {},
"source": [
"A simple example"
]
},
{
"cell_type": "code",
"collapsed": false,
"input": [
"a = 2.1234 "
],
"language": "python",
"metadata": {},
"outputs": [],
"prompt_number": 83
},
{
"cell_type": "markdown",
"metadata": {
"variables": {
"a": "2.1234"
}
},
"source": [
"The variable a is {{a}}."
]
},
{
"cell_type": "heading",
"level": 3,
"metadata": {},
"source": [
"How does is work ?"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"The embedded code es executed and it's result is displayed instead of the double curly braces. Additionally, the result is stored in the cell metadata:\n",
"```\n",
"{\n",
" \"variables\": {\n",
" \"a\": \"2.1234\"\n",
" }\n",
"}\n",
"```\n",
"\n",
"If a computation result has already been stored, no computation is executed and the stored value is used instead, unless `IPython.notebook.dirty == true`."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Supported types that can be displayes are text strings, Latex, HTML and images:"
]
},
{
"cell_type": "code",
"collapsed": false,
"input": [
"from IPython.display import display, Math, Latex\n",
"b=Latex(r'$b = \\frac{\\epsilon}{2}$')"
],
"language": "python",
"metadata": {},
"outputs": [],
"prompt_number": 88
},
{
"cell_type": "markdown",
"metadata": {
"cellhascode": true,
"hascode": false,
"variables": {
"b": "$b = \\frac{\\epsilon}{2}$"
}
},
"source": [
"You can also embed Latex: {{b}} in here!"
]
},
{
"cell_type": "raw",
"metadata": {},
"source": [
"from IPython.display import Image, SVG\n",
"i = Image(filename='mouse-toy.jpg');"
]
},
{
"cell_type": "markdown",
"metadata": {
"cellhascode": true,
"hascode": false,
"variables": {
"i": "<img src=\"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/4QB0RXhpZgAATU0AKgAAAAgABAEaAAUAAAABAAAAPgEbAAUA\nAAABAAAARgEoAAMAAAABAAIAAIdpAAQAAAABAAAATgAAAAAAAABIAAAAAQAAAEgAAAABAAKgAgAE\nAAAAAQAAAGSgAwAEAAAAAQAAAEIAAAAA/9sAQwABAQEBAQEBAQEBAQEBAQECAgEBAQEDAgICAgMD\nBAQDAwMDBAQGBQQEBQQDAwUHBQUGBgYGBgQFBwcHBgcGBgYG/9sAQwEBAQEBAQEDAgIDBgQDBAYG\nBgYGBgYGBgYGBgYGBgYGBgYGBgYGBgYGBgYGBgYGBgYGBgYGBgYGBgYGBgYGBgYG/8AAEQgAQgBk\nAwEiAAIRAQMRAf/EAB4AAAEDBQEBAAAAAAAAAAAAAAAFCAkDBAYHCgIL/8QAORAAAQMCBQIEBQIE\nBQUAAAAAAQIDBAURAAYHEiEIMRMiQVEJFDJhcRVCI2KRoRZDgbHRUnJzgsH/xAAbAQABBQEBAAAA\nAAAAAAAAAAAEAQIDBQYHAP/EADARAAEDAwIFAgMJAQAAAAAAAAEAAgMEBRESIQYxUWFxMkETFSIU\nI1KRobHB0fHw/9oADAMBAAIRAxEAPwDrfNLzRPShTbbEJu4v848Enaf5Rc4WYeVEMuqVUq1IeAsW\n48YbU/6E3P8AthaeefKb+OEqP0qB4t7G/rhKfcXvBddKlgDkJBSP6YXOUmEuJZoMQJKYqHFODhcg\n+ISR/wBx/wBseHcyQ4u5DKWEhI+lqyeAPtxjEJTz7hCQpWxNzyjhKvzhHchuS0OEqUCkG672Tb3v\n/XnEjGNO5Oya5xBwsmmZ0ebdBQ9tQBZaL25Prx3wvQK7VVtNOvIS0ypABW+oDg9jbv64a3qtrHkz\nRnK0mu1uawhbCSEvPbAolKvMrxFEWTbge+Ig9VviwZHiTN0GuSMxx2fK7DjTEtNbuSNtzewseQLd\nsNa19ScRNyOqaXBnqK6EKpVaHKQ+xVo1CfWAdqZqEHcPfcTYf1xquuSdJorbjbkpqkrdACnYEwrb\nCz6WAUBzjmSV8T7NOY6kqkZRhsKmVyelmBETIXJfKnDtQhsX7kkelr345xl1O6hdZqW4wc1LTOpV\nPfS9Nhw5qVKjgG58RKVElI73FwLcnA0zHUMzGSyhjncgSAT4Gd0dTU1TWxOfFGXNbuSASB5XQzSK\n/kWiPtojTpxfeBKEOMhW+3ci1rG3Nj/X3zGFrHl2PKC2ZzzfyzhS+l+NYt27EkHkX9gePbEN+Vep\nCn1wNVNMp1Uj5MIaZLqdjalfUpPrciwwrNag1RwOVH5mRIZTUQ8+sLsXWwfpPHtYW+2D/l09Vk6z\n/wAPHVAuqGQHGApz4Wp8yYymXTXWXmim6gDckDsQDyPuD2/visvU2rqSpNkKB72xGfpnrPIkKXUW\n5KUQmmgi5fBS4QAfMm/oRbnDuaDnbLteYiyX3GaY4+lHj7pG0blcmxPHvYG35xUPimpnkOyW9f7R\njHRy4I2KcFRs31GWxIeWkBXzah9H8qf+cGEDLSIbkF9cWqJcaMxVlGPf9qfUGx/ODCtkjLU5ziHK\nlHltPsOJG5K0EFSD2/I55GLhoJcaQhLdwLgkJ2/jg4RXpVOoEVVTrc2NTae2m70iS6EoSn3N/TjG\nK1PXHTKgx3HpdYKG2EqK3noS0NBA/cFkAWPob83sL4PIy/Dd/G6D1gNyStoR6Y3dJVdSR3Vcjj2t\njTmqeZ41ORFoFLcRHkSJAM59KrBuOLl0ngi5SlQF+LkX5tfVlc6wMmVN+LR9Pmnsz1SYFBCY7wbb\nBT9ZWpdilIH7iCObAKUQkw4fFE+I5F6edKa/lWm5ooqNaa1TUl+jUmqF8xFupOwglCFbUlX1WCiE\nm+0W2sqIpo24LcHoef5JrJo5D9Jyo4PiqdWObdb9emem3RGTKqLWWQ1Enx6aje0ZS0KCxv3C620b\nLlVwN6ubi+NbaW/Co1NzFTIVeztnaRDW60HJUGGwX1NJUAfMrhIINwe4I5BGImsjdT+fqDnGp6qV\nKZT6nnauPpen1SnsNoWVC3lCbWKbJSD6kD3x2IUbqloeVuiOg5rn+DT9Tc46XU6oRXKcEvuolz2g\nQ2lC7hJStMxsFVxeOo2UBjPXLimagpRFCdI69StDZ7A66ve/GQwZOPYKPLLnw3qVpjUcv5yYzLVJ\n87LlQamxPm3fBV4zS0raG5HpuSAbg3Sog374Sv8AEUiXq7IohprhqjdcaE2kU9Kn3Plt4DqdlrlJ\nt29iRzexYvknrnruk+qOpNfzvnnNdfGpjAWzlfO2aH344VHSpAZgsujiyVlSkoWLeXgWTiSzSHWj\nT/Up6DqJk/LtLouqjNNZ2TC0kOzEnbtjvvuNLUhpRSn+Imx3EbtxIxyLig3q41bZJnnTjY+d/wB1\n0/gjimycO0crBCXvcdunLG/+J0LfRXWaHRKXXMtznozcmCl0UyWCh5hCudq/cgnuebYx39TzPpvN\nRRs70yVFD67Mzlxylh0Xtwq1r9uT7f64mt0vfyvnuiQKcqqU2RmOBTojdegtrBLTy2ULI2kA2O64\nNhcHCn1Q9O2VtQdHq7QpENpMyLRVKp1SjspS806lFgpKrcHG/wCD+JLrbarMztcBxnO5HUjv2WF4\nkttBWxfds0SZ2xy7A9u6hrZnVigLNdoKWqjRpriTVaQhzeFdiFIt2P8AxjeDfUZTKm3TYihPy2+w\n+3+pNLilYWlI52kdrm3cYj808ydrlRKhUctZaqqM0y8uS3I1TZrSVRmnlpUbKaKAvaNvBSb835xs\nTNOpOeNLFMztTNHszU6CpSUuZgpNJ/UoSR7lbSSpA4F94GO+0ENp4gjE1O4SZyNticbcjglcwrBc\nLRJ8KdpaRjuN9+YUtmmWsDVXoU2TEqiHmUVhaN0htYUCGmzY8ffBhkugPULpRmbJk+pwKvRA0cxv\nIWh6YhlxKwyySFIVZQICh3Ha2DAlRaZI5y34ZGOyVlSxzAdSc3nDUHULWCszIVDWIWSqbcxJjsTx\nlySFEFaN10cFNweVC/oQRhJj6SUVuO6nMEpT8kOOuTpkmYUBK0pKkuHzWANgST7H2xq6q9Xi2aUi\nj6Pab1SdDp6Eog1CLBC4TyCSVhS3227XCtoW2txBupVlAJ3RYdU/VX1ozqfUG4VLY08pE5LrVZlZ\nXrKvmm4agoOFBShP8RKFEJPYAHgqsoVmi4wU5DG6GjuAT5909zqSSbLjqP6LbXxDfinaO9D+VZVB\n0tpc/Pus8+KW4bdBQTTqcSopSqbL8JSENFxojYFBxYvtsLKxyj6UQszdTOpeZ9QdbM41PNtWmuCf\nmt+pSipb7zxIbRdJSQkBBFgRYADG2M4w6lV8zyHqnIfdYmOOGszpqzJVO3WCi/uJ8Qny8quTbnCN\nl/KVFylVZ8/ICpcSpVxKG1UmCXHkSV38iUMFRIN1mwSoWvYX7Y5lWX2omDsEtcffK0UFFGzG2yeb\nMTp7kyjoomU8q5TpTDKUFaoGW4aVuJty4XA3vWSbeZSlH83vi6zj1F55z5lPKOklKq8XLJr+Y8s0\nKpZ9eWt6NSKTHSthL7qEEpaUFVOpOlw24CexGG3w8jalS3/mtS5MXT2jicC3FlSfGrEu9xsbhi/y\n5J4/jlJG9Kglf0lRznIjPJi5Vyg01SMuw0XYhsLKg64oDc86r/McJ7rUT29sZc08crxk6jnOef8A\nq0NFda22NcYTp1DB8LMtYsjxX801GoSWKfU6hRak41T26TITJSmUfrLakhW4LBTtUkcpUgj6r4dB\n0iR8zeHNqcidTMsKQWUwI1QhOMvuhLw8Qrc3ANpIIIFjwsHbym8amRavmPLufK1mbK1ZL1McCY9Z\nefWHosiQ02G1WSq4uAlKdwH7BybDEqHRHlzK2uGc3msx1hD6KRLSG6ZFmuALct9JHICfMSUAgKty\nDbia40MslLoz0UNE18k+sDZdd/TdkfKlah6V6osVOpU3NcHJ7USrNQ5g+VqkZxpCmzJQb7yg+ZCg\nbjcRyLAPczzV6VCyvVpFamR4tPTBWJMiU6EtoQRbknsOf74YXoXmzK2WmKZk9NUpMNuPAR8ilx8J\nGxp1QUQm9+EbRe3cjDt6/Bdz7S3aM18suizFNiRJlMhxPh2C0qQnkEg7eD6/jHrZTtIEbfV7q6uI\nmjjbJKfpHLPTsmC9KOkyak5mfO86MFxMx5wqcmmuusELfjmQoMuAKFwgoSCkH0I5OJGV6Z5VrtMe\np9VokGVFfZ2uNvRwoKBHY3H3xdUKg0jK1Pi02nNWaiNJQlRNyfufe+M7p8xK07RzYXSm4x0Sgp5a\nKma1u2Fiauc1dQ57jnKYyx8PLSJE6uzaTSo1PjVesLlORUQ0lKXFNoSbcdvIO+DEjtJTvjuKTcXf\nNwDbmwwYuPnV0POQqu+w034UyWt6M5VjQ3YtLo0OG2E8NNRgBbsbce18Mh1a6T4ObhKaXT/FYcZW\njwG2TtNx6+3AxLuZVPcHmZZJPa6BbHttukuAAxWib+UhAGPNdK05UjmxuGFyK6n/AAckViZOnZXX\nmeiJkLU58lTk7mUkjkJQpKkgHn6QMMbn9EvUNoM/IoemOi+pebswS3pDdTzqxkNx2R8uqwTGYeQ2\nNjfN1eHtKys7yoBAT3uoptIWATGZB7G7YxTXlykOlYQyhBAvvRiluVqp69uCNO++BzRFPK6A5Byv\nnpVfoH6265KalI6Z9W6xNWtF1PUxuMQCokEqfcQkbeB3uO9uMYDmD4V/xQ9Q3JVJougEvTbLcoFL\nlUqWbYCag8gixAU2+oouD+1II/6sfRfXlZnnwnQLDs4gEYtv0Rto+YxlK7WCLWwNS2WjpXZxk91I\n+oleF8/fJPwUes6hZXj5VGRKpI8MhyUJGYYiIi1kjcklLm61vufXg9sPM0s+Cz1wUOqUysaaStO9\nFp1OWool1fMTkjxQCPDDjcdlW61ifMq9+5IJGO0Bqlx0q+jaR3CG74u/02Q5ZLLCkCxu4tITiSpt\nNNVSBzvbp/KNoLvV26J7I8fV1GceOihK6evhw6w0jUSkamdSGtFKzTmGm0QwHMs6Y06TAp0trclQ\nL633FKHKeQ2lG645FrGbCj0eJTYbMVppLTMdpKGmkosAkcAAe1hj0mkKiqLzqlLdJFlAdh9v7Yuy\nF3BDi96RcoIAN7fbBdNbqWlJMbQCeZUNZdLhXta2Z5cG8h7DwserKGkLUUAL3A3234IxRpe8HlSi\nlN7BPfF7JjuOLBSCUqV2HvivFjhjatwcpPqP/mLI4EeFWt1Fyz6hrIhqAIAD54K+3AwYpUV9sRXA\nDx8wbX49BgwHpClWkXCUuthJKRuPANhhXpSlbFncbharG/4wYMWo9BQ3ul5om3c/WPXF3DWsKNlK\nHnHZX3wYMRP9Kc3mldslbpCzvHsrn0wstJSEiyQPwMGDAb/Up17sPFRwOUc8ffHqwFrAC45sMGDD\nV5WbyUqW4FJBAbuAR64SVfSv/wAZwYMPZyXkl/s/9sXbfKk3549fzgwYe/0pG8kt0wkMugEgeOeA\nf5RgwYMQpV//2Q==\n\"/>"
}
},
"source": [
"Even images can be embedded: {{i}}. Images will be sanitized when loading a notebook. You will have to run the notebook after loading."
]
},
{
"cell_type": "code",
"collapsed": false,
"input": [
"class myimg:\n",
" def __init__(self,name, caption):\n",
" self.name = name\n",
" self.caption = caption\n",
" def __repr__(self):\n",
" return \"![\" + self.caption + \"](\" + self.name + \")\"\n",
" \n",
"i1 = myimg(\"mouse-toy.jpg\",\"An image\")"
],
"language": "python",
"metadata": {},
"outputs": [],
"prompt_number": 85
},
{
"cell_type": "markdown",
"metadata": {
"variables": {
"i1": "<img src=\"mouse-toy.jpg\" alt=\"An image\">"
}
},
"source": [
"You can also embed markdown, so images will be displayed after reloading:\n",
"{{i1}}"
]
},
{
"cell_type": "code",
"collapsed": false,
"input": [
"from IPython.display import HTML\n",
"import pandas as pd\n",
"data = pd.DataFrame({'spam':['ham','green','five',0,'kitties'],\n",
" 'eggs':[0,1,2,3,4]})"
],
"language": "python",
"metadata": {},
"outputs": [],
"prompt_number": 87
},
{
"cell_type": "markdown",
"metadata": {
"variables": {
"data": "<div style=\"max-height:1000px;max-width:1500px;overflow:auto;\">\n<table border=\"1\" class=\"dataframe\">\n <thead>\n <tr style=\"text-align: right;\">\n <th></th>\n <th>eggs</th>\n <th>spam</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>0</th>\n <td> 0</td>\n <td> ham</td>\n </tr>\n <tr>\n <th>1</th>\n <td> 1</td>\n <td> green</td>\n </tr>\n <tr>\n <th>2</th>\n <td> 2</td>\n <td> five</td>\n </tr>\n <tr>\n <th>3</th>\n <td> 3</td>\n <td> 0</td>\n </tr>\n <tr>\n <th>4</th>\n <td> 4</td>\n <td> kitties</td>\n </tr>\n </tbody>\n</table>\n</div>"
}
},
"source": [
"Pandas returns a HTML formatted table, which can be displayed:\n",
"\n",
"{{data}}"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": []
}
],
"metadata": {}
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment