diff --git a/docs/literate-notebook.ipynb b/docs/literate-notebook.ipynb
index 2835d748b..8781b516b 100644
--- a/docs/literate-notebook.ipynb
+++ b/docs/literate-notebook.ipynb
@@ -2,9 +2,10 @@
"cells": [
{
"cell_type": "markdown",
+ "id": "9e399156",
"metadata": {
- "dotnet_repl_cellExecutionStartTime": "2023-11-17T21:04:27.922626+00:00",
- "dotnet_repl_cellExecutionEndTime": "2023-11-17T21:04:27.9559602+00:00"
+ "dotnet_repl_cellExecutionEndTime": "2023-11-22T12:20:24.6149643+00:00",
+ "dotnet_repl_cellExecutionStartTime": "2023-11-22T12:20:24.5700648+00:00"
},
"source": [
"---\n",
@@ -18,71 +19,31 @@
"\n",
"# Literate Notebooks\n",
"\n",
- "It is possible create content using [.NET interactive](https://github.com/dotnet/interactive/tree/main) polyglot notebooks as the input file. The notebooks are processed by converting the notebook to markdown and then passing the markdown through the markdown processing pipeline.\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",
"\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 literate scripts.\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": "4381f259",
"metadata": {
- "dotnet_repl_cellExecutionStartTime": "2023-11-17T21:04:27.9577608+00:00",
- "dotnet_repl_cellExecutionEndTime": "2023-11-17T21:04:30.3608545+00:00",
"dotnet_interactive": {
"language": "fsharp"
},
+ "dotnet_repl_cellExecutionEndTime": "2023-11-22T12:20:27.5439764+00:00",
+ "dotnet_repl_cellExecutionStartTime": "2023-11-22T12:20:24.6182652+00:00",
"polyglot_notebook": {
"kernelName": "fsharp"
+ },
+ "vscode": {
+ "languageId": "polyglot-notebook"
}
},
- "outputs": [
- {
- "data": {
- "text/html": [
- "{ Name = "Alf"\\n Phone = "(555) 555-5555"\\n ZipCode = "90210" }