| Name | mkdocs-nbsync JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | None |
| Summary | MkDocs plugin treating Jupyter notebooks, Python scripts and Markdown files as first-class citizens for documentation with dynamic execution and real-time synchronization |
| upload_time | 2025-08-23 05:48:52 |
| maintainer | None |
| docs_url | None |
| author | daizutabi |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2025 Daizu Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
jupyter
notebook
mkdocs
documentation
markdown
python
visualization
dynamic-execution
real-time-sync
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mkdocs-nbsync
[![PyPI Version][pypi-v-image]][pypi-v-link]
[![Python Version][python-v-image]][python-v-link]
[![Build Status][GHAction-image]][GHAction-link]
[![Coverage Status][codecov-image]][codecov-link]
[](https://pepy.tech/project/mkdocs-nbsync)
[](https://github.com/daizutabi/mkdocs-nbsync)
[](https://opensource.org/licenses/MIT)
## 🔄 **Stop fighting with notebook documentation!**
**The Problem:** Screenshots break. Exports get forgotten. Code and docs drift apart. 😩
**The Solution:** One simple syntax that keeps everything in sync:
```markdown
{#figure-name}
```
**That's it!** No more manual exports. No more broken documentation. 🎉
---
mkdocs-nbsync is a MkDocs plugin that seamlessly embeds Jupyter notebook
visualizations in your documentation, solving the disconnect between
code development and documentation.
## Why Use mkdocs-nbsync?
### The Documentation Challenge
Data scientists, researchers, and technical writers face a common dilemma:
- **Development happens in notebooks** - ideal for experimentation and visualization
- **Documentation lives in markdown** - perfect for narrative and explanation
- **Connecting the two is painful** - screenshots break, exports get outdated
### Our Solution
This plugin creates a live bridge between your notebooks and documentation by:
- **Keeping environments separate** - work in the tool best suited for each task
- **Maintaining connections** - reference specific figures from notebooks
- **Automating updates** - changes to notebooks reflect in documentation
## Key Benefits
- **True Separation of Concerns**:
Develop visualizations in Jupyter notebooks and write documentation
in markdown files, with each tool optimized for its purpose.
- **Intuitive Markdown Syntax**:
Use standard image syntax with a simple extension to reference
notebook figures: `{#figure-id}`
- **Automatic Updates**:
When you modify your notebooks, your documentation updates
automatically in MkDocs serve mode.
- **Clean Source Documents**:
Your markdown remains readable and focused on content, without
code distractions or complex embedding techniques.
- **Enhanced Development Experience**:
Take advantage of IDE features like code completion and syntax
highlighting in the appropriate environment.
## Quick Start
### 1. Installation
```bash
pip install mkdocs-nbsync
```
### 2. Configuration
Add to your `mkdocs.yml`:
```yaml
plugins:
- mkdocs-nbsync:
src_dir: ../notebooks
```
### 3. Mark Figures in Your Notebook
In your Jupyter notebook, identify figures with a comment:
```python
# #my-figure
import matplotlib.pyplot as plt
fig, ax = plt.subplots(figsize=(8, 4))
ax.plot([1, 2, 3, 4], [10, 20, 25, 30])
```
### 4. Reference in Markdown
Use standard Markdown image syntax with the figure identifier:
```markdown
{#my-figure}
```
## The Power of Separation
Creating documentation and developing visualizations involve different
workflows and timeframes. When building visualizations in Jupyter notebooks,
you need rapid cycles of execution, verification, and modification.
This plugin is designed specifically to address these separation of
concerns, allowing you to:
- **Focus on code** in notebooks without documentation distractions
- **Focus on narrative** in markdown without code interruptions
- **Maintain powerful connections** between both environments
Each environment is optimized for its purpose, while the plugin
handles the integration automatically.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
## License
This project is licensed under the MIT License.
<!-- Badges -->
[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-nbsync.svg
[pypi-v-link]: https://pypi.org/project/mkdocs-nbsync/
[python-v-image]: https://img.shields.io/pypi/pyversions/mkdocs-nbsync.svg
[python-v-link]: https://pypi.org/project/mkdocs-nbsync
[GHAction-image]: https://github.com/daizutabi/mkdocs-nbsync/actions/workflows/ci.yaml/badge.svg?branch=main&event=push
[GHAction-link]: https://github.com/daizutabi/mkdocs-nbsync/actions?query=event%3Apush+branch%3Amain
[codecov-image]: https://codecov.io/github/daizutabi/mkdocs-nbsync/coverage.svg?branch=main
[codecov-link]: https://codecov.io/github/daizutabi/mkdocs-nbsync?branch=main
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-nbsync",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "jupyter, notebook, mkdocs, documentation, markdown, python, visualization, dynamic-execution, real-time-sync",
"author": "daizutabi",
"author_email": "daizutabi <daizutabi@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ef/8d/9388a208ff41238c2124d3a59f8eb68ab8284b88414a282969b4eae57e4b/mkdocs_nbsync-0.1.5.tar.gz",
"platform": null,
"description": "# mkdocs-nbsync\n\n[![PyPI Version][pypi-v-image]][pypi-v-link]\n[![Python Version][python-v-image]][python-v-link]\n[![Build Status][GHAction-image]][GHAction-link]\n[![Coverage Status][codecov-image]][codecov-link]\n[](https://pepy.tech/project/mkdocs-nbsync)\n[](https://github.com/daizutabi/mkdocs-nbsync)\n[](https://opensource.org/licenses/MIT)\n\n## \ud83d\udd04 **Stop fighting with notebook documentation!**\n\n**The Problem:** Screenshots break. Exports get forgotten. Code and docs drift apart. \ud83d\ude29\n\n**The Solution:** One simple syntax that keeps everything in sync:\n```markdown\n{#figure-name}\n```\n\n**That's it!** No more manual exports. No more broken documentation. \ud83c\udf89\n\n---\n\nmkdocs-nbsync is a MkDocs plugin that seamlessly embeds Jupyter notebook\nvisualizations in your documentation, solving the disconnect between\ncode development and documentation.\n\n## Why Use mkdocs-nbsync?\n\n### The Documentation Challenge\n\nData scientists, researchers, and technical writers face a common dilemma:\n\n- **Development happens in notebooks** - ideal for experimentation and visualization\n- **Documentation lives in markdown** - perfect for narrative and explanation\n- **Connecting the two is painful** - screenshots break, exports get outdated\n\n### Our Solution\n\nThis plugin creates a live bridge between your notebooks and documentation by:\n\n- **Keeping environments separate** - work in the tool best suited for each task\n- **Maintaining connections** - reference specific figures from notebooks\n- **Automating updates** - changes to notebooks reflect in documentation\n\n## Key Benefits\n\n- **True Separation of Concerns**:\n Develop visualizations in Jupyter notebooks and write documentation\n in markdown files, with each tool optimized for its purpose.\n\n- **Intuitive Markdown Syntax**:\n Use standard image syntax with a simple extension to reference\n notebook figures: `{#figure-id}`\n\n- **Automatic Updates**:\n When you modify your notebooks, your documentation updates\n automatically in MkDocs serve mode.\n\n- **Clean Source Documents**:\n Your markdown remains readable and focused on content, without\n code distractions or complex embedding techniques.\n\n- **Enhanced Development Experience**:\n Take advantage of IDE features like code completion and syntax\n highlighting in the appropriate environment.\n\n## Quick Start\n\n### 1. Installation\n\n```bash\npip install mkdocs-nbsync\n```\n\n### 2. Configuration\n\nAdd to your `mkdocs.yml`:\n\n```yaml\nplugins:\n - mkdocs-nbsync:\n src_dir: ../notebooks\n```\n\n### 3. Mark Figures in Your Notebook\n\nIn your Jupyter notebook, identify figures with a comment:\n\n```python\n# #my-figure\nimport matplotlib.pyplot as plt\n\nfig, ax = plt.subplots(figsize=(8, 4))\nax.plot([1, 2, 3, 4], [10, 20, 25, 30])\n```\n\n### 4. Reference in Markdown\n\nUse standard Markdown image syntax with the figure identifier:\n\n```markdown\n{#my-figure}\n```\n\n## The Power of Separation\n\nCreating documentation and developing visualizations involve different\nworkflows and timeframes. When building visualizations in Jupyter notebooks,\nyou need rapid cycles of execution, verification, and modification.\n\nThis plugin is designed specifically to address these separation of\nconcerns, allowing you to:\n\n- **Focus on code** in notebooks without documentation distractions\n- **Focus on narrative** in markdown without code interruptions\n- **Maintain powerful connections** between both environments\n\nEach environment is optimized for its purpose, while the plugin\nhandles the integration automatically.\n\n## Contributing\n\nContributions are welcome! Please open an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License.\n\n<!-- Badges -->\n[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-nbsync.svg\n[pypi-v-link]: https://pypi.org/project/mkdocs-nbsync/\n[python-v-image]: https://img.shields.io/pypi/pyversions/mkdocs-nbsync.svg\n[python-v-link]: https://pypi.org/project/mkdocs-nbsync\n[GHAction-image]: https://github.com/daizutabi/mkdocs-nbsync/actions/workflows/ci.yaml/badge.svg?branch=main&event=push\n[GHAction-link]: https://github.com/daizutabi/mkdocs-nbsync/actions?query=event%3Apush+branch%3Amain\n[codecov-image]: https://codecov.io/github/daizutabi/mkdocs-nbsync/coverage.svg?branch=main\n[codecov-link]: https://codecov.io/github/daizutabi/mkdocs-nbsync?branch=main\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2025 Daizu Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "MkDocs plugin treating Jupyter notebooks, Python scripts and Markdown files as first-class citizens for documentation with dynamic execution and real-time synchronization",
"version": "0.1.5",
"project_urls": {
"Documentation": "https://daizutabi.github.io/mkdocs-nbsync/",
"Issues": "https://github.com/daizutabi/mkdocs-nbsync/issues",
"Source": "https://github.com/daizutabi/mkdocs-nbsync"
},
"split_keywords": [
"jupyter",
" notebook",
" mkdocs",
" documentation",
" markdown",
" python",
" visualization",
" dynamic-execution",
" real-time-sync"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ea93972380b6f3c8c53626c01228ddfc32ab586468def8bfab3fd84b526f7ac5",
"md5": "6e30eb924542a1173b4ba2c5885e35ca",
"sha256": "88cb2d4d4c5037719ccff01e4b36d14c9319738f08c2faac0531c9c40cd76dfe"
},
"downloads": -1,
"filename": "mkdocs_nbsync-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e30eb924542a1173b4ba2c5885e35ca",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 5760,
"upload_time": "2025-08-23T05:48:51",
"upload_time_iso_8601": "2025-08-23T05:48:51.284687Z",
"url": "https://files.pythonhosted.org/packages/ea/93/972380b6f3c8c53626c01228ddfc32ab586468def8bfab3fd84b526f7ac5/mkdocs_nbsync-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ef8d9388a208ff41238c2124d3a59f8eb68ab8284b88414a282969b4eae57e4b",
"md5": "f1d1b3e24c6e1444aa300b3f9e265c01",
"sha256": "0a01551fbbc7fafa2078ac77ce20add46175c35d1e661eb3f4fe81a656b14fb2"
},
"downloads": -1,
"filename": "mkdocs_nbsync-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "f1d1b3e24c6e1444aa300b3f9e265c01",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 5344,
"upload_time": "2025-08-23T05:48:52",
"upload_time_iso_8601": "2025-08-23T05:48:52.732483Z",
"url": "https://files.pythonhosted.org/packages/ef/8d/9388a208ff41238c2124d3a59f8eb68ab8284b88414a282969b4eae57e4b/mkdocs_nbsync-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-23 05:48:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "daizutabi",
"github_project": "mkdocs-nbsync",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-nbsync"
}
