{"id":13565121,"url":"https://github.com/jlin27/docusaurus-plugin-jupyter-notebook","last_synced_at":"2026-02-08T15:08:04.185Z","repository":{"id":81642494,"uuid":"347163124","full_name":"jlin27/docusaurus-plugin-jupyter-notebook","owner":"jlin27","description":"[WIP] Jupyter notebook plugin for docusaurus","archived":false,"fork":false,"pushed_at":"2021-06-23T22:58:30.000Z","size":597,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-11-04T18:46:10.307Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jlin27.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-03-12T18:37:28.000Z","updated_at":"2023-12-01T20:54:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"eb65e862-0ad9-49dd-8289-696b51c88665","html_url":"https://github.com/jlin27/docusaurus-plugin-jupyter-notebook","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlin27%2Fdocusaurus-plugin-jupyter-notebook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlin27%2Fdocusaurus-plugin-jupyter-notebook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlin27%2Fdocusaurus-plugin-jupyter-notebook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlin27%2Fdocusaurus-plugin-jupyter-notebook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jlin27","download_url":"https://codeload.github.com/jlin27/docusaurus-plugin-jupyter-notebook/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247089771,"owners_count":20881837,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T13:01:41.156Z","updated_at":"2026-02-08T15:08:04.089Z","avatar_url":"https://github.com/jlin27.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# Jupyter Notebook Integration for Docusaurus\n\n## Overview\n\n**WARNING** This plugin is still a work in progress. The plugin architecture is not setup and the steps to convert the notebook to be browser-renderable are still manual. \n\n[Docusaurs 2](https://docusaurus.io/) supports a plugin architecture. This repo demonstrates the flow of a plugin that could be used to parse a [jupyter notebook](https://jupyter.org/) and seamlessly add it into Docusaurus site. Doing so provides a way for machine learning engineers to easily share their jupyter notebook tutorials on their website. \n\nThe plugin converts the notebook to html and renders that in the browser. This is how the plugin works:\n1. Convert .ipynb → html using nbconvert \n2. Convert html → jsx using https://github.com/reactjs/react-magic/blob/master/README-htmltojsx.md\n  * Web-based version https://magic.reactjs.net/htmltojsx.htm\n3. Add the converted jsx notebook as a component in a mdx doc page\n  * [TestJupyterComponent.js](https://github.com/jlin27/docusaurus-plugin-jupyter-notebook/blob/main/my-website/src/pages/TestJupyterComponent.js) goes into [docs/jupyter.mdx](https://github.com/jlin27/docusaurus-plugin-jupyter-notebook/blob/main/my-website/docs/jupyter.mdx)\n\n\n\n## How to use\n\nTo test this, \n```\ngit clone https://github.com/jlin27/docusaurus-plugin-jupyter-notebook\ncd my-website\nnpm run typescript\nyarn build\nyarn start\n```\nMake sure you have all the [docusaurus installation](https://v2.docusaurus.io/docs/installation) setup.\n\nTo just test the plugin:\n```\ncd my-website/plugin-jupyter-notebook\nnpm run tsc // Runs Typescript compiler\n```\n\n\n\n \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlin27%2Fdocusaurus-plugin-jupyter-notebook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjlin27%2Fdocusaurus-plugin-jupyter-notebook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlin27%2Fdocusaurus-plugin-jupyter-notebook/lists"}