Skip to content

Commit

Permalink
Reformat documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aeisenbarth committed Jun 28, 2024
1 parent 3327a3b commit 33a6cc8
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions docs/examples.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@
"\n",
"- `application/json`'s data is the original JSON, and it is left up to renderers how to represent it.\n",
"\n",
"## Comparison\n",
"\n",
"Jupyter Lab renders the following:\n",
"\n",
"![Screenshot of json_dict in Jupyter](./images/example1-jupyter.png)\n",
Expand All @@ -52,11 +54,17 @@
"\n",
"![Screenshot of json_dict in HTML by MyST-NB](./images/example1-myst-nb.png)\n",
"\n",
"With `myst-nb-json`, you should get an interactive rendering similar to Jupyter Lab:\n",
"With `myst-nb-json`, you will get an interactive rendering that looks similar to Jupyter Lab:\n",
"\n",
"![Screenshot of json_dict in HTML with myst-nb-json](./images/example1-myst-nb-json.png)"
]
},
{
"metadata": {},
"cell_type": "markdown",
"source": "## MyST-NB-JSON",
"id": "c2e1a4f04d4045f1"
},
{
"cell_type": "code",
"id": "23be0ec2f8ceb03a",
Expand All @@ -74,6 +82,8 @@
"id": "cde3f57f5dd64638",
"metadata": {},
"source": [
"## Expanded\n",
"\n",
"With the `expanded` parameter, you can control how much to show by default:"
]
},
Expand All @@ -92,6 +102,8 @@
"id": "32536237d491e70f",
"metadata": {},
"source": [
"## Root\n",
"\n",
"With the `root` parameter, you can control the display name:"
]
},
Expand All @@ -109,7 +121,11 @@
"cell_type": "markdown",
"id": "ed652ffb9714f6ae",
"metadata": {},
"source": "This is also nice for **Pydantic** models! By default, they are rendered as plain text:"
"source": [
"## Pydantic\n",
"\n",
"This is also nice for **Pydantic** models! By default, they are rendered as plain text:"
]
},
{
"cell_type": "code",
Expand Down

0 comments on commit 33a6cc8

Please sign in to comment.