Skip to content

generate static md documentation from marimo notebooks with cell outputs #41

Description

@bstaber

Hey,

Is it possible to do something similar to myst-nb/nbconvert in sphinx, i.e., automatically generate static markdown pages that contain the cells and their outputs when building the docs?

With sphinx we would do something like:

# docs/examples.rst

.. toctree::
   :glob:
   :maxdepth: 1

   notebooks/notebook1
   notebooks/notebook2
   notebooks/notebook3

and this would automatically generate static pages corresponding to each notebook (with the cells outputs). Would it be possible to have the same thing by configuring the nav in our mkdocs.yml as:

nav:
  - Home: index.md
  - Examples:
        - notebooks/notebook1.md
        - notebooks/notebook2.md
        - ...

where notebook{i}.md is generated at build time using the marimo notebook{i}.py ?

I believe that mkdocs-jupyter does the same thing but for jupyter notebooks in mkdocs..

Thanks

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions