Skip to main content

Notebook parsing filters for Pandoc

Project description

Noteout

Pandoc filters for, among other things, extracting embedded notebooks, replacing with suitable link material.

See the example Quarto book project in noteout/tests/qbook for a quickstart.

Install with:

pip install noteout

or (for latest git version):

pip install git+https://github.com/matthew-brett/noteout

This allows you to delineate notebooks in your pages with markup of form:

Information in page.

::: {.notebook name="a_notebook"}
Some text.

```{r}
# Some code
```
:::

More information in page.

::: {.notebook name="b_notebook"}
More text.

```{r}
# More code
```
:::

Use with something like the following in your _quarto.yml file:

filters:
  - quarto
  - noteout-write-notebooks

noteout:
  nb-format: Rmd

By default, Noteout writes your notebooks to your Quarto output-dir. In the example above, Noteout would write a_notebook.Rmd and b_notebook.Rmd to your output-dir directory.

See the Resampling book for a fully worked example, with extra configuration, and the Resampling-with Github repository for the configuration and text source files.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

noteout-0.0.3a7.tar.gz (13.9 kB view hashes)

Uploaded Source

Built Distribution

noteout-0.0.3a7-py3-none-any.whl (20.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page