Jupyter Markdown Cheat Sheet
Description: Jupyter notebook Homework 1/HW 1.2 - Markdown and LaTeX Cheatsheet.ipynb Compute Environment: Ubuntu 18.04 (Deprecated) Unless otherwise specified, each part of this problem is worth 0.1 points, for a total of 2.75 points.
Markdown Cheatsheet
This will help you to write a nice documentation !
- Here’s how to format Markdown cells in Jupyter notebooks: HeadingsUse the number sign (#) followed by a blank space for notebook titles and section headings: # for titles ## for major headings ### for subheadings #### for 4th level subheadings; EmphasisUse the following code to emphasize text: Bold text: string or.string.
- Markdown is a way to style text on the web. You control the display of the document; forma˜ing words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or.
- Using markdown, you can quickly include headers, links, images, bold or italic text, paragraphs, and ordered or unordered lists. In this guide, we'll be using Jupyter notebooks to demonstrate markdown, however note that markdown is not Jupyter specific. Many other services and products use it to allow easy text formatting.
H2
H3
H4
H5
H6
Alternatively, for H1 and H2, an underline-ish style:
Alt-H2
Emphasis
Emphasis, aka italics, with asterisks or underscores.
Strong emphasis, aka bold, with asterisks or underscores.
Combined emphasis with asterisks and underscores.
Strikethrough uses two tildes. Scratch this.
Markdown Cheatsheet Pdf
Lists
(In this example, leading and trailing spaces are shown with with dots: ⋅)
- First ordered list item
- Another item
- Unordered sub-list.
- Actual numbers don't matter, just that it's a number
- Ordered sub-list
And another item.
You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
To have a line break without a paragraph, you will need to use two trailing spaces.
Note that this line is separate, but within the same paragraph.
(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
- Unordered list can use asterisks
- Or minuses
- Or pluses
Links
There are two ways to create links.
Or leave it empty and use the link text itself.
URLs and URLs in angle brackets will automatically get turned into links.http://www.example.com or http://www.example.com and sometimesexample.com (but not on Github, for example).
Some text to show that the reference links can follow later.
Images
Here's our logo (hover to see the title text):
Inline-style:
Reference-style:
Code and Syntax Highlighting
Code blocks are part of the Markdown spec, but syntax highlighting isn't. However, many renderers -- like Github's and Markdown Here -- support syntax highlighting. Which languages are supported and how those language names should be written will vary from renderer to renderer. Markdown Here supports highlighting for dozens of languages (and not-really-languages, like diffs and HTTP headers); to see the complete list, and how to write the language names, see the highlight.js demo page.
Inline code
has back-ticks around
it.
Blocks of code are either fenced by lines with three back-ticks ```
, or are indented with four spaces. I recommend only using the fenced code blocks -- they're easier and only they support syntax highlighting.
Tables
Tables aren't part of the core Markdown spec, but they are part of GFM and Markdown Here supports them. They are an easy way of adding tables to your email -- a task that would otherwise require copy-pasting from another application.
Colons can be used to align columns.
Tables | Are | Cool |
---|---|---|
col 3 is | right-aligned | $1600 |
col 2 is | centered | $12 |
zebra stripes | are neat | $1 |
There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.
Markdown | Less | Pretty |
---|---|---|
Still | renders | nicely |
1 | 2 | 3 |
Blockquotes
Blockquotes are very handy in email to emulate reply text.This line is part of the same quote.
Quote break.
This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can putMarkdown into a blockquote.
Inline HTML
You can also use raw HTML in your Markdown, and it'll mostly work pretty well.
- Definition list
- Is something people use sometimes.
- Markdown in HTML
- Does *not* work **very** well. Use HTML tags.
Horizontal Rule
Three or more...
Jupyter Markdown Cheat Sheet Printable
Hyphens
Asterisks
Underscores
Line Breaks
My basic recommendation for learning how line breaks work is to experiment and discover -- hit <Enter> once (i.e., insert one newline), then hit it twice (i.e., insert two newlines), see what happens. You'll soon learn to get what you want. 'Markdown Toggle' is your friend.
Here are some things to try out:
Here's a line for us to start with.
This line is separated from the one above by two newlines, so it will be a separate paragraph.
This line is also begins a separate paragraph, but...
This line is only separated by a single newline, so it's a separate line in the same paragraph.
(Technical note: Markdown Here uses GFM line breaks, so there's no need to use MD's two-space line breaks.)
Youtube videos
They can't be added directly but you can add an image with a link to the video like this:
Or, in pure Markdown, but losing the image sizing and border:
Referencing a bug by #bugID in your git commit links it to the slip. For example #1.
Are you starting to create machine learning models (using python programming) using JupyterLab or Jupyter Notebook? This post list down some commands which are found to be very useful while one (beginner data scientist) is getting started with using JupyterLabnotebook for building machine learning models.
- Notebook Operations: The following command helps to perform operations with the notebook.
- Ctrl + S: Save the notebook
- Ctrl + Q: Close the notebook
- Enter: While on any cell, you want to enter edit mode, press Enter.
- Cells Operation: The following commands help with performing operations on cells:
- J: Select the cell below the current cell; This command would be used to go through cells below the current cell; Once you reached to the desired cell, you could Shift + Enter to execute the command in the given cell.
- K: Select the cell above the current cell
- X: Cut the content of the current cell
- C: Copy the content of the current cell
- V: Paste the command copied into the below cell
- Shift + Enter: Run the selected cell and insert a cell below
- Ctrl + Enter: Run the selected cell but do not add the cell below; If this command is used, one could use B to enter a cell below.
- B: Enter a cell below. This command comes handy for entering the cell at any point. Very useful if you want to add a markdown note before/after execution of any command.
- D,D: Delete the cell
- Notes taking operations using Markdown editor: If you are a blogger, you would love these shortcuts. Very useful for taking notes while you are working on your models.
- M: Go to Markdown mode to write some notes in markdown format
- Y: Go to Code mode to continue working with code
Summary
In this post, you learned about some of the quick commands (Cheat sheet) which you could use for your reference while working with JupyterLab or Jupyter Notebook. Please feel free to suggest other commands that you found to be useful which are not listed above.
- First Principles Understanding based on Physics - April 13, 2021
- Precision & Recall Explained using Covid-19 Example - April 11, 2021
- Moving Average Method for Time-series forecasting - April 4, 2021