Skip to content

Commit

Permalink
Updated example command in docs/literate-notebook.ipynb
Browse files Browse the repository at this point in the history
  • Loading branch information
johnW-ret committed Feb 27, 2024
1 parent 2d5466e commit ea74296
Showing 1 changed file with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions docs/literate-notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
"cells": [
{
"cell_type": "markdown",
"id": "91a9b093",
"metadata": {
"dotnet_repl_cellExecutionStartTime": "2023-11-22T13:28:54.243692+00:00",
"dotnet_repl_cellExecutionEndTime": "2023-11-22T13:28:54.2640212+00:00"
"dotnet_repl_cellExecutionEndTime": "2023-11-22T13:28:54.2640212+00:00",
"dotnet_repl_cellExecutionStartTime": "2023-11-22T13:28:54.243692+00:00"
},
"source": [
"---\n",
Expand All @@ -20,22 +21,26 @@
"\n",
"Content may be created using [.NET interactive](https://github.com/dotnet/interactive/tree/main) polyglot notebooks as the input file. Notebooks are processed by converting the notebook to a literate `.fsx` script and then passing the script through the script processing pipeline. Markdown notebook cells are passed through as comments surrounded by `(**` and `*)`, F# code cells are passed through as code, and non-F# code is passed through as markdown fenced code blocks between `(**` and `*)` comment markers. \n",
"\n",
"The `fsdocs` tool uses [dotnet-repl](https://github.com/jonsequitur/dotnet-repl) to evaluate polyglot notebooks. You need this tool to evaluate notebooks using `dotnet fsdocs --eval`. It can be installed into your local tool manifest using the command `dotnet tool install dotnet-repl`.\n",
"The `fsdocs` tool uses [dotnet-repl](https://github.com/jonsequitur/dotnet-repl) to evaluate polyglot notebooks. You need this tool to evaluate notebooks using `dotnet fsdocs [build|watch] --eval`. It can be installed into your local tool manifest using the command `dotnet tool install dotnet-repl`.\n",
"\n",
"F# Formatting tries to faithfully reproduce a notebook's native appearance when generating documents. Notebook cell outputs are passed through unchanged to preserve the notebook's html output. The below snippet demonstrates a notebook's html output for F# records, which differs from the output you would get with the same code inside a literate scripts.\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "fdf16de9",
"metadata": {
"dotnet_repl_cellExecutionStartTime": "2023-11-22T13:28:54.265034+00:00",
"dotnet_repl_cellExecutionEndTime": "2023-11-22T13:28:56.2484876+00:00",
"dotnet_interactive": {
"language": "fsharp"
},
"dotnet_repl_cellExecutionEndTime": "2023-11-22T13:28:56.2484876+00:00",
"dotnet_repl_cellExecutionStartTime": "2023-11-22T13:28:54.265034+00:00",
"polyglot_notebook": {
"kernelName": "fsharp"
},
"vscode": {
"languageId": "fsharp"
}
},
"outputs": [
Expand Down Expand Up @@ -95,6 +100,14 @@
}
],
"metadata": {
"dotnet_interactive": {
"defaultKernelName": "fsharp",
"items": [
{
"name": "fsharp"
}
]
},
"kernelspec": {
"display_name": ".NET (F#)",
"language": "F#",
Expand All @@ -114,16 +127,8 @@
"name": "fsharp"
}
]
},
"dotnet_interactive": {
"defaultKernelName": "fsharp",
"items": [
{
"name": "fsharp"
}
]
}
},
"nbformat": 4,
"nbformat_minor": 5
}
}

0 comments on commit ea74296

Please sign in to comment.