Extras
Documentation Style¶
Code blockquotes with line highlight¶
import typer
app = typer.Typer()
@app.command()
def run(show: bool = typer.Option(None, "--show", "-s")):
"""Awesome function."""
if show:
typer.echo("hello world")
else:
typer.echo("*****")
if __name__ == "__main__":
app()
Source
```Python hl_lines="1 7 8 9 10 11 12" import typerapp = typer.Typer()
@app.command() def run(show: bool = typer.Option(None, "--show", "-s")): """Awesome function.""" if show: typer.echo("hello world") else: typer.echo("*")
if name == "main": app() ```
Footnote¶
This is a footnote 1 and this is another footnote2
Source
This is a footnote[^1] and this is another footnote[^2]
[^1]: Footnote 1.
[^2]: Footnote 2.
Mathematical notation¶
p(x|y) = \frac{p(y|x)p(x)}{p(y)}, p(x|y) = \frac{p(y|x)p(x)}{p(y)}.
Source
$p(x|y) = \frac{p(y|x)p(x)}{p(y)}$, \(p(x|y) = \frac{p(y|x)p(x)}{p(y)}\).
Message detail¶
Warning
Warning message.
Source
!!! warning
Warning message.
Tab¶
Markdown content.
Multiple paragraphs.
More Markdown content.
- list item a
- list item b
Source
=== "Tab 1"
Markdown **content**.
Multiple paragraphs.
=== "Tab 2"
More Markdown **content**.
- list item a
- list item b
Table¶
First Header | Second Header | Third Header |
---|---|---|
Content Cell | Content Cell | Content Cell |
Content Cell | Content Cell | Content Cell |
Source
| First Header | Second Header | Third Header |
| ------------ | ------------- | ------------ |
| Content Cell | Content Cell | Content Cell |
| Content Cell | Content Cell | Content Cell |
Task list¶
- item 1
- item A
- item B more text
- item a
- item b
- item c
- item C
- item 2
- item 3
Source
- [X] item 1
* [X] item A
* [ ] item B
more text
+ [x] item a
+ [ ] item b
+ [x] item c
* [X] item C
- [ ] item 2
- [ ] item 3