Quickstart

Lite environment

To use the JupyterLite plugin, you need to have a *.yaml file describing the environment you want to use. This file should look like this:

my_env.yaml

name: xeus-lite-wasm
channels:
  - https://repo.mamba.pm/emscripten-forge
  - conda-forge
dependencies:
  - xeus-python
  - numpy

The usual mkdocs.yml is needed. It needs pymdownx.superfences as an extension and jupyterlite-plugin as a plugin.

mkdocs.yml

## Mkdocs configuration

```{.yaml title="mkdocs.yml"}
site_name: mkdocs-jupyterlite


markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: repl
          class: iframe
          format: !!python/name:mkdocs_jupyterlite.superfences.repl_formater
          validator: !!python/name:mkdocs_jupyterlite.superfences.repl_validator

plugins:
  - jupyterlite-plugin:
      environments:
        my_env:
          build: 9
          env_file: my_env.yaml
          notebook_dir: notebooks
          notebook_pattern: "*.py"
          notebook_doc_path: "examples/notebooks"
          kernel_mapping:
            py: xpython
          mounts:
            - host: lite_envs/with_numpy/mounts/some_mount
              target: "/some/target/dir"

Usage

To include a repl in your markdown file, you can use the following syntax:

```{.repl kernel="xpython" env="my_env"}
print('hello world')
```

This will render the following: