gatsby-transformer-ipynb

Parses jupyter notebook files.

Install

npm install --save @gatsby-contrib/gatsby-transformer-ipynb

How to use

// In your gatsby-config.js
plugins: [`@gatsby-contrib/gatsby-transformer-ipynb`];

Parsing algorithm

It recognizes files with the ipynb extension.

Each notebook file is parsed into a node of type JupyterNotebook.

This plugin adds additional fields to the JupyterNotebook GraphQL type including:

html: html string created using the react component NotebookRender from @gatsby-contrib/notebook-render.
metadata: jupyter notebooks can embed metadata to indicate authors, titles...
json: the json notebook code converted into a javascript object with JSON.parse.
internal.content: contains the raw notebook code, it can be used to feed the react component NotebookPreview from @gatsby-contrib/notebook-preview.

How to query

A sample GraphQL query to get JupyterNotebook nodes:

{
  query
  JupyterQuery {
    allJupyterNotebook {
      edges {
        node {
          id
          metadata {
            kernelspec {
              name
              language
              display_name
            }
          }
          html
          json {
            nbformat
            nbformat_minor
            cells {
              cell_type
              execution_count
            }
          }
          internal {
            content
          }
        }
      }
    }
  }
}

License

andru/gatsby-transformer-ipynb

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages