|
|
|
@ -80,16 +80,17 @@ Literate.markdown |
|
|
|
Literate can output markdown in different flavors. The flavor is specified using the |
|
|
|
Literate can output markdown in different flavors. The flavor is specified using the |
|
|
|
`flavor` keyword argument. The following flavors are currently supported: |
|
|
|
`flavor` keyword argument. The following flavors are currently supported: |
|
|
|
|
|
|
|
|
|
|
|
- `flavor = Literate.DocumenterFlavor()` this is the default flavor and the output is |
|
|
|
- `flavor = Literate.DocumenterFlavor()`: this is the default flavor and the output is |
|
|
|
meant to be used as input to [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl). |
|
|
|
meant to be used as input to [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl). |
|
|
|
- `flavor = Literate.FranklinFlavor()` this outputs markdown meant to be used as input |
|
|
|
- `flavor = Literate.FranklinFlavor()`: this outputs markdown meant to be used as input |
|
|
|
to [Franklin.jl](https://franklinjl.org/). |
|
|
|
to [Franklin.jl](https://franklinjl.org/). |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## [**4.2.** Notebook output](@id Notebook-output) |
|
|
|
## [**4.2.** Notebook output](@id Notebook-output) |
|
|
|
|
|
|
|
|
|
|
|
Notebook output is generated by [`Literate.notebook`](@ref). The (default) notebook output |
|
|
|
Notebook output is generated by [`Literate.notebook`](@ref). The Jupyter notebook output |
|
|
|
of the source snippet can be seen here: [notebook.ipynb](generated/notebook.ipynb). |
|
|
|
of the source snippet can be seen here: [notebook.ipynb](generated/notebook.ipynb), |
|
|
|
|
|
|
|
and the Pluto notebook output can be seen here: [notebook.jl](generated/notebook.jl). |
|
|
|
|
|
|
|
|
|
|
|
We note that lines starting with `# ` are placed in markdown cells, |
|
|
|
We note that lines starting with `# ` are placed in markdown cells, |
|
|
|
and the code lines have been placed in code cells. By default the notebook |
|
|
|
and the code lines have been placed in code cells. By default the notebook |
|
|
|
@ -103,6 +104,14 @@ output of [`Literate.notebook`](@ref). |
|
|
|
Literate.notebook |
|
|
|
Literate.notebook |
|
|
|
``` |
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Notebook flavors |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Literate can output both Jupyter notebooks and Pluto notebooks. The flavor is specified |
|
|
|
|
|
|
|
using the `flavor` keyword argument: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- `flavor = Literate.JupyterFlavor()` (default) |
|
|
|
|
|
|
|
- `flavor = Literate.PlutoFlavor()` |
|
|
|
|
|
|
|
|
|
|
|
### Notebook metadata |
|
|
|
### Notebook metadata |
|
|
|
|
|
|
|
|
|
|
|
Jupyter notebook cells (both code cells and markdown cells) can contain metadata. This is enabled |
|
|
|
Jupyter notebook cells (both code cells and markdown cells) can contain metadata. This is enabled |
|
|
|
|