From ac9376ae4fb4280decab7628705472782f88d2d0 Mon Sep 17 00:00:00 2001 From: nhirschey Date: Tue, 19 Mar 2024 14:06:01 +0000 Subject: [PATCH 1/2] Promote zero-to-hero to the first documentation page. --- docs/apidocs.fsx | 2 +- docs/commandline.md | 2 +- docs/content.fsx | 2 +- docs/evaluation.fsx | 2 +- docs/literate-notebook.ipynb | 50 +++--------------------------------- docs/literate.fsx | 2 +- docs/styling.md | 2 +- docs/users.md | 2 +- docs/zero-to-hero.md | 6 +++-- 9 files changed, 14 insertions(+), 56 deletions(-) diff --git a/docs/apidocs.fsx b/docs/apidocs.fsx index c2ea469d4..c974205a7 100644 --- a/docs/apidocs.fsx +++ b/docs/apidocs.fsx @@ -3,7 +3,7 @@ title: Generating API Docs category: Documentation categoryindex: 1 -index: 6 +index: 7 --- *) (*** condition: prepare ***) diff --git a/docs/commandline.md b/docs/commandline.md index 127a06dca..78e836426 100644 --- a/docs/commandline.md +++ b/docs/commandline.md @@ -1,7 +1,7 @@ --- category: Documentation categoryindex: 1 -index: 1 +index: 2 --- # Command line diff --git a/docs/content.fsx b/docs/content.fsx index 7ec8acd66..8b6b4ce58 100644 --- a/docs/content.fsx +++ b/docs/content.fsx @@ -2,7 +2,7 @@ --- category: Documentation categoryindex: 1 -index: 5 +index: 6 --- *) (*** condition: prepare ***) diff --git a/docs/evaluation.fsx b/docs/evaluation.fsx index 1fe4fbb5d..a1237bb3c 100644 --- a/docs/evaluation.fsx +++ b/docs/evaluation.fsx @@ -2,7 +2,7 @@ --- category: Documentation categoryindex: 1 -index: 7 +index: 8 --- *) (*** condition: prepare ***) diff --git a/docs/literate-notebook.ipynb b/docs/literate-notebook.ipynb index 683e457b2..456be1836 100644 --- a/docs/literate-notebook.ipynb +++ b/docs/literate-notebook.ipynb @@ -13,7 +13,7 @@ "\n", "categoryindex: 1\n", "\n", - "index: 4\n", + "index: 5\n", "\n", "---\n", "\n", @@ -40,54 +40,10 @@ "kernelName": "fsharp" }, "vscode": { - "languageId": "fsharp" + "languageId": "polyglot-notebook" } }, - "outputs": [ - { - "data": { - "text/html": [ - "
{ Name = "Alf"\\n Phone = "(555) 555-5555"\\n ZipCode = "90210" }
Name
"Alf"\r\n",
-       "
Phone
"(555) 555-5555"\r\n",
-       "
ZipCode
"90210"\r\n",
-       "
" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], + "outputs": [], "source": [ "type ContactCard =\n", " { Name: string\n", diff --git a/docs/literate.fsx b/docs/literate.fsx index ecbd7475e..ff42a0409 100644 --- a/docs/literate.fsx +++ b/docs/literate.fsx @@ -2,7 +2,7 @@ --- category: Documentation categoryindex: 1 -index: 3 +index: 4 --- *) (*** condition: prepare ***) diff --git a/docs/styling.md b/docs/styling.md index d76e1f0d3..845214dc4 100644 --- a/docs/styling.md +++ b/docs/styling.md @@ -1,7 +1,7 @@ --- category: Documentation categoryindex: 1 -index: 8 +index: 9 --- # Customization and Styling diff --git a/docs/users.md b/docs/users.md index 0185298e3..cdf8c5690 100644 --- a/docs/users.md +++ b/docs/users.md @@ -1,7 +1,7 @@ --- category: Documentation categoryindex: 1 -index: 9 +index: 10 --- # Users of FSharp.Formatting diff --git a/docs/zero-to-hero.md b/docs/zero-to-hero.md index aa58e9428..a9b2128b0 100644 --- a/docs/zero-to-hero.md +++ b/docs/zero-to-hero.md @@ -1,9 +1,11 @@ --- +title: Getting Started category: Documentation categoryindex: 1 -index: 10 +index: 1 --- -# From zero to hero: deploying to GitHub Pages +# Getting Started +## From zero to hero: deploying to GitHub Pages This guide is meant for a typical setup of open-source projects on GitHub. We start from a repository without any documentation and aim to end up with a published website on [GitHub Pages](https://pages.github.com/). From 2a5c614843e5a79fcece2b88969074c47ab89d9c Mon Sep 17 00:00:00 2001 From: nhirschey Date: Tue, 19 Mar 2024 14:11:07 +0000 Subject: [PATCH 2/2] re-save notebook output --- docs/literate-notebook.ipynb | 45 ++++++++++++++++++++++++++++++++++-- 1 file changed, 43 insertions(+), 2 deletions(-) diff --git a/docs/literate-notebook.ipynb b/docs/literate-notebook.ipynb index 456be1836..58f7eab6f 100644 --- a/docs/literate-notebook.ipynb +++ b/docs/literate-notebook.ipynb @@ -28,7 +28,7 @@ }, { "cell_type": "code", - "execution_count": null, + "execution_count": 1, "id": "fdf16de9", "metadata": { "dotnet_interactive": { @@ -43,7 +43,48 @@ "languageId": "polyglot-notebook" } }, - "outputs": [], + "outputs": [ + { + "data": { + "text/html": [ + "
{ Name = "Alf"\\n Phone = "(555) 555-5555"\\n ZipCode = "90210" }
Name
Alf
Phone
(555) 555-5555
ZipCode
90210
" + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], "source": [ "type ContactCard =\n", " { Name: string\n",