From ea74296e404f18ee98838a70bef88c7a668add46 Mon Sep 17 00:00:00 2001 From: johnW_ret <19534013+johnW-ret@users.noreply.github.com> Date: Tue, 27 Feb 2024 17:56:28 -0600 Subject: [PATCH] Updated example command in docs/literate-notebook.ipynb --- docs/literate-notebook.ipynb | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/docs/literate-notebook.ipynb b/docs/literate-notebook.ipynb index 143a5a83a..683e457b2 100644 --- a/docs/literate-notebook.ipynb +++ b/docs/literate-notebook.ipynb @@ -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", @@ -20,7 +21,7 @@ "\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" ] @@ -28,14 +29,18 @@ { "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": [ @@ -95,6 +100,14 @@ } ], "metadata": { + "dotnet_interactive": { + "defaultKernelName": "fsharp", + "items": [ + { + "name": "fsharp" + } + ] + }, "kernelspec": { "display_name": ".NET (F#)", "language": "F#", @@ -114,16 +127,8 @@ "name": "fsharp" } ] - }, - "dotnet_interactive": { - "defaultKernelName": "fsharp", - "items": [ - { - "name": "fsharp" - } - ] } }, "nbformat": 4, "nbformat_minor": 5 -} \ No newline at end of file +}