Skip to content

Commit ea74296

Browse files
committed
Updated example command in docs/literate-notebook.ipynb
1 parent 2d5466e commit ea74296

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

docs/literate-notebook.ipynb

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
"cells": [
33
{
44
"cell_type": "markdown",
5+
"id": "91a9b093",
56
"metadata": {
6-
"dotnet_repl_cellExecutionStartTime": "2023-11-22T13:28:54.243692+00:00",
7-
"dotnet_repl_cellExecutionEndTime": "2023-11-22T13:28:54.2640212+00:00"
7+
"dotnet_repl_cellExecutionEndTime": "2023-11-22T13:28:54.2640212+00:00",
8+
"dotnet_repl_cellExecutionStartTime": "2023-11-22T13:28:54.243692+00:00"
89
},
910
"source": [
1011
"---\n",
@@ -20,22 +21,26 @@
2021
"\n",
2122
"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",
2223
"\n",
23-
"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",
24+
"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",
2425
"\n",
2526
"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"
2627
]
2728
},
2829
{
2930
"cell_type": "code",
3031
"execution_count": null,
32+
"id": "fdf16de9",
3133
"metadata": {
32-
"dotnet_repl_cellExecutionStartTime": "2023-11-22T13:28:54.265034+00:00",
33-
"dotnet_repl_cellExecutionEndTime": "2023-11-22T13:28:56.2484876+00:00",
3434
"dotnet_interactive": {
3535
"language": "fsharp"
3636
},
37+
"dotnet_repl_cellExecutionEndTime": "2023-11-22T13:28:56.2484876+00:00",
38+
"dotnet_repl_cellExecutionStartTime": "2023-11-22T13:28:54.265034+00:00",
3739
"polyglot_notebook": {
3840
"kernelName": "fsharp"
41+
},
42+
"vscode": {
43+
"languageId": "fsharp"
3944
}
4045
},
4146
"outputs": [
@@ -95,6 +100,14 @@
95100
}
96101
],
97102
"metadata": {
103+
"dotnet_interactive": {
104+
"defaultKernelName": "fsharp",
105+
"items": [
106+
{
107+
"name": "fsharp"
108+
}
109+
]
110+
},
98111
"kernelspec": {
99112
"display_name": ".NET (F#)",
100113
"language": "F#",
@@ -114,16 +127,8 @@
114127
"name": "fsharp"
115128
}
116129
]
117-
},
118-
"dotnet_interactive": {
119-
"defaultKernelName": "fsharp",
120-
"items": [
121-
{
122-
"name": "fsharp"
123-
}
124-
]
125130
}
126131
},
127132
"nbformat": 4,
128133
"nbformat_minor": 5
129-
}
134+
}

0 commit comments

Comments
 (0)