Special content blocks
Contents
Special content blocks#
There are a few content blocks that are unique to this theme.
Quotations and epigraphs#
Here is what quotations and epigraphs look like in sphinx-book-theme
:
A quote with no attribution:
Here’s my quote, it’s pretty neat. I wonder how many lines I can create with a single stream-of-consciousness quote. I could try to add a list of ideas to talk about. I suppose I could just keep going on forever, but I’ll stop here.
Sometimes you’d like to draw more attention to a quote. To do so, use the {epigraph}
directive.
Below is an epigraph, click the button to the right of it to show the code that was used
to generate it:
Here’s my quote, it’s pretty neat. I wonder how many lines I can create with a single stream-of-consciousness quote. I could try to add a list of ideas to talk about. I suppose I could just keep going on forever, but I’ll stop here.
```{epigraph}
Here's my quote, it's pretty neat.
I wonder how many lines I can create with
a single stream-of-consciousness quote.
I could try to add a list of ideas to talk about.
I suppose I could just keep going on forever,
but I'll stop here.
```
You can also add an attribution to epigraphs by adding a blank line,
followed by a line that starts with --
. This will be renderered like so:
Here’s my quote, it’s pretty neat. I wonder how many lines I can create with a single stream-of-consciousness quote. I could try to add a list of ideas to talk about. I suppose I could just keep going on forever, but I’ll stop here.
—Jo the Jovyan, the jupyter book docs
```{epigraph}
Here's my quote, it's pretty neat.
I wonder how many lines I can create with
a single stream-of-consciousness quote.
I could try to add a list of ideas to talk about.
I suppose I could just keep going on forever,
but I'll stop here.
-- Jo the Jovyan, *[the jupyter book docs](https://beta.jupyterbook.org)*
```
Full-width content#
Full-width content extends into the right margin, making it stand out against
the rest of your book’s content. To add full-width content to your page, add the
class full-width
to any of the elements in your documentation. For example, you can
add a full-width
tag to a note element like this:
```{note}
:class: full-width
This content will be full-width
```
This code results in the following output:
Note
This content will be full-width
A note for ipynb users
If you are using a Jupyter Notebook as inputs to your documentation using the
MyST-NB extension, you can trigger
this behavior with a code cell by adding a full-width
tag to the cell.