ipydrawio/docs/Diagram Document.ipynb

85 wiersze
2.5 KiB
Plaintext

{
"cells": [
{
"cell_type": "markdown",
"id": "eligible-lexington",
"metadata": {
"tags": []
},
"source": [
"# Diagram Document\n",
"\n",
"Using a `.dio` file directly in the _Diagram Document_ is much simpler than the [Diagram Widget](./Diagram%20Widget.ipynb) or [Diagram Rich Display](./Diagram%20Rich%20Display.ipynb). \n",
"\n",
"You can download these from [diagrams.net](https://diagrams.net), or one of their many integrations. You might also be able to use these documents in [documentation](https://pypi.org/project/sphinxcontrib-drawio/)."
]
},
{
"cell_type": "markdown",
"id": "heard-adolescent",
"metadata": {},
"source": [
"## Making a Diagram Document\n",
"From the _JupyterLab Launcher_:\n",
"- click _Diagram_ \n",
"- or _Custom Diagram..._\n",
" - and choose your _Theme_, _Format_ and _Template_"
]
},
{
"cell_type": "markdown",
"id": "collectible-breeding",
"metadata": {},
"source": [
"## Opening a Diagram Document\n",
"- Find a _Diagram_ file in the JupyterLab _File Browser_ <kbd>Ctrl+Shift+F</kbd>\n",
"- Double click it or drag-and-drop it to the main work area"
]
},
{
"cell_type": "markdown",
"id": "39f79606-eb20-4619-aebb-e975c7321e18",
"metadata": {},
"source": [
"### Other Formats\n",
"\n",
"Editable `drawio` XML can be embedded inside `.png` and `.svg` images and `.ipynb` notebooks. If they have a compound suffix, like `.dio.png`, `.dio.ipynb`, the _Diagram Editor_ will be opened by default.\n",
"- right click on the file in the _File Browser_\n",
"- select _Open With..._\n",
"- select one of the _Diagram_ options"
]
},
{
"cell_type": "markdown",
"id": "respected-plymouth",
"metadata": {},
"source": [
"## Configuration\n",
"\n",
"In the JupyterLab _Advanced Settings_ Panel <kbd>Ctrl+,</kbd>, the _Diagrams Documents_ section offers many, many options. See the [schema](./api/schema.rst) documentation for the most well-understood of options."
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.0"
}
},
"nbformat": 4,
"nbformat_minor": 5
}