What is Markdown ?¶
Markdown is a way to style text on the web. You control the display of the document; formatting 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 *.Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).
Thus, “Markdown” is two things: (1) a plain text formatting syntax; and (2) a software tool, written in Perl, that converts the plain text formatting to HTML. See the Syntax page for details pertaining to Markdown’s formatting syntax. You can try it out, right now, using the online Dingus.
The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
You can use Markdown most places around GitHub:¶
-GistsHow to use Headers ?¶
How to create Unordered List:¶
You can build nested itemized or enumerated lists:
- File
- Rename
- Save and checkpoint; 'CTRL' + s
- Print Preview
- New Notebook
- Cell
- Run All
- Help
- Python
- NumPy
- SciPy
How to Create an Order List:¶
Make sure to add proper indentation with numbered list.
- Alpha
- Bravo
- Red
- Apple
- Crayon
- Green
- Blue
- Red
- Charlie
- Delta
- Echo
Here come the Block Quotes!¶
To create an block Quotes just add ">" Symbol before the quote.
Benjamin Franklin said:¶
Early to bed and early to rise, makes a man healthy, wealthy, and wise.
How much Emphasis ?¶
Adding bold and italics to text is important to provide emphasis to text!
Follow the below examples .
This text will be italic
This will also be italic
This text will be bold
This will also be bold
You can combine them
Follow the below examples .
This text will be italic
This will also be italic
This text will be bold
This will also be bold
You can combine them
Embedded code¶
You can embed code meant for illustration instead of execution in Python:def f(x):
"""a docstring"""
return x**2
if (i=0; i<n; i++) {
printf("hello %d\n", i);
x += 4;
}
Markdown Tables¶
Markdown Tables GeneratorIn [ ]:
Type | Description | |
---|---|---|
date | Store calendar date (year, month, day) using a Gregorian Calendar | |
time | Store time of day as hours, minutes, seconds, microseconds | |
datetime | Store both date and time | |
timedelta | Difference between two datetime values |
The Lorenz Equations¶
\begin{align}
\dot{x} & = \sigma(y-x) \\
\dot{y} & = \rho x - y - xz \\
\dot{z} & = -\beta z + xy
\end{align}
\dot{x} & = \sigma(y-x) \\
\dot{y} & = \rho x - y - xz \\
\dot{z} & = -\beta z + xy
\end{align}
Identity of Ramanujan¶
Srinivasa RamanujanSelf-taught, no formal training in mathematics, made contributions to:
- mathematical analysis
- number theory
- infinite series
- continued fractions
In [ ]:
\begin{equation*}
\frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} =
1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}}
{1+\frac{e^{-8\pi}} {1+\ldots} } } }
\end{equation*}
In [ ]:
# What is Markdown ?
Markdown is a way to style text on the web. You control the display of the document; formatting 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 *.
Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).
Thus, “Markdown” is two things: (1) a plain text formatting syntax; and (2) a software tool, written in Perl, that converts the plain text formatting to HTML. See the Syntax page for details pertaining to Markdown’s formatting syntax. You can try it out, right now, using the online Dingus.
The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
#### You can use Markdown most places around GitHub:
-Gists
In [ ]:
# How to use Headers ?
In [ ]:
You can add headings by starting a line with one (or multiple) # followed by a space, as in the following example:
# This is an h1 tag
## This is an h2 tag
###### This is an h6 tag
In [ ]:
# How to create Unordered List:
In [ ]:
You can build nested itemized or enumerated lists:
- File
- Rename
- Save and checkpoint; 'CTRL' + s
- Print Preview
- New Notebook
- Cell
- Run All
- Help
- Python
- NumPy
- SciPy
In [ ]:
# How to Create an Order List:
In [ ]:
Make sure to add proper indentation with numbered list.
1. Alpha
2. Bravo
1. Red
1. Apple
2. Crayon
2. Green
3. Blue
3. Charlie
4. Delta
5. Echo
In [ ]:
# Here come the Block Quotes!
In [ ]:
To create an block Quotes just add ">" Symbol before the quote.
##### Benjamin Franklin said:
> Early to bed and early to rise, makes a man healthy, wealthy, and wise.
In [ ]:
# How much Emphasis ?
In [ ]:
Adding bold and italics to text is important to provide emphasis to text!
Follow the below examples .
*This text will be italic*
_This will also be italic_
**This text will be bold**
__This will also be bold__
*You **can** combine them*
In [ ]:
## Embedded code
You can embed code meant for illustration instead of execution in Python:
def f(x):
"""a docstring"""
return x**2
if (i=0; i<n; i++) {
printf("hello %d\n", i);
x += 4;
}
In [ ]:
# Markdown Tables
Markdown Tables Generator
In [ ]:
| Type | | Description |
|-----------|---|---------------------------------------------------------------------|
| | | |
| date | | Store calendar date (year, month, day) using a Gregorian Calendar |
| time | | Store time of day as hours, minutes, seconds, microseconds |
| datetime | | Store both date and time |
| timedelta | | Difference between two datetime values |
In [ ]:
# Beautiful Mathematics Typesetting
[Tex](https://en.wikipedia.org/wiki/TeX)
[LaTex](https://www.latex-project.org/)
[Motivating Examples](http://jupyter-notebook.readthedocs.io/en/latest/examples/Notebook/Typesetting%20Equations.html)
In [ ]:
### The Lorenz Equations
In [ ]:
\begin{align}
\dot{x} & = \sigma(y-x) \\
\dot{y} & = \rho x - y - xz \\
\dot{z} & = -\beta z + xy
\end{align}
In [ ]:
### Identity of Ramanujan
[Srinivasa Ramanujan](https://en.wikipedia.org/wiki/Srinivasa_Ramanujan)
Self-taught, no formal training in mathematics, made contributions to:
- mathematical analysis
- number theory
- infinite series
- continued fractions
In [ ]:
\begin{equation*}
\frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} =
1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}}
{1+\frac{e^{-8\pi}} {1+\ldots} } } }
\end{equation*}
In [ ]:
# Markdown: light-weight markup language
### Resources to get Started with Markdown
- [Daring Fireball](https://daringfireball.net/projects/markdown/)
- [Markdown cheat sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
- [Github Mastering Markdown](https://guides.github.com/features/mastering-markdown/)
- pdf version [Github Mastering Markdown](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf)
4 comments
I'm new to this.Thanks it helped me
Great post sir!
Wow..great post helped me to find new things that can be done in jupyter notebooks..
Is this post written from notebook ?
EmoticonEmoticon